cvs commit: LFS/editor-manual/preface preface.xml

matthew at linuxfromscratch.org matthew at linuxfromscratch.org
Sun May 9 12:27:45 PDT 2004


matthew     04/05/09 13:27:45

  Modified:    editor-manual index.xml
               editor-manual/chapter01 chapter01.xml
               editor-manual/chapter02 anoncvs.xml chapter02.xml cvsssh.xml
                        introduction.xml
               editor-manual/chapter03 add.xml chapter03.xml checkout.xml
                        commit.xml delete.xml diff.xml introduction.xml
                        moving.xml update.xml
               editor-manual/chapter04 bugzilla.xml chapter04.xml
                        checkfiles.xml checkrender.xml commit.xml
                        introduction.xml test.xml updatechangelog.xml
                        updateindex.xml
               editor-manual/chapter05 addingcomments.xml assignbug.xml
                        chapter05.xml enternewbugs.xml fixbug.xml
                        introduction.xml
               editor-manual/chapter06 chapter06.xml introduction.xml
                        renderchecklinks.xml updatebook.xml
                        updatebugzilla.xml updateftp.xml
  Removed:     editor-manual/dedication dedicated.xml dedication.xml
               editor-manual/preface preface.xml
  Log:
  Migrated the editor's guide to newxml format.
  
  Revision  Changes    Path
  1.3       +18 -27    LFS/editor-manual/index.xml
  
  Index: index.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/index.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- index.xml	29 May 2002 12:19:21 -0000	1.2
  +++ index.xml	9 May 2004 19:27:44 -0000	1.3
  @@ -1,37 +1,28 @@
   <?xml version="1.0" encoding="ISO-8859-1"?>
  -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
  -                        "/usr/share/docbook/docbookx.dtd" [
  +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "general.ent">
  +  %general-entities;
  +]>
  +<book>
   
   
  -<!ENTITY book SYSTEM "book/book.xml">
  +<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="prologue/bookinfo.xml"/>
   
  -<!ENTITY version "20020528">
  -<!ENTITY releasedate "May 28th, 2002">
  +<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="prologue/dedication.xml"/>
   
  -<!ENTITY % bookinfo SYSTEM "entities/bookinfo.ent">
  -<!ENTITY % dedication SYSTEM "entities/dedication.ent">
  -<!ENTITY % preface SYSTEM "entities/preface.ent">
  -<!ENTITY % chapter01 SYSTEM "entities/chapter01.ent">
  -<!ENTITY % chapter02 SYSTEM "entities/chapter02.ent">
  -<!ENTITY % chapter03 SYSTEM "entities/chapter03.ent">
  -<!ENTITY % chapter04 SYSTEM "entities/chapter04.ent">
  -<!ENTITY % chapter05 SYSTEM "entities/chapter05.ent">
  -<!ENTITY % chapter06 SYSTEM "entities/chapter06.ent">
  -
  -%bookinfo;
  -%dedication;
  -%preface;
  -%chapter01;
  -%chapter02;
  -%chapter03;
  -%chapter04;
  -%chapter05;
  -%chapter06;
  +<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="prologue/preface.xml"/>
   
  -]>
  +<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="chapter01/chapter01.xml"/>
   
  -<book>
  +<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="chapter02/chapter02.xml"/>
  +
  +<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="chapter03/chapter03.xml"/>
  +
  +<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="chapter04/chapter04.xml"/>
  +
  +<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="chapter05/chapter05.xml"/>
   
  -&book;
  +<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="chapter06/chapter06.xml"/>
   
   </book>
  
  
  
  1.2       +7 -2      LFS/editor-manual/chapter01/chapter01.xml
  
  Index: chapter01.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter01/chapter01.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- chapter01.xml	28 May 2002 21:41:12 -0000	1.1
  +++ chapter01.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,3 +1,9 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <chapter id="chapter01">
   <title>LFS Development</title>
   <?dbhtml filename="chapter01.html" dir="chapter01"?>
  @@ -22,8 +28,7 @@
   <filename>book/book.xml</filename>. Continue in this way and you'll find
   your way around the book soon enough.</para>
   
  -<para>The Bugzilla bug-tracking system for LFS can be found at <ulink
  -url="http://bugs.linuxfromscratch.org"/>. In order to be able to
  +<para>The Bugzilla bug-tracking system for LFS can be found at <ulink url="http://bugs.linuxfromscratch.org"/>. In order to be able to
   add, remove and edit bugs, you need to add an account and make sure you
   are logged in whenever you wish to perform such an action.  You can
   query and read the bug database without logging in or creating a user.
  
  
  
  1.2       +6 -1      LFS/editor-manual/chapter02/anoncvs.xml
  
  Index: anoncvs.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter02/anoncvs.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- anoncvs.xml	28 May 2002 21:41:12 -0000	1.1
  +++ anoncvs.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,3 +1,9 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch02-anoncvs">
   <title>Anonymous Access</title>
   <?dbhtml filename="anoncvs.html" dir="chapter02"?>
  @@ -17,4 +23,3 @@
   <screen><userinput>cvs update</userinput></screen></para>
   
   </sect1>
  -
  
  
  
  1.2       +12 -5     LFS/editor-manual/chapter02/chapter02.xml
  
  Index: chapter02.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter02/chapter02.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- chapter02.xml	28 May 2002 21:41:12 -0000	1.1
  +++ chapter02.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,9 +1,16 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <chapter id="chapter02">
  -<title>CVS Access</title>
  -<?dbhtml filename="chapter02.html" dir="chapter02"?>
  +  <title>CVS Access</title>
  +  <?dbhtml filename="chapter02.html" dir="chapter02"?>
   
  -&c2-introduction;
  -&c2-anoncvs;
  -&c2-cvsssh;
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="introduction.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="anoncvs.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="cvsssh.xml"/>
   
   </chapter>
  +
  
  
  
  1.2       +6 -1      LFS/editor-manual/chapter02/cvsssh.xml
  
  Index: cvsssh.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter02/cvsssh.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- cvsssh.xml	28 May 2002 21:41:12 -0000	1.1
  +++ cvsssh.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,3 +1,9 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch02-cvsssh">
   <title>CVS SSH Access (for editors)</title>
   <?dbhtml filename="cvsssh.html" dir="chapter02"?>
  @@ -45,4 +51,3 @@
   <para><screen><userinput>cvs update</userinput></screen></para>
   
   </sect1>
  -
  
  
  
  1.2       +6 -0      LFS/editor-manual/chapter02/introduction.xml
  
  Index: introduction.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter02/introduction.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- introduction.xml	28 May 2002 21:41:12 -0000	1.1
  +++ introduction.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,3 +1,9 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch02-introduction">
   <title>Introduction</title>
   <?dbhtml filename="introduction.html" dir="chapter02"?>
  
  
  
  1.2       +13 -7     LFS/editor-manual/chapter03/add.xml
  
  Index: add.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter03/add.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- add.xml	28 May 2002 21:41:12 -0000	1.1
  +++ add.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,10 +1,16 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch03-add">
  -<title>cvs add</title>
  -<?dbhtml filename="add.html" dir="chapter03"?>
  -
  -<para><userinput>cvs add</userinput>. When you created a new file,
  -you need to tell the CVS server about it. Note that the file won't appear in
  -the repository on shadowfax until you do a <userinput>cvs commit</userinput>
  -(see below).</para>
  +  <title>cvs add</title>
  +  <?dbhtml filename="add.html" dir="chapter03"?>
   
  +  <para><userinput>cvs add</userinput>. When you created a new file, you need to
  +    tell the CVS server about it. Note that the file won't appear in the
  +    repository on shadowfax until you do a <userinput>cvs commit</userinput>
  +    (see below).
  +  </para>
   </sect1>
  
  
  
  1.2       +16 -10    LFS/editor-manual/chapter03/chapter03.xml
  
  Index: chapter03.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter03/chapter03.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- chapter03.xml	28 May 2002 21:41:12 -0000	1.1
  +++ chapter03.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,14 +1,20 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <chapter id="chapter03">
  -<title>Basic CVS Commands</title>
  -<?dbhtml filename="chapter03.html" dir="chapter03"?>
  +  <title>Basic CVS Commands</title>
  +  <?dbhtml filename="chapter03.html" dir="chapter03"?>
   
  -&c3-introduction;
  -&c3-checkout;
  -&c3-add;
  -&c3-delete;
  -&c3-update;
  -&c3-commit;
  -&c3-diff;
  -&c3-moving;
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="introduction.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="checkout.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="add.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="delete.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="update.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="commit.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="diff.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="moving.xml"/>
   
   </chapter>
  
  
  
  1.2       +18 -13    LFS/editor-manual/chapter03/checkout.xml
  
  Index: checkout.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter03/checkout.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- checkout.xml	28 May 2002 21:41:12 -0000	1.1
  +++ checkout.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,16 +1,21 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch03-checkout">
  -<title>cvs checkout/co</title>
  -<?dbhtml filename="checkout.html" dir="chapter03"?>
  -
  -<para><userinput>cvs checkout</userinput> or <userinput>cvs
  -co</userinput>. This command is used to pull a CVS tree such as
  -<filename>LFS/BOOK</filename> (the LFS book) or
  -<filename>BLFS</filename> (the BLFS book) from the server.  You
  -should only need to do this once. If we mess around with the directory
  -structure (as sometimes is necessary), you may occasionally need to
  -delete your local sandbox and re-check it out. If this is going to be
  -needed, it will usually be because the Editor will have made a
  -<emphasis>large</emphasis> change and it'll be announced at least on the
  -<filename>lfs-book</filename> list.</para>
  +  <title>cvs checkout/co</title>
  +  <?dbhtml filename="checkout.html" dir="chapter03"?>
   
  +  <para><userinput>cvs checkout</userinput> or <userinput>cvs co</userinput>.
  +    This command is used to pull a CVS tree such as
  +    <filename>LFS/BOOK</filename> (the LFS book) or <filename>BLFS</filename>
  +    (the BLFS book) from the server.  You should only need to do this once. If
  +    we mess around with the directory structure (as sometimes is necessary),
  +    you may occasionally need to delete your local sandbox and re-check it out.
  +    If this is going to be needed, it will usually be because the Editor will
  +    have made a <emphasis>large</emphasis> change and it'll be announced at
  +    least on the <filename>lfs-book</filename> list.
  +  </para>
   </sect1>
  
  
  
  1.2       +16 -10    LFS/editor-manual/chapter03/commit.xml
  
  Index: commit.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter03/commit.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- commit.xml	28 May 2002 21:41:12 -0000	1.1
  +++ commit.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,13 +1,19 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch03-commit">
  -<title>cvs commit/ci</title>
  -<?dbhtml filename="commit.html" dir="chapter03"?>
  -
  -<para><userinput>cvs commit</userinput> or <userinput>cvs ci</userinput>.
  -This command recursively sends your changes to the CVS server. It will
  -commit changed files, added files and deleted files. The -m option can be
  -used to pass a log message to the command. If you don't specify a
  -<emphasis>-m "MESSAGE"</emphasis>, then it will open the default editor and
  -ask you to type in a log. Please don't use empty log messages (see later in
  -this document on the policy which governs them).</para>
  +  <title>cvs commit/ci</title>
  +  <?dbhtml filename="commit.html" dir="chapter03"?>
   
  +  <para><userinput>cvs commit</userinput> or <userinput>cvs ci</userinput>. This
  +    command recursively sends your changes to the CVS server. It will commit
  +    changed files, added files and deleted files. The -m option can be used to
  +    pass a log message to the command. If you don't specify a
  +    <emphasis>-m "MESSAGE"</emphasis>, then it will open the default editor and
  +    ask you to type in a log. Please don't use empty log messages (see later in
  +    this document on the policy which governs them).
  +  </para>
   </sect1>
  
  
  
  1.2       +13 -8     LFS/editor-manual/chapter03/delete.xml
  
  Index: delete.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter03/delete.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- delete.xml	28 May 2002 21:41:12 -0000	1.1
  +++ delete.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,11 +1,16 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch03-delete">
  -<title>cvs delete/remove</title>
  -<?dbhtml filename="delete.html" dir="chapter03"?>
  -
  -<para><userinput>cvs delete</userinput> or <userinput>cvs
  -remove</userinput>. This does what it says: remove (a) file(s) from the
  -repository on shadowfax. Note that you have to have deleted the file
  -locally before you can run this. Again, the file will not be deleted from
  -the server until you do a <userinput>cvs commit</userinput>.</para>
  +  <title>cvs delete/remove</title>
  +  <?dbhtml filename="delete.html" dir="chapter03"?>
   
  +  <para><userinput>cvs delete</userinput> or <userinput>cvs remove</userinput>.
  +    This does what it says: remove (a) file(s) from the repository on shadowfax.
  +    Note that you have to have deleted the file locally before you can run this.    Again, the file will not be deleted from the server until you do a
  +    <userinput>cvs commit</userinput>.
  +  </para>
   </sect1>
  
  
  
  1.2       +43 -34    LFS/editor-manual/chapter03/diff.xml
  
  Index: diff.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter03/diff.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- diff.xml	28 May 2002 21:41:12 -0000	1.1
  +++ diff.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,37 +1,46 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch03-diff">
  -<title>cvs diff</title>
  -<?dbhtml filename="diff.html" dir="chapter03"?>
  -
  -<para><userinput>cvs diff</userinput>. This is useful for three different
  -purposes.</para>
  -
  -<para>Firstly, those without write access to the LFS CVS server can use it
  -to generate patches to send to <userinput>lfs-dev</userinput>. To do this,
  -simply edit the files in your local sandbox then run
  -<userinput>cvs diff -u > FILE.patch</userinput> from the root of your
  -LFS directory. You can then attach this file to a message to the
  -<userinput>lfs-dev</userinput> list where someone with editing rights will
  -pick it up and apply it to the book.</para>
  -
  -<para>The second use is to find out what has changed between two revisions
  -of a file by running:</para>
  -
  -<para><screen><userinput>cvs diff -u -r revision1 -r revision2 FILENAME</userinput></screen></para>
  -
  -<para>For example:
  -<userinput>cvs diff -u -r 1.68 -r 1.69 index.xml</userinput> will output a
  -unified diff showing the changes between revisions 1.68 and 1.69 of
  -<filename>index.xml</filename>.</para>
  -
  -<para>Remember that when using cvs diff, you nearly
  -<emphasis>always</emphasis> want to output a unified diff and so either
  -use the <userinput>-u</userinput> switch or add it to your
  -<filename>~/.cvsrc</filename> file.</para>
  -
  -<para>A third use it to recursive request all the changes between your
  -local copy and the copy on the CVS server. This is handy to do before
  -running <userinput>cvs update</userinput> to see what exactly has changed
  -since the last time you ran the update command.</para>
  +  <title>cvs diff</title>
  +  <?dbhtml filename="diff.html" dir="chapter03"?>
   
  +  <para><userinput>cvs diff</userinput>. This is useful for three different
  +    purposes.
  +  </para>
  +
  +  <para>Firstly, those without write access to the LFS CVS server can use it to
  +    generate patches to send to <userinput>lfs-dev</userinput>. To do this,
  +    simply edit the files in your local sandbox then run
  +    <userinput>cvs diff -u > FILE.patch</userinput> from the root of your LFS
  +    directory. You can then attach this file to a message to the
  +    <userinput>lfs-dev</userinput> list where someone with editing rights will
  +    pick it up and apply it to the book.
  +  </para>
  +
  +  <para>The second use is to find out what has changed between two revisions of
  +    a file by running:
  +  </para>
  +
  +  <para><screen><userinput>cvs diff -u -r revision1 -r revision2 FILENAME</userinput></screen></para>
  +
  +  <para>For example: <userinput>cvs diff -u -r 1.68 -r 1.69 index.xml</userinput>
  +    will output a unified diff showing the changes between revisions 1.68 and
  +    1.69 of <filename>index.xml</filename>.
  +  </para>
  +
  +  <para>Remember that when using cvs diff, you nearly
  +    <emphasis>always</emphasis> want to output a unified diff and so either use
  +    the <userinput>-u</userinput> switch or add it to your
  +    <filename>~/.cvsrc</filename> file.
  +  </para>
  +
  +  <para>A third use it to recursive request all the changes between your local
  +    copy and the copy on the CVS server. This is handy to do before running
  +    <userinput>cvs update</userinput> to see what exactly has changed since the
  +    last time you ran the update command.
  +  </para>
   </sect1>
  -
  
  
  
  1.2       +18 -11    LFS/editor-manual/chapter03/introduction.xml
  
  Index: introduction.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter03/introduction.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- introduction.xml	28 May 2002 21:41:12 -0000	1.1
  +++ introduction.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,15 +1,22 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch03-introduction">
  -<title>Introduction</title>
  -<?dbhtml filename="introduction.html" dir="chapter03"?>
  +  <title>Introduction</title>
  +  <?dbhtml filename="introduction.html" dir="chapter03"?>
   
  -<para>The man and info pages of CVS are fairly good, but let's list a basic
  -set of commands which all editors will use on an almost daily basis. There
  -are many more options available than the ones listed here, so you will want
  -to read the CVS documentation at some point, and run the
  -<userinput>cvs --help</userinput> command. You can also get a basic list
  -of CVS commands by running <userinput>cvs --help-commands</userinput></para>
  -
  -<para>Some commands have two forms, the long and the short. We'll
  -list both in the descriptions.</para>
  +  <para>The man and info pages of CVS are fairly good, but let's list a basic
  +    set of commands which all editors will use on an almost daily basis. There
  +    are many more options available than the ones listed here, so you will want
  +    to read the CVS documentation at some point, and run the <userinput>cvs
  +    --help</userinput> command. You can also get a basic list of CVS commands by
  +    running <userinput>cvs --help-commands</userinput>
  +  </para>
   
  +  <para>Some commands have two forms, the long and the short. We'll list both in
  +    the descriptions.
  +  </para>
   </sect1>
  
  
  
  1.2       +17 -11    LFS/editor-manual/chapter03/moving.xml
  
  Index: moving.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter03/moving.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- moving.xml	28 May 2002 21:41:12 -0000	1.1
  +++ moving.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,14 +1,20 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch03-moving">
  -<title>Moving files</title>
  -<?dbhtml filename="moving.html" dir="chapter03"?>
  -
  -<para>Moving files: One of the (many) complaints against cvs is that
  -it has no concept of 1) moving files or 2) versioning directories.  If
  -you need to move a file, it's generally better to do it on the server
  -manually. The alternative is remove a file using <userinput>cvs
  -delete</userinput> then add the new version in the new place with
  -<userinput>cvs add</userinput> The downside using this method is that you
  -will lose the revision history for that file. However, moving it on the
  -server itself won't cause a loss of revision history.</para>
  +  <title>Moving files</title>
  +  <?dbhtml filename="moving.html" dir="chapter03"?>
   
  +  <para>Moving files: One of the (many) complaints against cvs is that it has no
  +    concept of 1) moving files or 2) versioning directories.  If you need to
  +    move a file, it's generally better to do it on the server manually. The
  +    alternative is remove a file using <userinput>cvs delete</userinput> then
  +    add the new version in the new place with <userinput>cvs add</userinput>.
  +    The downside using this method is that you will lose the revision history
  +    for that file. However, moving it on the server itself won't cause a loss of
  +    revision history.
  +  </para>
   </sect1>
  
  
  
  1.2       +18 -13    LFS/editor-manual/chapter03/update.xml
  
  Index: update.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter03/update.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- update.xml	28 May 2002 21:41:12 -0000	1.1
  +++ update.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,16 +1,21 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch03-update">
  -<title>cvs update/up</title>
  -<?dbhtml filename="update.html" dir="chapter04"?>
  -
  -<para><userinput>cvs update</userinput> or <userinput>cvs
  -up</userinput>. This command syncs your local sandbox with the server and
  -is probably, along with <userinput>cvs commit</userinput> the command you
  -will use most frequently. If you have made local changes, it'll try and merge
  -any changes on the server with your changes
  -<emphasis>on your machine</emphasis>. You should always do a manual
  -<userinput>cvs update</userinput> before trying to commit changes in order
  -to check that everything is alright and ready to go (although when you do a
  -<userinput>cvs commit</userinput>, it will warn you if there is a
  -problem).</para>
  +  <title>cvs update/up</title>
  +  <?dbhtml filename="update.html" dir="chapter04"?>
   
  +  <para><userinput>cvs update</userinput> or <userinput>cvs up</userinput>.
  +    This command syncs your local sandbox with the server and is probably, along
  +    with <userinput>cvs commit</userinput> the command you will use most
  +    frequently. If you have made local changes, it'll try and merge any changes
  +    on the server with your changes <emphasis>on your machine</emphasis>. You
  +    should always do a manual <userinput>cvs update</userinput> before trying to
  +    commit changes in order to check that everything is alright and ready to go
  +    (although when you do a <userinput>cvs commit</userinput>, it will warn you
  +    if there is a problem).
  +  </para>
   </sect1>
  
  
  
  1.2       +20 -13    LFS/editor-manual/chapter04/bugzilla.xml
  
  Index: bugzilla.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter04/bugzilla.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- bugzilla.xml	28 May 2002 21:41:12 -0000	1.1
  +++ bugzilla.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,19 +1,26 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch04-bugzilla">
  -<title>Update bugzilla</title>
  -<?dbhtml filename="bugzilla.html" dir="chapter04"?>
  +  <title>Update bugzilla</title>
  +  <?dbhtml filename="bugzilla.html" dir="chapter04"?>
   
  -<para>The final part of updating the book is to update bugzilla. This is
  -usually as easy as going to LFS Bugzilla (<ulink
  -url="http://bugs.linuxfromscratch.org"/>), going to the bug and
  -choosing Resolve bug, changing resolution to FIXED.  Note that you
  -should <emphasis>not</emphasis> then go back and CLOSE the bug.  The
  -person who closes the bug should be a different editor who has tested
  -that what the bug is about has been fixed. Basically, it's our QA
  -process.</para>
  +  <para>The final part of updating the book is to update bugzilla. This is
  +    usually as easy as going to LFS Bugzilla (<ulink
  +    url="http://bugs.linuxfromscratch.org"/>), going to the bug and choosing
  +    Resolve bug, changing resolution to FIXED.  Note that you should
  +    <emphasis>not</emphasis> then go back and CLOSE the bug.  The person who
  +    closes the bug should be a different editor who has tested that what the bug
  +    is about has been fixed. Basically, it's our QA process.
  +  </para>
   
  -<para>A more detailed explanation on how to use Bugzilla can be found
  -later. This is just the check-list (ie: don't forget to finish off with
  -Bugzilla assuming you already know how to use it).</para>
  +  <para>A more detailed explanation on how to use Bugzilla can be found later.
  +    This is just the check-list (ie: don't forget to finish off with Bugzilla
  +    assuming you already know how to use it).
  +  </para>
   
   </sect1>
   
  
  
  
  1.2       +15 -12    LFS/editor-manual/chapter04/chapter04.xml
  
  Index: chapter04.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter04/chapter04.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- chapter04.xml	28 May 2002 21:41:12 -0000	1.1
  +++ chapter04.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,15 +1,18 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <chapter id="chapter04">
  -<title>Committing Changes - Policy</title>
  -<?dbhtml filename="chapter04.html" dir="chapter04"?>
  -
  -&c4-introduction;
  -&c4-test;
  -&c4-updateindex;
  -&c4-updatechangelog;
  -&c4-checkfiles;
  -&c4-checkrender;
  -&c4-commit;
  -&c4-bugzilla;
  -
  +  <title>Committing Changes - Policy</title>
  +  <?dbhtml filename="chapter04.html" dir="chapter04"?>
  + <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="introduction.xml"/>
  + <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="test.xml"/>
  + <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="updateindex.xml"/>
  + <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="updatechangelog.xml"/>
  + <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="checkfiles.xml"/>
  + <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="commit.xml"/>
  + <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="bugzilla.xml"/>
   </chapter>
   
  
  
  
  1.2       +74 -61    LFS/editor-manual/chapter04/checkfiles.xml
  
  Index: checkfiles.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter04/checkfiles.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- checkfiles.xml	28 May 2002 21:41:12 -0000	1.1
  +++ checkfiles.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,15 +1,21 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch04-checkfiles">
  -<title>Check all relevant files have been added and removed</title>
  -<?dbhtml filename="checkfiles.html" dir="chapter04"?>
  +  <title>Check all relevant files have been added and removed</title>
  +  <?dbhtml filename="checkfiles.html" dir="chapter04"?>
   
  -<para>If you are adding files, you need to run a
  -<userinput>cvs add</userinput> command on each of them (something like
  -<userinput>cvs add chapter06/kernel*.xml</userinput> will work).  A good
  -trick if you've only added files (not taken any away) is to run a
  -<userinput>cvs up</userinput> which will give an output something like 
  -this:</para>
  +  <para>If you are adding files, you need to run a
  +    <userinput>cvs add</userinput> command on each of them (something like
  +    <userinput>cvs add chapter06/kernel*.xml</userinput> will work).  A good
  +    trick if you've only added files (not taken any away) is to run a
  +    <userinput>cvs up</userinput> which will give an output something like this:
  +  </para>
   
  -<para><screen>gerard:~/lfs-book$ cvs up
  +  <para><screen>gerard:~/lfs-book$ cvs up
   ? temp/thisfileneedstobeadded
   cvs server: Updating .
   cvs server: Updating appendixa
  @@ -32,58 +38,65 @@
   Merging differences between 1.1 and 1.2 into
   thisfilehashadchangesmergedin
   M temp/thisfilehashadchangesmergedin
  -cvs server: Updating template</screen></para>
  +cvs server: Updating template</screen>
  +  </para>
   
  -<para>([snip]'s were added by me, not the server). If you look at the first
  -column, you will see various different letters which all mean different
  -things.</para>
  -
  -<para><userinput>?</userinput>: This is what CVS reports when it doesn't
  -know what to do with a file.  Generally it means that you've forgotten
  -to <userinput>cvs add</userinput> a file to the repository but can also
  -just be temporary editor files which CVS doesn't know what to do with.
  -If it's just temporary files, don't worry, it won't try and commit them
  -when you do a <userinput>cvs ci</userinput> because you haven't added
  -them. Instead it'll just leave them alone.</para>
  -
  -<para><userinput>A</userinput>: This is a file which has been added to
  -CVS using <userinput>cvs add</userinput> but has not yet been committed.
  -When you're ready to commit it, simply do a
  -<userinput>cvs ci</userinput> on it (and don't forget that nearly all cvs
  -operations can be performed on as many files at once as you like; indeed,
  -if you specify no file, it'll either give you an error (if it doesn't make
  -sense; like with <userinput>cvs add</userinput> or
  -<userinput>delete</userinput>) or simply perform the action on all files
  -from that directory downwards in the tree; for example with
  -<userinput>cvs ci</userinput>).</para>
  -
  -<para><userinput>R</userinput>: This is a file which has been removed
  -from CVS using <userinput>cvs delete</userinput> but has not yet been
  -committed. The equivalent of 'A' for added files.</para>
  -
  -<para><userinput>M</userinput>: This is a file which has been modified
  -in your local repository and hasn't been checked in. If there have also
  -been changes in the remote copy, it means that CVS successfully merged
  -them. Even so, if (as in the file thisfilehashadchangesmergedin above)
  -changes have been automatically merged, you should look them over to
  -check that they make sense. Then, when you're ready, commit.</para>
  -
  -<para><userinput>U</userinput>: This is a file which was unchanged
  -locally but changed remotely. The changes were successfully applied to
  -your local copy.  You don't need to commit on this message as you
  -haven't made any local changes.</para>
  -
  -<para><userinput>C</userinput>: This one can be a nasty one to resolve. It
  -means that you have made local changes but at the same time someone has made
  -remote changes which can't be automatically merged with yours.  You will have
  -to go through the files (usually named with .'s and version numbers) and
  -sort the conflict out yourself. Due to the nature of the LFS book,
  -this doesn't happen very often. But if you make local changes and wait a
  -long time to commit them, somebody else may eventually edit that same file
  -and commit it before you do. When that happens, these conflicts
  -happen.</para>
  -
  -<para>Once you know why you're getting each symbol, and they're all
  -correct, you can proceed to the next step.</para>
  +  <para>([snip]'s were added by me, not the server). If you look at the first
  +    column, you will see various different letters which all mean different
  +    things.
  +  </para>
  +
  +  <para><userinput>?</userinput>: This is what CVS reports when it doesn't know
  +    what to do with a file.  Generally it means that you've forgotten to
  +    <userinput>cvs add</userinput> a file to the repository but can also just be
  +    temporary editor files which CVS doesn't know what to do with.  If it's just
  +    temporary files, don't worry, it won't try and commit them when you do a
  +    <userinput>cvs ci</userinput> because you haven't added them. Instead it'll
  +    just leave them alone.
  +  </para>
  +
  +  <para><userinput>A</userinput>: This is a file which has been added to CVS
  +    using <userinput>cvs add</userinput> but has not yet been committed.  When
  +    you're ready to commit it, simply do a <userinput>cvs ci</userinput> on it
  +    (and don't forget that nearly all cvs operations can be performed on as many
  +    files at once as you like; indeed, if you specify no file, it'll either give
  +    you an error (if it doesn't make sense; like with
  +    <userinput>cvs add</userinput> or <userinput>delete</userinput>) or simply
  +    perform the action on all files from that directory downwards in the tree;
  +    for example with <userinput>cvs ci</userinput>).
  +  </para>
  +
  +  <para><userinput>R</userinput>: This is a file which has been removed from CVS
  +    using <userinput>cvs delete</userinput> but has not yet been committed. The
  +    equivalent of 'A' for added files.
  +  </para>
  +
  +  <para><userinput>M</userinput>: This is a file which has been modified in your
  +    local repository and hasn't been checked in. If there have also been changes
  +    in the remote copy, it means that CVS successfully merged them. Even so, if
  +    (as in the file thisfilehashadchangesmergedin above) changes have been
  +    automatically merged, you should look them over to check that they make
  +    sense. Then, when you're ready, commit.
  +  </para>
  +
  +  <para><userinput>U</userinput>: This is a file which was unchanged locally but
  +    changed remotely. The changes were successfully applied to your local copy.
  +    You don't need to commit on this message as you haven't made any local
  +    changes.
  +  </para>
  +
  +  <para><userinput>C</userinput>: This one can be a nasty one to resolve. It
  +    means that you have made local changes but at the same time someone has made
  +    remote changes which can't be automatically merged with yours.  You will
  +    have to go through the files (usually named with .'s and version numbers)
  +    and sort the conflict out yourself. Due to the nature of the LFS book, this
  +    doesn't happen very often. But if you make local changes and wait a long
  +    time to commit them, somebody else may eventually edit that same file and
  +    commit it before you do. When that happens, these conflicts happen.
  +  </para>
  +
  +  <para>Once you know why you're getting each symbol, and they're all correct,
  +    you can proceed to the next step.
  +  </para>
   
   </sect1>
  
  
  
  1.2       +17 -11    LFS/editor-manual/chapter04/checkrender.xml
  
  Index: checkrender.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter04/checkrender.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- checkrender.xml	28 May 2002 21:41:12 -0000	1.1
  +++ checkrender.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,14 +1,20 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch04-checkrender">
  -<title>Check that the book renders properly</title>
  -<?dbhtml filename="checkrender.html" dir="chapter04"?>
  -
  -<para>Before commiting any changes, it's important to check that you
  -have all the syntax correct and that the book can actually pass through
  -<userinput>openjade</userinput> without making it belch.  Instructions
  -on how to render the book can be obtained by reading the
  -<filename>INSTALL</filename> and <filename>README</filename> files that are
  -in the LFS CVS repository. It's generally best to have a script which
  -automatically does it all for you. If not better, at least it's easier as
  -you don't have to type out the long openjade command all the time.</para>
  +  <title>Check that the book renders properly</title>
  +  <?dbhtml filename="checkrender.html" dir="chapter04"?>
   
  +  <para>Before commiting any changes, it's important to check that you have all
  +    the syntax correct and that the book can actually pass through
  +    <userinput>openjade</userinput> without making it belch.  Instructions on
  +    how to render the book can be obtained by reading the
  +    <filename>INSTALL</filename> and <filename>README</filename> files that are
  +    in the LFS CVS repository. It's generally best to have a script which
  +    automatically does it all for you. If not better, at least it's easier as
  +    you don't have to type out the long openjade command all the time.
  +  </para>
   </sect1>
  
  
  
  1.2       +6 -0      LFS/editor-manual/chapter04/commit.xml
  
  Index: commit.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter04/commit.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- commit.xml	28 May 2002 21:41:12 -0000	1.1
  +++ commit.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,3 +1,9 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch04-commit">
   <title>Commit it!</title>
   <?dbhtml filename="commit.html" dir="chapter04"?>
  
  
  
  1.2       +24 -15    LFS/editor-manual/chapter04/introduction.xml
  
  Index: introduction.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter04/introduction.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- introduction.xml	28 May 2002 21:41:12 -0000	1.1
  +++ introduction.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,19 +1,28 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch04-introduction">
  -<title>Introduction</title>
  -<?dbhtml filename="introduction.html" dir="chapter04"?>
  +  <title>Introduction</title>
  +  <?dbhtml filename="introduction.html" dir="chapter04"?>
   
  -<para>Here is a summary list of things to do before committing changes:</para>
  -
  -<itemizedlist>
  -<listitem><para>Test the instructions you are adding</para></listitem>
  -<listitem><para>Update <filename>index.xml</filename> with the new date
  -and / or updated entities if necessary.</para></listitem>
  -<listitem><para>Update <filename>chapter01/changelog.xml</filename></para></listitem>
  -<listitem><para>Check that all relevant files have been <userinput>cvs
  -add</userinput>'d or <userinput>remove</userinput>'d.</para></listitem>
  -<listitem><para>Check that the book renders properly.</para></listitem>
  -<listitem><para>Commit it</para></listitem>
  -<listitem><para>Update bugzilla to reflect the changes</para></listitem>
  -</itemizedlist>
  +  <para>Here is a summary list of things to do before committing changes:</para>
   
  +  <itemizedlist>
  +    <listitem><para>Test the instructions you are adding</para></listitem>
  +    <listitem><para>Update <filename>index.xml</filename> with the new date and
  +      / or updated entities if necessary.</para>
  +    </listitem>
  +    <listitem><para>Update <filename>chapter01/changelog.xml</filename></para>
  +    </listitem>
  +    <listitem><para>Check that all relevant files have been
  +      <userinput>cvs add</userinput>'d or <userinput>remove</userinput>'d.
  +      </para>
  +    </listitem>
  +    <listitem><para>Check that the book renders properly.</para></listitem>
  +    <listitem><para>Commit it</para></listitem>
  +    <listitem><para>Update bugzilla to reflect the changes</para></listitem>
  +  </itemizedlist>
   </sect1>
  
  
  
  1.2       +13 -7     LFS/editor-manual/chapter04/test.xml
  
  Index: test.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter04/test.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- test.xml	28 May 2002 21:41:12 -0000	1.1
  +++ test.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,10 +1,16 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch04-test">
  -<title>Test the instructions</title>
  -<?dbhtml filename="test.html" dir="chapter04"?>
  -
  -<para>This may seem <emphasis>really</emphasis> obvious but it's very easy
  -to make a typo in installation command changes which causes the
  -installation to break. We've all done it, you'll probably do it too
  -eventually. But double check to minimize the chance.</para>
  +  <title>Test the instructions</title>
  +  <?dbhtml filename="test.html" dir="chapter04"?>
   
  +  <para>This may seem <emphasis>really</emphasis> obvious but it's very easy to
  +    make a typo in installation command changes which causes the installation to
  +    break. We've all done it, you'll probably do it too eventually. But double
  +    check to minimize the chance.
  +  </para>
   </sect1>
  
  
  
  1.2       +23 -16    LFS/editor-manual/chapter04/updatechangelog.xml
  
  Index: updatechangelog.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter04/updatechangelog.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- updatechangelog.xml	28 May 2002 21:41:12 -0000	1.1
  +++ updatechangelog.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,22 +1,29 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch04-updatechangelog">
  -<title>Update chapter01/changelog.xml</title>
  -<?dbhtml filename="updatechangelog.html" dir="chapter04"?>
  +  <title>Update chapter01/changelog.xml</title>
  +  <?dbhtml filename="updatechangelog.html" dir="chapter04"?>
   
  -<para>Changelog updates should <emphasis>always</emphasis> be provided
  -with the exception of small typo fixes. You don't need to add "fixed
  -small typo in XXX" to the changelog otherwise it'd grow like topsy.</para>
  +  <para>Changelog updates should <emphasis>always</emphasis> be provided with
  +    the exception of small typo fixes. You don't need to add "fixed small typo
  +    in XXX" to the changelog otherwise it'd grow like topsy.
  +  </para>
   
  -<para>Changelog updates need to be in the following format:
  -<screen><listitem><para>Month Day, Year [username]: Chapter -
  -Section: What you changed.</para></listitem></screen></para>
  +  <para>Changelog updates need to be in the following format:
  +    <screen><listitem><para>Month Day, Year [username]: Chapter -
  +      Section: What you changed.</para></listitem></screen>
  +  </para>
   
  -<para>Example:
  -<screen><listitem><para>May 27th, 2002 [gerard]: Chapter 06 -
  -Ncurses: upgraded to ncurses-5.2-2.patch which is smaller than the previous
  -one.</para></listitem></screen></para>
  -
  -<para>Changelog entries are always on top of the previously added changelog
  -entry.
  -</para>
  +  <para>Example: <screen><listitem><para>May 27th, 2002 [gerard]:
  +    Chapter 06 - Ncurses: upgraded to ncurses-5.2-2.patch which is smaller than
  +    the previous one.</para></listitem></screen>
  +  </para>
   
  +  <para>Changelog entries are always on top of the previously added changelog
  +    entry.
  +  </para>
   </sect1>
  
  
  
  1.2       +19 -12    LFS/editor-manual/chapter04/updateindex.xml
  
  Index: updateindex.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter04/updateindex.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- updateindex.xml	28 May 2002 21:41:12 -0000	1.1
  +++ updateindex.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,18 +1,25 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch04-updateindex">
  -<title>Updating index.xml</title>
  -<?dbhtml filename="updateindex.html" dir="chapter04"?>
  +  <title>Updating index.xml</title>
  +  <?dbhtml filename="updateindex.html" dir="chapter04"?>
   
  -<para>The following elements should be updated in the
  -<filename>index.xml</filename> file whenever <emphasis>any</emphasis> change
  -(including small typo fixes) is made:</para>
  +  <para>The following elements should be updated in the
  +    <filename>index.xml</filename> file whenever <emphasis>any</emphasis> change
  +    (including small typo fixes) is made:
  +  </para>
   
  -<para><screen><!ENTITY version "20020429">
  -<!ENTITY releasedate "April 29th, 2002"></screen></para>
  +  <para><screen><!ENTITY version "20020429">
  +    <!ENTITY releasedate "April 29th, 2002"></screen>
  +  </para>
   
  -<para>The two dates must be the same, and the first is in the YYYYMMDD
  -format.</para>
  -
  -<para>Effectively, you'll only do this if you happen to be the first person
  -on a particular day who made a change.</para>
  +  <para>The two dates must be the same, and the first is in the YYYYMMDD format.
  +  </para>
   
  +  <para>Effectively, you'll only do this if you happen to be the first person on    a particular day who made a change.
  +  </para>
   </sect1>
  
  
  
  1.2       +19 -14    LFS/editor-manual/chapter05/addingcomments.xml
  
  Index: addingcomments.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter05/addingcomments.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- addingcomments.xml	28 May 2002 21:41:13 -0000	1.1
  +++ addingcomments.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,19 +1,24 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch05-addingcomments">
  -<title>Adding comments</title>
  -<?dbhtml filename="addingcomments.html" dir="chapter05"?>
  +  <title>Adding comments</title>
  +  <?dbhtml filename="addingcomments.html" dir="chapter05"?>
   
  -<itemizedlist>
  +  <itemizedlist>
   
  -<listitem><para>Go to the bug you want add comments to</para></listitem>
  -
  -<listitem><para>Add your additional information in the
  -<emphasis>Additional Comments</emphasis> text field.</para></listitem>
  -
  -<listitem><para>As the last step, click on the <emphasis>Commit</emphasis>
  -button to commit your changes to the database. A log of this will be sent
  -to the lfs-book mailinglist.</para></listitem>
  -
  -</itemizedlist>
  +    <listitem><para>Go to the bug you want add comments to</para></listitem>
   
  +    <listitem><para>Add your additional information in the
  +      <emphasis>Additional Comments</emphasis> text field.</para>
  +    </listitem>
  +
  +    <listitem><para>As the last step, click on the <emphasis>Commit</emphasis>
  +      button to commit your changes to the database. A log of this will be sent
  +      to the lfs-book mailinglist.</para>
  +    </listitem>
  +  </itemizedlist>
   </sect1>
  -
  
  
  
  1.2       +23 -16    LFS/editor-manual/chapter05/assignbug.xml
  
  Index: assignbug.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter05/assignbug.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- assignbug.xml	29 May 2002 11:30:30 -0000	1.1
  +++ assignbug.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,24 +1,31 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch05-assignbug">
  -<title>Assigning bugs</title>
  -<?dbhtml filename="assignbug.html" dir="chapter05"?>
  +  <title>Assigning bugs</title>
  +  <?dbhtml filename="assignbug.html" dir="chapter05"?>
   
  -<para>You're ready to start working on a bug that's in Bugzilla. Step one
  -is to assign the bug to yourself. This informs us that somebody is working
  -on the bug so we can move onto other bugs.</para>
  +  <para>You're ready to start working on a bug that's in Bugzilla. Step one is
  +    to assign the bug to yourself. This informs us that somebody is working on
  +    the bug so we can move onto other bugs.
  +  </para>
   
  -<itemizedlist>
  +  <itemizedlist>
   
  -<listitem><para>Go to the bug you want to work on.</para></listitem>
  +    <listitem><para>Go to the bug you want to work on.</para></listitem>
   
  -<listitem><para>Select the <emphasis>Accept bug (change status to
  -ASSIGNED)</emphasis> radio button.</para></listitem>
  +    <listitem><para>Select the <emphasis>Accept bug (change status to ASSIGNED)
  +      </emphasis> radio button.</para>
  +    </listitem>
   
  -<listitem><para>Click on the <emphasis>Commit</emphasis>
  -button.</para></listitem>
  -
  -<listitem><para>While working on the bug, sometimes you may want to add
  -comments to it. Feel free to do so.</para></listitem>
  -
  -</itemizedlist>
  +    <listitem><para>Click on the <emphasis>Commit</emphasis> button.</para>
  +    </listitem>
   
  +    <listitem><para>While working on the bug, sometimes you may want to add
  +      comments to it. Feel free to do so.</para>
  +    </listitem>
  +  </itemizedlist>
   </sect1>
  
  
  
  1.3       +13 -9     LFS/editor-manual/chapter05/chapter05.xml
  
  Index: chapter05.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter05/chapter05.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- chapter05.xml	29 May 2002 11:30:30 -0000	1.2
  +++ chapter05.xml	9 May 2004 19:27:44 -0000	1.3
  @@ -1,11 +1,15 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <chapter id="chapter05">
  -<title>Using Bugzilla</title>
  -<?dbhtml filename="chapter05" dir="chapter05"?>
  -
  -&c5-introduction;
  -&c5-addingcomments;
  -&c5-enternewbugs;
  -&c5-assignbug;
  -&c5-fixbug;
  -
  +  <title>Using Bugzilla</title>
  +  <?dbhtml filename="chapter05" dir="chapter05"?>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="introduction.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="addingcomments.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="enternewbugs.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="assignbug.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="fixbug.xml"/>
   </chapter>
  
  
  
  1.2       +59 -45    LFS/editor-manual/chapter05/enternewbugs.xml
  
  Index: enternewbugs.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter05/enternewbugs.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- enternewbugs.xml	28 May 2002 21:41:13 -0000	1.1
  +++ enternewbugs.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,50 +1,64 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch05-filingbug">
  -<title>Enter a new bug</title>
  -<?dbhtml filename="enternewbug.html" dir="chapter05"?>
  -
  -<para>You found a bug, or somebody else found a bug and you decided to add
  -it to Bugzilla.</para>
  -
  -<itemizedlist>
  -
  -<listitem><para>Go to <ulink
  -url="http://bugs.linuxfromscratch.org/enter_bug.cgi"/></para></listitem>
  -
  -<listitem><para>Select the proper <emphasis>Version</emphasis>. You most
  -always will choose the <emphasis>CVS</emphasis> version. It doesn't make
  -sense to report a bug against an old version if it's no longer in CVS. If
  -it is, then CVS is newer than a previously released stable book version.
  -The versions are basically there only for people who don't edit the book
  -and who want to report a bug against the book version they
  -have.</para></listitem>
  -
  -<listitem><para>Don't worry about <emphasis>Component, Platform, OS and
  -Severity</emphasis> Those aren't used at the moment.</para></listitem>
  -
  -<listitem><para>Select the <emphasis>Resolution Priority</emphasis>. Use
  -your own judgement on how important fixing this bug is. If you're not sure
  -just leave the default. Priorities are periodically re-evaluated and
  -changed anyways (what may be P5 a month ago may be changed to a P1 now
  -because it's finally time to fix it).</para></listitem>
  -
  -<listitem><para>Select the <emphasis>Initial state</emphasis>. Only select
  -<emphasis>UNCONFIRMED</emphasis> if you haven't checked the matter out yet
  -and are only suspecting a bug. Otherwise, leave it as
  -<emphasis>NEW</emphasis></para></listitem>
  -
  -<listitem><para>If you don't want to assign yourself to it right away,
  -leave the <emphasis>Assigned To</emphasis> field blank. It'll be assigned
  -to <emphasis>lfs-book at linuxfromscratch.org</emphasis> then, until a real
  -editor changes that to himself.</para></listitem>
  -
  -<listitem><para>Fill in the other fields as appropriate,
  -<emphasis>Summary</emphasis> and <emphasis>Description</emphasis> are
  -mandatory.</para></listitem>
  -
  -<listitem><para>As the last step, click on the <emphasis>Commit</emphasis>
  -button to commit your changes to the database. A log of this will be sent
  -to the lfs-book mailinglist.</para></listitem>
  +  <title>Enter a new bug</title>
  +  <?dbhtml filename="enternewbug.html" dir="chapter05"?>
   
  +  <para>You found a bug, or somebody else found a bug and you decided to add
  +    it to Bugzilla.
  +  </para>
  +
  +  <itemizedlist>
  +
  +  <listitem>
  +    <para>Go to <ulink url="http://bugs.linuxfromscratch.org/enter_bug.cgi"/>
  +    </para>
  +  </listitem>
  +
  +  <listitem><para>Select the proper <emphasis>Version</emphasis>. You most
  +    always will choose the <emphasis>CVS</emphasis> version. It doesn't make
  +    sense to report a bug against an old version if it's no longer in CVS. If it
  +    is, then CVS is newer than a previously released stable book version.  The
  +    versions are basically there only for people who don't edit the book and who
  +    want to report a bug against the book version they have.</para>
  +  </listitem>
  +
  +  <listitem><para>Don't worry about <emphasis>Component, Platform, OS and
  +    Severity</emphasis> Those aren't used at the moment.</para>
  +  </listitem>
  +
  +  <listitem><para>Select the <emphasis>Resolution Priority</emphasis>. Use your
  +    own judgement on how important fixing this bug is. If you're not sure just
  +    leave the default. Priorities are periodically re-evaluated and changed
  +    anyways (what may be P5 a month ago may be changed to a P1 now because it's
  +    finally time to fix it).</para>
  +  </listitem>
  +
  +  <listitem><para>Select the <emphasis>Initial state</emphasis>. Only select
  +    <emphasis>UNCONFIRMED</emphasis> if you haven't checked the matter out yet
  +    and are only suspecting a bug. Otherwise, leave it as
  +    <emphasis>NEW</emphasis></para>
  +  </listitem>
  +
  +  <listitem><para>If you don't want to assign yourself to it right away, leave
  +    the <emphasis>Assigned To</emphasis> field blank. It'll be assigned to
  +    <emphasis>lfs-book at linuxfromscratch.org</emphasis> then, until a real editor
  +    changes that to himself.</para>
  +  </listitem>
  +
  +  <listitem><para>Fill in the other fields as appropriate,
  +    <emphasis>Summary</emphasis> and <emphasis>Description</emphasis> are
  +    mandatory.</para>
  +  </listitem>
  +
  +  <listitem><para>As the last step, click on the <emphasis>Commit</emphasis>
  +    button to commit your changes to the database. A log of this will be sent to
  +    the lfs-book mailinglist.</para>
  +  </listitem>
   </itemizedlist>
   
   </sect1>
  
  
  
  1.2       +25 -20    LFS/editor-manual/chapter05/fixbug.xml
  
  Index: fixbug.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter05/fixbug.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- fixbug.xml	29 May 2002 11:30:30 -0000	1.1
  +++ fixbug.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,24 +1,29 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch05-fixbug">
  -<title>Mark a bug fixed</title>
  -<?dbhtml filename="fixbug.html" dir="chapter05"?>
  +  <title>Mark a bug fixed</title>
  +  <?dbhtml filename="fixbug.html" dir="chapter05"?>
   
  -<para>Bug fixed, changes commited to CVS, now mark the bug fixed.</para>
  -
  -<itemizedlist>
  -
  -<listitem><para>Go to the bug you fixed and is assigned to you.</para></listitem>
  -
  -<listitem><para>Select the <emphasis>Resolve bug, changing resolution
  -to</emphasis> radio button. Then select the proper resolution. Usually
  -you'll select <emphasis>FIXED</emphasis> here, but there are times when you
  -select other ones like cases where a reported bug is invalid
  -(<emphasis>INVALID</emphasis>), or we know about it but won't fix it
  -(<emphasis>WONTFIX</emphasis>) and so on.</para></listitem>
  -
  -<listitem><para>Click on the <emphasis>Commit</emphasis> button to commit
  -the changes to the database.</para></listitem>
  -
  -</itemizedlist>
  +  <para>Bug fixed, changes commited to CVS, now mark the bug fixed.</para>
   
  +  <itemizedlist>
  +    <listitem><para>Go to the bug you fixed and is assigned to you.</para>
  +    </listitem>
  +
  +    <listitem><para>Select the <emphasis>Resolve bug, changing resolution to
  +      </emphasis> radio button. Then select the proper resolution. Usually
  +      you'll select <emphasis>FIXED</emphasis> here, but there are times when
  +      you select other ones like cases where a reported bug is invalid
  +      (<emphasis>INVALID</emphasis>), or we know about it but won't fix it
  +      (<emphasis>WONTFIX</emphasis>) and so on.</para>
  +    </listitem>
  +
  +    <listitem><para>Click on the <emphasis>Commit</emphasis> button to commit
  +      the changes to the database.</para>
  +    </listitem>
  +  </itemizedlist>
   </sect1>
  -
  
  
  
  1.2       +15 -8     LFS/editor-manual/chapter05/introduction.xml
  
  Index: introduction.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter05/introduction.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- introduction.xml	28 May 2002 21:41:13 -0000	1.1
  +++ introduction.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,12 +1,19 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch05-introduction">
  -<title>Introduction</title>
  -<?dbhtml filename="introduction.html" dir="chapter05"?>
  +  <title>Introduction</title>
  +  <?dbhtml filename="introduction.html" dir="chapter05"?>
   
  -<para>This chapter covers the things you need to do when you are using
  -Bugzilla for entering new bugs into the system, and fixing/updating
  -outstanding bugs.</para>
  -
  -<para>We assume you have already logged into Bugzilla before doing anything
  -outlined in the following sections.</para>
  +  <para>This chapter covers the things you need to do when you are using
  +    Bugzilla for entering new bugs into the system, and fixing/updating
  +    outstanding bugs.
  +  </para>
   
  +  <para>We assume you have already logged into Bugzilla before doing anything
  +    outlined in the following sections.
  +  </para>
   </sect1>
  
  
  
  1.2       +13 -9     LFS/editor-manual/chapter06/chapter06.xml
  
  Index: chapter06.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter06/chapter06.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- chapter06.xml	29 May 2002 12:19:21 -0000	1.1
  +++ chapter06.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,12 +1,16 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <chapter id="chapter06">
  -<title>Package upgrade procedures</title>
  -<?dbhtml filename="chapter06" dir="chapter06"?>
  -
  -&c6-introduction;
  -&c6-updatebugzilla;
  -&c6-updatebook;
  -&c6-updateftp;
  -&c6-renderchecklinks;
  +  <title>Package upgrade procedures</title>
  +  <?dbhtml filename="chapter06" dir="chapter06"?>
   
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="introduction.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="updatebugzilla.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="updatebook.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="updateftp.xml"/>
  +  <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="renderchecklinks.xml"/>
   </chapter>
  -
  
  
  
  1.2       +23 -17    LFS/editor-manual/chapter06/introduction.xml
  
  Index: introduction.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter06/introduction.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- introduction.xml	29 May 2002 12:19:37 -0000	1.1
  +++ introduction.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,22 +1,28 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch06-introduction">
  -<title>Introduction</title>
  -<?dbhtml filename="introduction.html" dir="chapter06"?>
  +  <title>Introduction</title>
  +  <?dbhtml filename="introduction.html" dir="chapter06"?>
   
  -<para>Updating a package in the LFS-Book consists of three phases:</para>
  +  <para>Updating a package in the LFS-Book consists of three phases:</para>
   
  -<itemizedlist>
  -
  -<listitem><para>Updating bugzilla to announce the availability of a new
  -version of a package.</para></listitem>
  -
  -<listitem><para>Updating the LFS FTP archive to this new package can be
  -downloaded when it's added to the book. This includes creating a new
  -lfs-packages tarball.</para></listitem>
  -
  -<listitem><para>Updating the book to reflect the new version of package
  -and lfs-packages tarballs.</para></listitem>
  -
  -</itemizedlist>
  +  <itemizedlist>
   
  +    <listitem><para>Updating bugzilla to announce the availability of a new
  +      version of a package.</para>
  +    </listitem>
  +
  +    <listitem><para>Updating the LFS FTP archive to this new package can be
  +      downloaded when it's added to the book. This includes creating a new
  +      lfs-packages tarball.</para>
  +    </listitem>
  +
  +    <listitem><para>Updating the book to reflect the new version of package and
  +      lfs-packages tarballs.</para>
  +    </listitem>
  +  </itemizedlist>
   </sect1>
  -
  
  
  
  1.2       +13 -7     LFS/editor-manual/chapter06/renderchecklinks.xml
  
  Index: renderchecklinks.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter06/renderchecklinks.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- renderchecklinks.xml	29 May 2002 12:19:21 -0000	1.1
  +++ renderchecklinks.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,12 +1,18 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch06-renderchecklinks">
  -<title>Render the book and check links</title>
  -<?dbhtml filename="renderchecklinks.html" dir="chapter06"?>
  +  <title>Render the book and check links</title>
  +  <?dbhtml filename="renderchecklinks.html" dir="chapter06"?>
   
  -<para>Now that you're done, make sure the book renders properly and check
  -the links in <emphasis>Chapter 3</emphasis> to make sure the new package
  -links (lfs-packages and the package itself) are valid.</para>
  -
  -<para>If this checks out, then you're done with the package update.</para>
  +  <para>Now that you're done, make sure the book renders properly and check the
  +    links in <emphasis>Chapter 3</emphasis> to make sure the new package links
  +    (lfs-packages and the package itself) are valid.
  +  </para>
   
  +  <para>If this checks out, then you're done with the package update.</para>
   </sect1>
   
  
  
  
  1.3       +55 -46    LFS/editor-manual/chapter06/updatebook.xml
  
  Index: updatebook.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter06/updatebook.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- updatebook.xml	29 May 2002 12:20:59 -0000	1.2
  +++ updatebook.xml	9 May 2004 19:27:44 -0000	1.3
  @@ -1,51 +1,60 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch06-updatebook">
  -<title>Update the book</title>
  -<?dbhtml filename="updatebook.html" dir="chapter06"?>
  +  <title>Update the book</title>
  +  <?dbhtml filename="updatebook.html" dir="chapter06"?>
   
  -<para>When you're going to update the book by adding a new package to it,
  -here's how you do it:</para>
  +  <para>When you're going to update the book by adding a new package to it,
  +    here's how you do it:</para>
   
  -<itemizedlist>
  -
  -<listitem><para>Assign yourself to the bug for this new package (you'll
  -find it in Bug #30's Dependency Tree. See previous
  -section).</para></listitem>
  -
  -<listitem><para>Download the package to shadowfax in your home directory.
  -If it's not bzip2'ed, then make it so.</para></listitem>
  -
  -<listitem><para>Test build an LFS system to make sure this package compiles
  -properly in an LFS environment. Don't use your regular workstation's
  -environment - it may be sufficiently different for the compilation to
  -abort. A package may depend on something that you have installed but which
  -doesn't come with the LFS-Book. Also keep in mind that some packages are
  -used twice, in chapter 5 and in chapter 6.</para></listitem>
  -
  -<listitem><para>Update the installation instructions in the book if
  -necessary.</para></listitem>
  -
  -<listitem><para>When the package compiles properly and the package works
  -too (doesn't seg. fault or show other errors when trying to execute programs
  -from it), then open the <filename>entities/packagename.ent</filename> in an
  -editor.</para></listitem>
  -
  -<listitem><para>Find the <emphasis>package-version</emphasis> entity and
  -update its value to the new version. Don't change the
  -<emphasis>package-depversion</emphasis> and
  -<emphasis>package-contentversion</emphasis> unless you re-checked the
  -dependencies and contents of the new version.</para></listitem>
  -
  -
  -<listitem><para>Run <userinput>ls -l package-version.tar.bz2</userinput> on
  -the file you have in your home directory on shadowfax. Divide the filesize
  -by <emphasis>1024</emphasis> to get the number of Kilobytes. Round off to
  -the nearest Kilobyte and update the <emphasis>package-size</emphasis>
  -entity.</para></listitem>
  -
  -<listitem><para>Commit changes to CVS and continue immediately with the
  -next section which will update the LFS FTP archive.</para></listitem>
  -
  -</itemizedlist>
  +  <itemizedlist>
   
  +    <listitem><para>Assign yourself to the bug for this new package (you'll find
  +      it in Bug #30's Dependency Tree. See previous section).</para>
  +    </listitem>
  +
  +    <listitem><para>Download the package to shadowfax in your home directory.
  +      If it's not bzip2'ed, then make it so.</para>
  +    </listitem>
  +
  +    <listitem><para>Test build an LFS system to make sure this package compiles
  +      properly in an LFS environment. Don't use your regular workstation's
  +      environment - it may be sufficiently different for the compilation to
  +      abort.  A package may depend on something that you have installed but
  +      which doesn't come with the LFS-Book. Also keep in mind that some packages
  +      are used twice, in chapter 5 and in chapter 6.</para>
  +    </listitem>
  +
  +    <listitem><para>Update the installation instructions in the book if
  +      necessary.</para>
  +    </listitem>
  +
  +    <listitem><para>When the package compiles properly and the package works too
  +      (doesn't seg. fault or show other errors when trying to execute programs
  +      from it), then open the <filename>entities/packagename.ent</filename> in
  +      an editor.</para>
  +    </listitem>
  +
  +    <listitem><para>Find the <emphasis>package-version</emphasis> entity and
  +      update its value to the new version. Don't change the
  +      <emphasis>package-depversion</emphasis> and
  +      <emphasis>package-contentversion</emphasis> unless you re-checked the
  +      dependencies and contents of the new version.</para>
  +    </listitem>
  +
  +    <listitem><para>Run <userinput>ls -l package-version.tar.bz2</userinput> on
  +      the file you have in your home directory on shadowfax. Divide the
  +      filesize by <emphasis>1024</emphasis> to get the number of Kilobytes.
  +      Round off to the nearest Kilobyte and update the
  +      <emphasis>package-size</emphasis> entity.</para>
  +    </listitem>
  +
  +    <listitem><para>Commit changes to CVS and continue immediately with the next
  +      section which will update the LFS FTP archive.</para>
  +    </listitem>
  +  </itemizedlist>
   </sect1>
  -
  
  
  
  1.2       +39 -31    LFS/editor-manual/chapter06/updatebugzilla.xml
  
  Index: updatebugzilla.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter06/updatebugzilla.xml,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- updatebugzilla.xml	29 May 2002 12:19:21 -0000	1.1
  +++ updatebugzilla.xml	9 May 2004 19:27:44 -0000	1.2
  @@ -1,34 +1,42 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch06-updatebugzilla">
  -<title>Updating Bugzilla</title>
  -<?dbhtml filename="updatebugzilla.html" dir="chapter06"?>
  -
  -<para>When a new package is released by its maintainers, we mark this in
  -Bugzilla. You don't need to update the book right after a package is
  -released, but at least announce it.</para>
  -
  -<para>We have a special bug for packages updates, Bug #30. All package
  -update bugs are individual bugs, but they are all linked to Bug 30. Bug 30
  -is the parent bug so to speak.</para>
  -
  -<itemizedlist>
  -
  -<listitem><para>Go to Bug #30's Dependency Tree at <ulink
  -url="http://bugs.linuxfromscratch.org/showdependencytree.cgi?id=30"/></para></listitem>
  -
  -<listitem><para>Find the package that was just updated in this list and
  -click on its link (the link text will be crossed out (ie: a line through it
  -which means it's currently a fixed bug).</para></listitem>
  -
  -<listitem><para>Update the <emphasis>Summary</emphasis> field to reflect
  -the new available version.</para></listitem>
  -
  -<listitem><para>Select the <emphasis>Reopen bug</emphasis> radio
  -button.</para></listitem>
  -
  -<listitem><para>Click on the <emphasis>Commit</emphasis>
  -button.</para></listitem>
  -
  -</itemizedlist>
  +  <title>Updating Bugzilla</title>
  +  <?dbhtml filename="updatebugzilla.html" dir="chapter06"?>
   
  +  <para>When a new package is released by its maintainers, we mark this in
  +    Bugzilla. You don't need to update the book right after a package is
  +    released, but at least announce it.
  +  </para>
  +
  +  <para>We have a special bug for packages updates, Bug #30. All package update
  +    bugs are individual bugs, but they are all linked to Bug 30. Bug 30 is the
  +    parent bug so to speak.
  +  </para>
  +
  +  <itemizedlist>
  +
  +  <listitem><para>Go to Bug #30's Dependency Tree at <ulink
  +    url="http://bugs.linuxfromscratch.org/showdependencytree.cgi?id=30"/></para>  </listitem>
  +
  +  <listitem><para>Find the package that was just updated in this list and click
  +    on its link (the link text will be crossed out (ie: a line through it which
  +    means it's currently a fixed bug).</para>
  +  </listitem>
  +
  +  <listitem><para>Update the <emphasis>Summary</emphasis> field to reflect the
  +    new available version.</para>
  +  </listitem>
  +
  +  <listitem><para>Select the <emphasis>Reopen bug</emphasis> radio button.
  +    </para>
  +  </listitem>
  +
  +  <listitem><para>Click on the <emphasis>Commit</emphasis> button.</para>
  +  </listitem>
  +  </itemizedlist>
   </sect1>
  -
  
  
  
  1.5       +95 -69    LFS/editor-manual/chapter06/updateftp.xml
  
  Index: updateftp.xml
  ===================================================================
  RCS file: /home/cvsroot/LFS/editor-manual/chapter06/updateftp.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- updateftp.xml	26 Aug 2002 23:21:18 -0000	1.4
  +++ updateftp.xml	9 May 2004 19:27:44 -0000	1.5
  @@ -1,76 +1,102 @@
  +<?xml version="1.0" encoding="ISO-8859-1"?>
  +<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  +  <!ENTITY % general-entities SYSTEM "../general.ent">
  +  %general-entities;
  +]>
   <sect1 id="ch06-updateftp">
  -<title>Updating the LFS FTP Archive</title>
  -<?dbhtml filename="updateftp.html" dir="chapter06"?>
  +  <title>Updating the LFS FTP Archive</title>
  +  <?dbhtml filename="updateftp.html" dir="chapter06"?>
   
  -<para>Now that the book has been updated, it's time to update the LFS FTP
  -archive so people can download the new package.</para>
  +  <para>Now that the book has been updated, it's time to update the LFS FTP
  +    archive so people can download the new package.
  +  </para>
  +
  +  <itemizedlist>
  +    <listitem><para>Move the new package tarball from your home directory on
  +      shadowfax to the <filename
  +      class="directory">/home/ftp/lfs-packages/conglomeration</filename>
  +      directory.</para>
  +    </listitem>
  +
  +    <listitem><para>Go to the <filename
  +      class="directory">/home/ftp/lfs-packages/cvs</filename> directory.</para>
  +    </listitem>
  +
  +    <listitem><para>Remove the symlink that points to the old package.</para>
  +    </listitem>
  +
  +    <listitem><para>Create a new symlink that points to the new package by
  +      running a command like
  +      <userinput>ln -s ../conglomeration/package-newversion.tar.bz2</userinput>
  +      </para>
  +    </listitem>
  +
  +    <listitem><para>Remove the <filename>lfs-packages-cvs-*</filename> file.
  +      </para>
  +    </listitem>
  +
  +    <listitem><para>Recreate the <filename>00MD5SUMS</filename> file by running:
  +      </para>
  +
  +      <para><screen><userinput>rm 00MD5SUMS &&
  +md5sum * > 00MD5SUMS</userinput></screen>
  +      </para>
  +    </listitem>
  +
  +    <listitem><para>Run <userinput>date</userinput> to get the current date and
  +      time on the server.</para>
  +    </listitem>
  +
  +    <listitem>
  +      <para>Go to the <filename class="directory">/home/ftp/lfs-packages
  +        </filename> directory and create a new lfs-packages tarball by running
  +        the following commands:
  +      </para>
   
  -<itemizedlist>
  -
  -<listitem><para>Move the new package tarball from your home directory on
  -shadowfax to the
  -<filename
  -class="directory">/home/ftp/lfs-packages/conglomeration</filename>
  -directory.</para></listitem>
  -
  -<listitem><para>Go to the <filename
  -class="directory">/home/ftp/lfs-packages/cvs</filename>
  -directory.</para></listitem>
  -
  -<listitem><para>Remove the symlink that points to the old
  -package.</para></listitem>
  -
  -<listitem><para>Create a new symlink that points to the new package by
  -running a command like
  -<userinput>ln -s ../conglomeration/package-newversion.tar.bz2</userinput></para></listitem>
  -
  -<listitem><para>Remove the <filename>lfs-packages-cvs-*</filename>
  -file.</para></listitem>
  -
  -<listitem><para>Recreate the <filename>00MD5SUMS</filename> file by
  -running:</para>
  -
  -<para><screen><userinput>rm 00MD5SUMS &&
  -md5sum * > 00MD5SUMS</userinput></screen></para></listitem>
  -
  -<listitem><para>Run <userinput>date</userinput> to get the current date and
  -time on the server.</para></listitem>
  -
  -<listitem><para>Go to the <filename
  -class="directory">/home/ftp/lfs-packages</filename> directory and create a
  -new lfs-packages tarball by running the following
  -commands:</para>
  -
  -<para><screen><userinput>cp -av cvs lfs-packages-cvs-yyyymmdd-hhmm &&
  +      <para>
  +        <screen><userinput>cp -av cvs lfs-packages-cvs-yyyymmdd-hhmm &&
   tar cvfh lfs-packages-cvs-yyyymmdd-hhmm.tar lfs-packages-cvs-yyyymmdd-hhmm &&
   rm -r cvs &&
   mv lfs-packages-yyyymmdd-hhmm cvs &&
  -mv lfs-packages-yyyymmdd-hhmm.tar cvs</userinput></screen></para></listitem>
  -
  -<listitem><para>Add the new lfs-packages' MD5 hash to the 00MD5SUMS
  -file:</para>
  -
  -<para><screen><userinput>cd cvs &&
  -md5sum lfs-packages-yyyymmdd-hhmm.tar >> 00MD5SUMS</userinput></screen></para></listitem>
  -
  -<listitem><para>Check the filesize of this new lfs-packages-cvs tarball and
  -divide it by <emphasis>1024</emphasis> to get the number of Kilobytes.
  -Round it off to the nearest Kilobyte. Divide this number by
  -<emphasis>1024</emphasis> to get the number of Megabytes and round it off
  -to two digits after the decimal point.</para></listitem>
  -
  -<listitem><para>Go back to the LFS Book and edit the
  -<filename>index.xml</filename> file.</para></listitem>
  -
  -<listitem><para>Update the <emphasis>all-version</emphasis> entity and
  -enter the new version string in the <emphasis>cvs-yyyymmdd-hhmm</emphasis>
  -format.</para></listitem>
  -
  -<listitem><para>Update the <emphasis>all-size-kb</emphasis> and
  -<emphasis>all-size-mb</emphasis> entities with the values you calculated
  -above.</para></listitem>
  -
  -</itemizedlist>
  -
  +mv lfs-packages-yyyymmdd-hhmm.tar cvs</userinput></screen>
  +      </para>
  +    </listitem>
  +
  +    <listitem>
  +      <para>Add the new lfs-packages' MD5 hash to the 00MD5SUMS file:</para>
  +
  +      <para><screen><userinput>cd cvs &&
  +md5sum lfs-packages-yyyymmdd-hhmm.tar >> 00MD5SUMS</userinput></screen>
  +      </para>
  +    </listitem>
  +
  +    <listitem>
  +      <para>Check the filesize of this new lfs-packages-cvs tarball and divide
  +        it by <emphasis>1024</emphasis> to get the number of Kilobytes.  Round
  +        it off to the nearest Kilobyte. Divide this number by
  +        <emphasis>1024</emphasis> to get the number of Megabytes and round it
  +        off to two digits after the decimal point.
  +      </para>
  +    </listitem>
  +
  +    <listitem>
  +      <para>Go back to the LFS Book and edit the <filename>index.xml</filename>
  +        file.
  +      </para>
  +    </listitem>
  +
  +    <listitem>
  +      <para>Update the <emphasis>all-version</emphasis> entity and enter the new
  +        version string in the <emphasis>cvs-yyyymmdd-hhmm</emphasis> format.
  +      </para>
  +    </listitem>
  +
  +    <listitem>
  +      <para>Update the <emphasis>all-size-kb</emphasis> and
  +        <emphasis>all-size-mb</emphasis> entities with the values you calculated
  +        above.
  +      </para>
  +    </listitem>
  +  </itemizedlist>
   </sect1>
  -
  
  
  



More information about the lfs-book mailing list