OpenPKG Specs / file revision

   OpenPKG Framework Bootstrap Package, Source Tree

   ================================================

   This is the source tree for the OpenPKG Framework "bootstrap" package.

   What you find here is rather complex and tricky stuff, so don't be

   confused if you don't understand everything immediately.

   The Files

   ---------

   README .................. this file ;-)

   openpkg.spec ............ the regular build procedure

   openpkg.boot ............ the bootstrapping procedure

   patch-*.tar.gz .......... untouched distribution tarball of the GNU patch tool

   bash-*.tar.gz ........... untouched distribution tarball of the GNU bash tool

   make-*.tar.gz ........... untouched distribution tarball of the GNU make tool

   tar-*.tar.gz ............ untouched distribution tarball of the GNU tar tool

   config-*.tar.gz ......... untouched distribution tarball of the GNU config scripts

   gzip-*.tar .............. preunpacked distribution tarball of the GNU gzip tool

   gzip-*-openpkg-r*.tar ... prepatched distribution files of the GNU gzip tool

   perl-*-mini.tar.gz ...... stripped down distribution tarball of the Perl tool

   rpm-*.tar.gz ............ untouched distribution tarball of the RPM tool

   openssl-*.tar.gz ........ untouched distribution tarball of the OpenSSL toolkit

   uuid-*.tar.gz ........... untouched distribution tarball of the OSSP uuid tool

   curl-*.tar.gz ........... untouched distribution tarball of the cURL tool

   beecrypt-*.tar.gz ....... untouched distribution tarball of the BeeCrypt library

   bzip2-*.tar.gz .......... untouched distribution tarball of the BZIP2 library

   zlib-*.tar.gz ........... untouched distribution tarball of the ZLIB library

   popt-*.tar.gz ........... untouched distribution tarball of the POPT library

   sqlite-*.tar.gz ......... untouched distribution tarball of the SQLite library

   pcre-*.tar.gz ........... untouched distribution tarball of the SQLite library

   diffutils-*.tar.gz ...... untouched distribution tarball of the GNU diffutils toolkit

   svs-*.tar.gz ............ untouched distribution tarball of the OSSP svs tool

   xz-*.tar.gz ............. untouched distribution tarball of the XZ tool

   bash.patch .............. patch for GNU bash tool

   bash.patch.vendor ....... patch for GNU bash tool (upstream vendor only)

   bash.patch.vendor.sh .... patch for GNU bash tool (generation utility, NOT BUNDLED)

   beecrypt.patch .......... patch for BeeCrypt library

   make.patch .............. patch for GNU make tool

   openssl.patch ........... patch for OpenSSL toolkit

   perl.patch .............. patch for Perl tool

   tar.patch ............... patch for GNU tar tool

   rpm.patch ............... patch for RPM tool

   popt.patch .............. patch for POPT library

   sqlite.patch ............ patch for SQLite library

   curl.patch .............. patch for cURL library

   diffutils.patch ......... patch for GNU diffutils tool

   libarchive.patch ........ patch for BSD libarchive tool

   pcre.patch .............. patch for PCRE library

   xz.patch ................ patch for XZ tool

   rpmpopt ................. replacements/extensions for RPM's POPT configuration

   rpmmacros ............... replacements/extensions for RPM's macros

   root.README ............. the source for installed <prefix>/README

   local.README ............ the source for installed <prefix>/local/README

   dot.bashrc .............. the source for installed <prefix>/.bashrc

   dot.bash_login .......... the source for installed <prefix>/.bash_login

   dot.lsyncrc ............. the source for installed <prefix>/local/.lsyncrc

   openpkg.c ............... the OpenPKG frontend (setuid wrapper)

   openpkg.mk .............. the OpenPKG frontend (build procedure)

   openpkg.sh .............. the OpenPKG frontend (main script)

   openpkg.pod ............. the OpenPKG frontend manual page (source)

   openpkg.1 ............... the OpenPKG frontend manual page (pregenerated output)

   rc ...................... the OpenPKG runcommand handling script

   rc.func ................. the OpenPKG runcommand function definitions

   rc.conf ................. the OpenPKG runcommand configuration template

   rc.openpkg .............. the OpenPKG runcommand script for the bootstrap package

   rc.pod .................. the OpenPKG runcommand script manual page (source)

   rc.8 .................... the OpenPKG runcommand script manual page (pregenerated output)

   release.sh .............. the OpenPKG release information utility script

   release.pod ............. the OpenPKG release information utility manual page (source)

   release.8 ............... the OpenPKG release information utility manual page (pregenerated output)

   uuid.sh ................. the OpenPKG UUID management utility script

   uuid.pod ................ the OpenPKG UUID management utility manual page (source)

   uuid.8 .................. the OpenPKG UUID management utility manual page (pregenerated output)

   rpmdb ................... the OpenPKG RPM database management utility

   rpmtool ................. the rpmtool tool (program source)

   rpmtool.8 ............... the rpmtool tool (manual page)

   rpmtool.pod ............. the rpmtool tool (manual page source)

   shtool .................. the portable shell tool (GNU shtool)

   rpm-config.sh ........... the RPM C API helper script

   rpm-config.pod .......... the RPM C API helper manual page (source)

   rpm-config.8 ............ the RPM C API helper manual page (pregenerated output)

   lsync ................... the lsync tool (program source)

   lsync.8 ................. the lsync tool (manual page)

   lsync.pod ............... the lsync tool (manual page source)

   etc.usrgrp.sh ........... user/group name/id determination script

   etc.prereq.sh ........... prerequisite checking script

   etc.wrapsrc.sh .......... wrapper script for generating openpkg-V-R.src.sh

   etc.wrapbin.sh .......... wrapper script for generating openpkg-V-R.P-L.sh

   man.sh .................. helper script for "openpkg man" command

   rpm.sh .................. wrapper for RPM

   curl.sh ................. wrapper for cURL

   dev.pl .................. the OpenPKG package development utility script

   dev.pod ................. the OpenPKG package development utility manual page (source)

   dev.8 ................... the OpenPKG package development utility manual page (pregenerated output)

   index.pl ................ the OpenPKG package indexing utility script

   index.pod ............... the OpenPKG package indexing utility manual page (source)

   index.8 ................. the OpenPKG package indexing utility manual page (pregenerated output)

   search.pl ............... the OpenPKG package searching utility script

   search.pod .............. the OpenPKG package searching utility manual page (source)

   search.8 ................ the OpenPKG package searching utility manual page (pregenerated output)

   sea.sh .................. the OpenPKG shell execution archive utility script

   sea.pod ................. the OpenPKG shell execution archive utility manual page (source)

   sea.8 ................... the OpenPKG shell execution archive utility manual page (pregenerated output)

   mirror.pl ............... the OpenPKG package mirroing utility script

   mirror.pod .............. the OpenPKG package mirroing utility manual page (source)

   mirror.8 ................ the OpenPKG package mirroing utility manual page (pregenerated output)

   build.pl ................ the OpenPKG package building utility script

   build.pod ............... the OpenPKG package building utility manual page (source)

   build.8 ................. the OpenPKG package building utility manual page (pregenerated output)

   makeproxy.pl ............ the OpenPKG proxy package building utility script

   makeproxy.pod ........... the OpenPKG proxy package building utility manual page (source)

   makeproxy.8 ............. the OpenPKG proxy package building utility manual page (pregenerated output)

   openpkg.org.pgp ......... the OpenPGP public key "OpenPKG <openpkg@openpkg.org>"

   openpkg.com.pgp ......... the OpenPGP public key "OpenPKG GmbH <openpkg@openpkg.com>"

   openpkg.net.pgp ......... the OpenPGP public key "OpenPKG Foundation e.V. <openpkg@openpkg.net>"

   license.sh .............. the OpenPKG license management utility script

   license.pod ............. the OpenPKG license management utility manual page (source)

   license.8 ............... the OpenPKG license management utility manual page (pregenerated output)

   license-BOOT.txt ........ the OpenPKG Framework Bootstrapping License

   license-COMMUNITY.txt ... the OpenPKG Framework Community License

   license-EVAL.txt ........ the OpenPKG Framework Evaluation License

   license-EXAMPLE.txt ..... the OpenPKG Framework Example License

   license-PROMO.txt ....... the OpenPKG Framework Promotion License

   license-RECOVERY.txt .... the OpenPKG Framework Recovery License

   license.lua ............. the OpenPKG Framework license processor script

   Makefile ................ development build procedures

   The Bootstrapping Procedure

   ---------------------------

   The complexity of this OpenPKG RPM package results from the fact that

   we force us to treat this bootstrapping package equal to every other

   regular OpenPKG RPM package. First, this implies that the packaging

   tool RPM is packaged with itself as an OpenPKG RPM package -- which

   means that its build procedure is a real RPM .spec file and it can be

   installed and upgraded through a binary or source RPM. Second, RPM is

   installed into the same filesystem hierarchy as all other packages.

   Third, RPM manages its own files. The reason for this approach should

   be obvious: 100% consistency for the whole OpenPKG software packaging

   facility!

   The drawback is that this package requires a very tricky bootstrapping

   procedure which had cost a lot of time to figure out and establish. If

   you ever wanted to know the gory details, here they are...

   The first step was that we wrote the regular openpkg.spec file for

   building the bootstrap package with OpenPKG RPM under the assumption

   that OpenPKG RPM is already available. This way we can provide OpenPKG

   RPM as an RPM package. Just remains the problem how we actually

   bootstrap in case where OpenPKG RPM is still not available, i.e.,

   when we reach a new platform and have to build the package from

   scratch. Here the "openpkg.boot" script comes into play. It executes

   the "openpkg.spec" build procedure very similar to the way the real

   OpenPKG RPM would do ("openpkg rpm -bb"). That is, "openpkg.boot"

   partly emulates OpenPKG RPM -- just enough that "openpkg.spec" works.

   As a result, "openpkg.spec" cannot use any fancy OpenPKG RPM features

   or other things before "openpkg.boot" is able to emulate it, of

   course.

   After "openpkg.boot" executed the "%prep", "%build" and "%install"

   scripts of "openpkg.spec", there is a fresh version of the target

   filesystem hierarchy staying under a temporary "build root". The

   "openpkg.boot" script then creates a very special temporary "openpkg

   rpm" command which allows the installed "openpkg rpm" command

   inside the "build root" to work (although it is built for the

   final target filesystem path). Then the $OPENPKG_BOOT variable

   is set and the package is _again_ build via "openpkg.spec" --

   but this time with the real OpenPKG RPM. To avoid unneccessary

   recompilation, the "openpkg.spec" skips "%prep", "%build" and

   "%install" sections if $OPENPKG_BOOT is defined. So, on this second

   build phase, only the "%files" section is effectively executed, i.e.,

   a binary OpenPKG RPM package "openpkg-V-R.P-T.rpm" is rolled from the

   files in the "build root". Additionally, a source OpenPKG RPM package

   "openpkg-V-R.src.rpm" is rolled for consistency reasons, too.

   Finally, we override the installation in the "build root"

   again by installing the now rolled binary OpenPKG RPM package

   "openpkg-V-R.P-T.rpm" by using the real OpenPKG RPM. This way

   we achieve that OpenPKG RPM is remembered as a real OpenPKG RPM

   package in the RPM database. We just have to make sure the package

   is still relocated to the "build root" while installing. For this

   we could use "--prefix=$RPM_BUILD_ROOT%{l_prefix}", but this would

   create an incorrect file list for the package "openpkg" in the RPM

   database. Instead we use the tricky "--justdb" option for "openpkg

   rpm" which means "openpkg rpm" behaves as it would install into the

   real location, but does not actually install anything. But as a

   side effect, the database inside the "build root" is now correct.

   After this procedure, the "build root" contains the target filesystem

   hierarchy with OpenPKG RPM installed with itself. What is now just

   remaining is to roll a bootstrap package "openpkg" with this stuff for

   initial installation without OpenPKG RPM. For this the "build root"

   is packed into a "tarball", compressed, again wrapped into another

   tarball together with the uncompression tools ("bzip2" and "tar"),

   and finally wrapped into a self-extracting shell script by appending

   "etc.wrapbin.sh" (padded to 64KB for easier unpacking of the attached

   tarball) to its front.

   The result is the binary bootstrap script "openpkg-V-R.P-T.sh" which

   can be used to install the target hierarchy from scratch without

   any preinstalled OpenPKG RPM. Nevertheless, the installed target

   hierarchy looks _exactly_ as it would have been installed with OpenPKG

   RPM. If one later wants to upgrade this hierarchy one can just use the

   generated (or a newer) "openpkg-V-R.P-T.rpm".

   To allow one to easily repeat this from source bootstrapping procedure

   on other machines, one can run "./openpkg.boot -s" which rolls

   a "openpkg-V-R.src.sh" script which is a self-extracting script

   containing an attached tarball of the sources of this directory. This

   script contains the same contents like "openpkg-V-R.src.rpm", but

   is intended for running the described bootstrapping procedure from

   scratch without any OpenPKG RPM.