r1560 - in nALFS/hackers_guide/trunk: introduction/welcome part2/common part2/hacker preface

jwrober at linuxfromscratch.org jwrober at linuxfromscratch.org
Tue Oct 12 19:18:16 PDT 2004


Author: jwrober
Date: 2004-10-12 20:18:14 -0600 (Tue, 12 Oct 2004)
New Revision: 1560

Modified:
   nALFS/hackers_guide/trunk/introduction/welcome/welcome.xml
   nALFS/hackers_guide/trunk/part2/common/bugzilla.xml
   nALFS/hackers_guide/trunk/part2/hacker/distro_tarballs.xml
   nALFS/hackers_guide/trunk/part2/hacker/prereqs.xml
   nALFS/hackers_guide/trunk/preface/organization.xml
   nALFS/hackers_guide/trunk/preface/prerequisites.xml
Log:
update various pages

Modified: nALFS/hackers_guide/trunk/introduction/welcome/welcome.xml
===================================================================
--- nALFS/hackers_guide/trunk/introduction/welcome/welcome.xml	2004-10-13 00:39:55 UTC (rev 1559)
+++ nALFS/hackers_guide/trunk/introduction/welcome/welcome.xml	2004-10-13 02:18:14 UTC (rev 1560)
@@ -10,12 +10,11 @@
 
 <sect1>
 
-<para>Welcome to the &book-product; Hackers Guide.  This small book is
-designed to aid any person wishing to contribute to &book-product;. If you
-are not sure where to begin, take a look at the Contact Information page.
-This is the best place to see who is actively involved with the project and
-provides places to ask questions. If you know what you are after, then take
-a look at the section you are most interested in.</para>
+<para>Welcome to the &book-product; Hackers Guide.  This small book is designed to aid any
+person wishing to contribute to &book-product;. If you are not sure where to begin, take a
+look at the <xref linkend="intro-welcome-contactinfo"/> page.  This is the best place to see
+who is actively involved with the project and provides places to ask questions. If you know
+what you are after, then take a look at the section you are most interested in.</para>
 
 </sect1>
 

Modified: nALFS/hackers_guide/trunk/part2/common/bugzilla.xml
===================================================================
--- nALFS/hackers_guide/trunk/part2/common/bugzilla.xml	2004-10-13 00:39:55 UTC (rev 1559)
+++ nALFS/hackers_guide/trunk/part2/common/bugzilla.xml	2004-10-13 02:18:14 UTC (rev 1560)
@@ -9,41 +9,35 @@
 <title>Bugzilla</title>
 
 <para>The &book-product; package tracks all "<emphasis
-role="bold">bugs</emphasis>" in the LFS Bugzilla database. A
-"<emphasis role="bold">bug</emphasis>" is defined as an issue,
-todo or enhancement request tied to one of the ALFS products. The Bugzilla
-database can be accessed via the web at <ulink
-url="&bugzilla-root;">&bugzilla-root;</ulink>. The package is split across
-two Bugzilla products: "<emphasis role="bold">ALFS
-Profiles</emphasis>" and "<emphasis role="bold">Automated Linux
-From Scratch</emphasis>". The distinction between the two should be
-pretty clear.</para>
+role="bold">bugs</emphasis>" in the LFS Bugzilla database. A "<emphasis
+role="bold">bug</emphasis>" is defined as an issue, todo or enhancement request tied to
+one of the ALFS products. The Bugzilla database can be accessed via the web at <ulink
+url="&bugzilla-root;">&bugzilla-root;</ulink>. The package is split across two Bugzilla
+products: "<emphasis role="bold">ALFS Profiles</emphasis>" and "<emphasis
+role="bold">Automated Linux From Scratch</emphasis>". The distinction between the two
+should be pretty clear.</para>
 
-<para>The "<emphasis role="bold">Automated Linux From
-Scratch</emphasis>" product is then split up into five components:
-"<emphasis role="bold">Back End (XML)</emphasis>",
-"<emphasis role="bold">Doc</emphasis>s", "<emphasis
-role="bold">DTD</emphasis>", "<emphasis
-role="bold">Extras</emphasis>", and "<emphasis role="bold">Front
-End (GUI)</emphasis>". The "<emphasis role="bold">Back End
-(XML)</emphasis>" component is for all of the back end handlers that
-parse the XML and perform the work they ask for. The "<emphasis
-role="bold">Docs</emphasis>" component is to track all issues related
-to the three works (this book, the ALFS DTD Syntax Doc and the Users
-Guide). The "<emphasis role="bold">DTD</emphasis>" component is
-designed to take care of all issues around the main ALFS DTD and any other
-DTD's that the project uses. A good example would be the logging DTD.  The
-"<emphasis role="bold">Extras</emphasis>" component is for any
-add-ons or extras to the &book-product; package. The "<emphasis
-role="bold">Front End (GUI)</emphasis>" is designed to track any bugs
-for the <filename>ncurses</filename> GUI.</para>
+<para>The "<emphasis role="bold">Automated Linux From Scratch</emphasis>" product
+is then split up into five components: "<emphasis role="bold">Back End
+(XML)</emphasis>", "<emphasis role="bold">Doc</emphasis>s", "<emphasis
+role="bold">DTD</emphasis>", "<emphasis role="bold">Extras</emphasis>", and
+"<emphasis role="bold">Front End (GUI)</emphasis>". The "<emphasis
+role="bold">Back End (XML)</emphasis>" component is for all of the back end handlers
+that parse the XML and perform the work they ask for. The "<emphasis
+role="bold">Docs</emphasis>" component is to track all issues related to the three
+works (this book, the ALFS DTD Syntax Doc and the Users Guide). The "<emphasis
+role="bold">DTD</emphasis>" component is designed to take care of all issues around the
+main ALFS DTD and any other DTD's that the project uses. A good example would be the logging
+DTD.  The "<emphasis role="bold">Extras</emphasis>" component is for any add-ons
+or extras to the &book-product; package. The "<emphasis role="bold">Front End
+(GUI)</emphasis>" is designed to track any bugs for the <filename>ncurses</filename>
+GUI.</para>
 
-<para>If you find a bug in one of the products, first look in the Bugzilla
-database to see if you issue is there.  If not, then please read the <xref
-linkend="intro-welcome-contactinfo"/> page on how to contact the
-development team at the appropriate list. The team will decide if your
-issue is really a bug or just user error. If a bug is found, then you can
-or one of the development team will add the bug in the database for work on
-later.</para>
+<para>If you find a bug in one of the products, first look in the Bugzilla database to see
+if your issue is there.  If not, then please read the <xref
+linkend="intro-welcome-contactinfo"/> page on how to contact the development team at the
+appropriate mailing list. The team will decide if your issue is really a bug or just user
+error. If a bug is found, then you can (or one of the development team will) add the bug in
+the database for work on later.</para>
 
 </sect1>

Modified: nALFS/hackers_guide/trunk/part2/hacker/distro_tarballs.xml
===================================================================
--- nALFS/hackers_guide/trunk/part2/hacker/distro_tarballs.xml	2004-10-13 00:39:55 UTC (rev 1559)
+++ nALFS/hackers_guide/trunk/part2/hacker/distro_tarballs.xml	2004-10-13 02:18:14 UTC (rev 1560)
@@ -13,51 +13,71 @@
 
 <itemizedlist>
 
-<listitem><para>Check out a clean copy of the nALFS repository. Using an
-existing copy, especially one that has been configured and used as a build
-tree, can potentially cause errors in the <command>make dist</command> process.</para></listitem>
+<listitem><para>Check out a clean copy of nALFS from the SVN repository. Using an existing
+copy, especially one that has been configured and used as a build tree, can potentially
+cause errors in the <command>make dist</command> process.</para></listitem>
 
-<listitem><para>Edit <filename>bootstrap.configure</filename>, and modify
-the line starting with AC_INIT to reflect the version number that you want
-the distribution to be given (replace "CVS" with your desired
-version number). Do not commit this change to the CVS repository, as the
-CVS version should always report its version number as
-"CVS".</para></listitem>
+<listitem><para>Edit <filename>bootstrap.configure</filename>, and modify the line starting
+with AC_INIT to reflect the version number that you want the distribution to be given
+(replace "SVN" with your desired version number). Do not commit this change to the
+SVN repository, as the SVN version should always report its version number as
+"SVN".</para></listitem>
 
-<listitem><para>Run <command>sh ./bootstrap -d CVS -g CVS -p 5.0</command>.
-This command will create the configure script and Makefile (as is normally
-done with a CVS checkout), but will also download, extract and rename the
-documentation files that will be included in the tarball. These files
-include the DTD (the current CVS version), the syntax document describing
-the DTD, the user's guide and the hacker's guide. The latter three
-documents are currently downloaded from James Robertson's home directory on
-the LFS server, but see the URL_BASE variable in the bootstrap script to
-change the download source. In addition, the LFS-5.0 profile will be
-downloaded so it can be included in the tarball.</para></listitem>
+<listitem><para>Run <command>aclocal</command> to ensure that your
+<filename>aclocal.m4</filename> file is up to date.</para></listitem>
 
-<listitem><para>Run <command>./configure</command> specifying any
-parameters your system needs to complete the configuration
-process.</para></listitem>
+<listitem>
 
+<para>Run <command>sh ./bootstrap</command> with some parameters (to be explained).  This
+command will create the configure script and Makefile (as is normally done with a SVN
+checkout), but will also download, extract and rename the documentation files that will be
+included in the tarball. These files include the DTD, the syntax document describing the
+DTD, the user's guide and the hacker's guide. The latter three documents are currently
+downloaded from the ALFS/downloads ares on the LFS server.  See the URL_BASE variable in
+the bootstrap script to change the download source.</para>
+
+<para>The <command>bootstrap</command> shell script supports multiple parameters.  The
+<command>-d</command> parameter will download the version of the nALFS DTD specified.  To
+get the SVN trunk use <command>-d trunk</command>.  The <command>-s</command> parameter will
+download the version of the ALFS DTD Syntax Doc specified.  To get the SVN trunk use
+<command>-s SVN</command>.  To get a named version (e.g. v3.1) use <command>-s
+3.1</command>.  The <command>-u</command> and <command>-h</command> parameters will download
+the version of the nALFS User's Guide and Hacker's Guide respectively.  They work just like
+the <command>-s</command> parameter does.  The <command>-p</command> will download the
+version of the official LFS stable profile specified.  It works like the
+<command>-d</command> parameter.</para>
+
+<para>A good example for reference: <command>sh ./bootstrap -d trunk -s SVN -u SVN -h SVN -p
+5.1.1-5</command></para></listitem>
+
+</itemizedlist>
+
+<note><para>If you want to add more than one profile version to the distribution tarball,
+you can rerun <command>bootstrap</command> many times with just the <command>-p</command>
+parameter.</para></note>
+
+<itemizedlist>
+
+<listitem><para>Run <command>./configure</command> specifying any parameters your system
+needs to complete the configuration process.</para></listitem>
+
 <listitem><para>Run <command>make dist</command>. This will produce both a
-<filename>.tar.gz</filename> and a <filename>.tar.bz2</filename> file in
-the current directory containing everything that should be needed to build
-&book-product; on an end-user's system. Note that this tarball will be
-created using the <filename>autoconf</filename>,
-<filename>automake</filename> and <filename>libtool</filename> versions
-<emphasis>on your development system</emphasis>, so please make sure they
-are current releases before creating a tarball for public
+<filename>.tar.gz</filename> and a <filename>.tar.bz2</filename> file in the current
+directory containing everything that should be needed to build &book-product; on an
+end-user's system. Note that this tarball will be created using the
+<filename>autoconf</filename>, <filename>automake</filename> and
+<filename>libtool</filename> versions <emphasis>on your development system</emphasis>, so
+please make sure they are current releases before creating a tarball for public
 consumption.</para></listitem>
 
-<listitem><para>Run <command>make distcheck</command>. If your system
-requires any special parameters to be given to configure for it to complete
-(like <command>--with-libxml2</command>, for example), then you can use
-<command>make DISTCHECK_CONFIGURE_FLAGS="..." distcheck</command>
-to supply those parameters. The distcheck process will actually unpack the
-tarball into a temporary directory, and run a complete
-configure/make/install/uninstall process on it to ensure that no build
-errors occur. This step should be considered to be mandatory before
-releasing your tarball to the general public.</para></listitem>
+<listitem><para>Run <command>make distcheck</command>. If your system requires any special
+parameters to be given to configure for it to complete (like
+<command>--with-libxml2</command>, for example), then you can use <command>make
+DISTCHECK_CONFIGURE_FLAGS="..." distcheck</command> to supply those parameters.
+The distcheck process will actually unpack the tarball into a temporary directory, and run a
+complete configure/make/install/uninstall process on it to ensure that no build errors
+occur. This step should be considered to be mandatory before releasing your tarball to the
+general public.</para></listitem>
 
 </itemizedlist>
 

Modified: nALFS/hackers_guide/trunk/part2/hacker/prereqs.xml
===================================================================
--- nALFS/hackers_guide/trunk/part2/hacker/prereqs.xml	2004-10-13 00:39:55 UTC (rev 1559)
+++ nALFS/hackers_guide/trunk/part2/hacker/prereqs.xml	2004-10-13 02:18:14 UTC (rev 1560)
@@ -23,11 +23,9 @@
 
 <listitem><para>GNU libtool-1.5 or newer.</para></listitem>
 
-<listitem><para>GNU autoconf-2.57 or newer.</para></listitem>
-
 <listitem><para>GCC-3.3 or newer.</para></listitem>
 
-<listitem><para>CVS-1.11 or newer.</para></listitem>
+<listitem><para>SVN-1.0.5 or newer.</para></listitem>
 
 <listitem><para>OpenSSL-0.9.7c or newer.</para></listitem>
 

Modified: nALFS/hackers_guide/trunk/preface/organization.xml
===================================================================
--- nALFS/hackers_guide/trunk/preface/organization.xml	2004-10-13 00:39:55 UTC (rev 1559)
+++ nALFS/hackers_guide/trunk/preface/organization.xml	2004-10-13 02:18:14 UTC (rev 1560)
@@ -14,7 +14,7 @@
 <title>Part I &emdash; Introduction</title>
 
 <para>This part contains information which is essential to
-the rest of the book available at <xref linkend="introduction"/>
+the rest of the book available at <xref linkend="introduction"/>.
 </para>
 
 </sect2>

Modified: nALFS/hackers_guide/trunk/preface/prerequisites.xml
===================================================================
--- nALFS/hackers_guide/trunk/preface/prerequisites.xml	2004-10-13 00:39:55 UTC (rev 1559)
+++ nALFS/hackers_guide/trunk/preface/prerequisites.xml	2004-10-13 02:18:14 UTC (rev 1560)
@@ -8,8 +8,7 @@
 <?dbhtml filename="prerequisites.html" dir="preface"?>
 <title>Prerequisites</title>
 
-<para>There not that many true prerequisites to be able to hack on the
-consituent nALFS components. See the other sections for details on
-specific prerequisites.</para>
+<para>There not that many common prerequisites for all of the consituent nALFS components.
+It would be best to see the other sections for details on specific prerequisites.</para>
 
 </sect1>




More information about the alfs-log mailing list