OpenPKG CVS Repository
  http://www.openpkg.org/cvsweb/cvsweb.cgi
  ____________________________________________________________________________

  Server: cvs.openpkg.org                  Name:   Michael Schloh
  Root:   /e/openpkg/cvs                   Email:  [EMAIL PROTECTED]
  Module: openpkg-doc                      Date:   09-Jul-2002 17:03:44
  Branch: HEAD                             Handle: 2002070916034300

  Modified files:
    openpkg-doc/handbook    openpkg.xml

  Log:
    Improved section software requirements with concrete prerequisites.

  Summary:
    Revision    Changes     Path
    1.44        +118 -65    openpkg-doc/handbook/openpkg.xml
  ____________________________________________________________________________

  Index: openpkg-doc/handbook/openpkg.xml
  ============================================================
  $ cvs diff -u -r1.43 -r1.44 openpkg.xml
  --- openpkg-doc/handbook/openpkg.xml  26 Mar 2002 14:10:42 -0000      1.43
  +++ openpkg-doc/handbook/openpkg.xml  9 Jul 2002 15:03:43 -0000       1.44
  @@ -1,7 +1,7 @@
   <?xml version='1.0' encoding='utf-8'?>
   <!DOCTYPE book 
     PUBLIC '-//OASIS//DTD DocBook XML V4.1.2//EN'
  -  '/sfw/share/sgml/docbook-dtd-xml/docbookx.dtd'>
  +  '/cw/share/sgml/docbook-dtd-xml/docbookx.dtd'>
     <!-- For DocBook see http://docbook.org/tdg/en/html/docbook.html -->
   
   <!-- ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: -->
  @@ -33,7 +33,7 @@
       </author>
     </authorgroup>
   
  -  <pubdate>March 2002</pubdate>
  +  <pubdate>July 2002</pubdate>
   
     <abstract>
       <para>
  @@ -160,11 +160,11 @@
         </para>
         <para>
           The Debian Project has delivered a software-packaging implementation
  -        called dpkg/apt. In the case of dpkg/apt, Debian provides desirable
  -        features by supplying tools that allow the building of an installation
  -        architecture. However, its support for multiple vendor files wrapped
  -        into one package is poor. The solution is also not as clean as
  -        desirable, as each package requires many separate files. This
  +        called dpkg/apt. In the case of dpkg/apt, Debian provides many
  +        desirable features by supplying tools that allow the building of an
  +        installation architecture. However, its support for multiple vendor
  +        files wrapped into one package is poor. The solution is also not as
  +        clean as desirable, as each package requires many separate files. This
           introduces unnecessary risks in copying complex file groups or
           otherwise organizing packages. Lastly, the interface between apt and
           dpkg is difficult to use, and does not adequately supply the
  @@ -258,7 +258,6 @@
           shell script, which runs and creates a self-contained hierarchy of
           directories and files for use by OpenPKG.
         </para>
  -        
         <para>
           The bootstrap script also establishes a sort of context or environment
           in which OpenPKG runs. Specifically, initial configuration involves
  @@ -277,7 +276,6 @@
           installation.
         </para>
       </sect1>
  -
     </chapter>
   
     <chapter>
  @@ -711,9 +709,9 @@
          <title>RPM Maintained</title>
          <itemizedlist>
            <listitem>
  -          <para>
  +          <simpara>
               $opkg_root/*
  -          </para>
  +          </simpara>
           </listitem>
         </itemizedlist>
         <para>
  @@ -730,9 +728,9 @@
         <title>Administrator Maintained</title>
         <itemizedlist>
           <listitem>
  -          <para>
  +          <simpara>
               $opkg_root/local
  -          </para>
  +          </simpara>
           </listitem>
         </itemizedlist>
         <para>
  @@ -757,37 +755,37 @@
         <title>The Run-Command Facility</title>
         <itemizedlist>
           <listitem>
  -          <para>
  +          <simpara>
               $opkg_root/etc/rc
  -          </para>
  +          </simpara>
           </listitem>
           <listitem>
  -          <para>
  +          <simpara>
               $opkg_root/etc/rc.conf
  -          </para>
  +          </simpara>
           </listitem>
         </itemizedlist>
         <itemizedlist>
           <listitem>
  -          <para>
  +          <simpara>
               %config and %common subdirectories
  -          </para>
  +          </simpara>
           </listitem>
           <listitem>
  -          <para>
  +          <simpara>
               provides start/stop option like cron RCs
  -          </para>
  +          </simpara>
           </listitem>
   <!--        <listitem>
  -          <para>
  +          <simpara>
               own for not touching system in every package
  -          </para>
  +          </simpara>
           </listitem>-->
           <listitem>
  -          <para>
  +          <simpara>
               has native meta-syntax derived from RPM for priorities and shorter
               writing
  -          </para>
  +          </simpara>
           </listitem>
         </itemizedlist>
         <para>
  @@ -868,24 +866,24 @@
         <title>Prerequisites</title>
         <itemizedlist>
           <listitem>
  -          <para>
  +          <simpara>
               FreeBSD 4.[1234], Debian GNU/Linux 2.2, Sun Solaris 2.[678]
  -          </para>
  +          </simpara>
           </listitem>
           <listitem>
  -          <para>
  +          <simpara>
               cc, make, ar, ld, as, nm, ... in $PATH
  -          </para>
  +          </simpara>
           </listitem>
           <listitem>
  -          <para>
  +          <simpara>
               diskspace X MB for /$opkg_root
  -          </para>
  +          </simpara>
           </listitem>
           <listitem>
  -          <para>
  +          <simpara>
               /dev/[u]random
  -          </para>
  +          </simpara>
           </listitem>
         </itemizedlist>
         <para>
  @@ -911,19 +909,74 @@
         </para>
       </sect1>
   
  -    <sect1 id='bstrap-depends'>
  -      <title>Dependencies</title>
  +    <sect1 id='bstrap-sfware'>
  +      <title>Software Requirements</title>
         <para>
           Internally the OpenPKG bootstrap package extends the functionality of
           several existing open-source technologies. In particular, it uses the
  -        vendor products Red Hat RPM 4.0.2, Berkeley-DB 3.2.9, ZLib 1.1.3, GNU
  -        Bzip2 1.0.1, GNU Gzip 1.3, GNU Tar 1.13.19, GNU Patch 2.5.4, GNU Make
  -        3.79.1, GNU Bash 2.05, and cURL 7.9. Be aware that you should have
  -        these tools installed before attempting an OpenPKG bootstrap operation,
  -        or OpenPKG may fail to properly install itself. A random number
  -        generator device is also required, which must reside in /dev/random
  -        and /dev/urandom.
  +        vendor products Red Hat RPM, Berkeley-DB, ZLib, GNU Bzip2, GNU Gzip,
  +        GNU Tar, GNU Patch, GNU Make, GNU Bash, and cURL. To circumvent
  +        potential dependency failures, OpenPKG includes these in every source
  +        or binary OpenPKG package. This means that a system not having these
  +        tools can bootstrap an OpenPKG instance just as easily as a complete
  +        system with the aforementioned toosl.
         </para>
  +      <para>
  +        There are also tools which OpenPKG doesn't bundle but requires
  +        nevertheless. Missing any of these important tools will either
  +        cause an OpenPKG installation to fail abruptly, or maybe more subtly. 
  +      <itemizedlist>
  +        <listitem>
  +          <simpara>
  +            uuencode
  +          </simpara>
  +        </listitem>
  +        <listitem>
  +          <simpara>
  +            uudecode
  +          </simpara>
  +        </listitem>
  +        <listitem>
  +          <simpara>
  +            sharutils
  +          </simpara>
  +        </listitem>
  +        <listitem>
  +          <simpara>
  +            compress
  +          </simpara>
  +        </listitem>
  +        <listitem>
  +          <simpara>
  +            uncompress
  +          </simpara>
  +        </listitem>
  +        <listitem>
  +          <simpara>
  +            /dev/random
  +          </simpara>
  +        </listitem>
  +        <listitem>
  +          <simpara>
  +            /dev/urandom
  +          </simpara>
  +        </listitem>
  +      </itemizedlist>
  +        A frequent cause of error involves one or more of such failing
  +        dependencies. If the installing engineer is not very vigilent in
  +        reading the hundreds of lines of scrolling OpenPKG installation text,
  +        an error of this type can go undiscovered. In many such cases, the
  +        engineer is misled and wastes time looking for the trouble source in
  +        the wrong place. If such problems arise, redirect the shell output
  +        when installing OpenPKG. Later examine the captured text files for
  +        missing dependency failures.
  +      </para>
  +      <para>
  +        There exist some exceptions to these requirements. Installation of
  +        OpenPKG on Debian Linux will fail unless GNU gettext and libpam0g-dev
  +        are installed. Also, to later build packages like jdk-sun, the library
  +        compat-libstdc++ must exist.
  +<!--FIXME: Describe RedHat, Solaris 9, and FreeBSD particular requirements-->
       </sect1>
   
       <sect1 id='bstrap-multi'>
  @@ -1013,7 +1066,7 @@
           script, by the way. While unnecessary to run as root, it does require
           the development tools cc(1), make(1), ar(1), ld(1), as(1), and nm(1).
           Have these installed along with the tools listed in <xref
  -        linkend='bstrap-depends'/> before initiating the bootstrap process.
  +        linkend='bstrap-sfware'/> before initiating the bootstrap process.
           Additionally, the $PATH system variable must reflect the location of
           these tools.
         </para>
  @@ -1363,29 +1416,29 @@
         </para>
         <itemizedlist>
           <listitem>
  -          <para>
  +          <simpara>
               --prefix=$opkg_root
  -          </para>
  +          </simpara>
           </listitem>
           <listitem>
  -          <para>
  +          <simpara>
               --user=$opkg_ugid
  -          </para>
  +          </simpara>
           </listitem>
           <listitem>
  -          <para>
  +          <simpara>
               --group=$opkg_ugid
  -          </para>
  +          </simpara>
           </listitem>
           <listitem>
  -          <para>
  +          <simpara>
               --verbose
  -          </para>
  +          </simpara>
           </listitem>
           <listitem>
  -          <para>
  +          <simpara>
               --help
  -          </para>
  +          </simpara>
           </listitem>
         </itemizedlist>
   
  @@ -1647,24 +1700,24 @@
         <title>Required RPM Features</title>
         <itemizedlist>
           <listitem>
  -          <para>
  +          <simpara>
               $RPM_BUILD_ROOT shell variable
  -          </para>
  +          </simpara>
           </listitem>
           <listitem>
  -          <para>
  +          <simpara>
               The rc.d run-command facility
  -          </para>
  +          </simpara>
           </listitem>
           <listitem>
  -          <para>
  +          <simpara>
               Dynamically generated %files
  -          </para>
  +          </simpara>
           </listitem>
           <listitem>
  -          <para>
  +          <simpara>
               OpenPKG Prerequisite
  -          </para>
  +          </simpara>
           </listitem>
         </itemizedlist>
         <para>
  @@ -1802,14 +1855,14 @@
         <title>Abandoned RPM Features</title>
         <itemizedlist>
           <listitem>
  -          <para>
  +          <simpara>
               %ChangeLog
  -          </para>
  +          </simpara>
           </listitem>
           <listitem>
  -          <para>
  +          <simpara>
               %doc
  -          </para>
  +          </simpara>
           </listitem>
         </itemizedlist>
         <para>
______________________________________________________________________
The OpenPKG Project                                    www.openpkg.org
CVS Repository Commit List                     [EMAIL PROTECTED]

Reply via email to