[SCM] Debian Live manual branch, master, updated. 99284bea9e49ab9c88fd73e2e85045194240dfd7

Chris Lamb chris at chris-lamb.co.uk
Fri May 23 22:46:29 UTC 2008 

The following commit has been merged in the master branch:
commit 99284bea9e49ab9c88fd73e2e85045194240dfd7
Author: Chris Lamb <chris at chris-lamb.co.uk>
Date:   Fri May 23 23:46:06 2008 +0100

    Use <section/> instead of <sectX/> (numbered sections)
    
    Signed-off-by: Chris Lamb <chris at chris-lamb.co.uk>

diff --git a/chapters/about.xml b/chapters/about.xml
index f2ab407..b5f703e 100644
--- a/chapters/about.xml
+++ b/chapters/about.xml
@@ -9,7 +9,7 @@
 <section id="motivation">
 <title>Motivation</title>
 
-<sect1>
+<section>
 <title>What is wrong with current live systems</title>
 
 <para>There are already several Debian-based live systems and they are doing a great job. But, from the Debian perspective, most of them have one or more of the following disadvantages:</para>
@@ -24,9 +24,9 @@
 <listitem><para>They are large and slow due to their sheer size and thus not suitable for rescue issues.</para></listitem>
 <listitem><para>They are not available in different flavours, e.g. CDs, DVDs, USB-stick and netboot images </para></listitem>
 </orderedlist>
-</sect1>
+</section>
 
-<sect1>
+<section>
 <title>Why create our own live system?</title>
 
 <para>Debian is the Universal Operating System: Debian should have an official live system for showing around and to officially represent the true, one and only Debian system with the following main advantages:</para>
@@ -40,23 +40,23 @@
 <listitem><para>It uses an unaltered Debian kernel-image with no additional patches.</para></listitem>
 </orderedlist>
 
-</sect1>
+</section>
 
 </section>
 
 <section id="philosophy">
 <title>Philosophy</title>
 
-<sect1>
+<section>
 <title>Only unchanged, official packages</title>
 <para>We will only use official packages from the Debian repository, section main or maybe contrib (the use of contrib is not decided yet). The non-free section is not part of Debian and therefore not used at all for the live system.</para>
 
 <para>We will not change any packages. Whenever we need to change something, we will do that in coordination with its package maintainer in Debian.</para>
 
 <para>Exception: temporarly, our own packages like live-helper or live-initramfs may be used from our own repository for development reasons (e.g. to create development snapshots). They will be synced into Debian on a regular basis.</para>
-</sect1>
+</section>
 
-<sect1>
+<section>
 <title>No configuration of the live system</title>
 <para>In this phase we will not ship or install sample or alternative configurations. All packages are used in their default configuration as they are after a regular installation of Debian.</para>
 
@@ -65,16 +65,16 @@
 <para>A system for configuring packages is provided using debconf in lh_config (use --preseed FILE) allowing custom configured packages to be installed in your custom produced Debian Live images, but for official live images only default configuration will be used.</para>
 
 <para>Exception: There are a few essential changes needed to be make a live system alive (e.g. configuring pam to allow empty passwords). These essential changes have to be kept as minimal as possible and, should be merged within the Debian repository if possible.</para>
-</sect1>
+</section>
 
-<sect1>
+<section>
 <title>No live system to hardisk installer</title>
 <para>[ this is no longer valid after etch release, we will work on an installer for lenny ]</para>
 
 <para>For the moment we will not ship a installer to copy the live system to a partition on the hardisk. Although we keep the changes in the live system as drastically minimal as possible compared to a regular Debian installation, the live system does differ in a few essential points (see exceptions, guideline 2).</para>
 
 <para>Therefore, we will ship a copy of the regular DebianInstaller (resp. Debian Installer, Graphical Installer) instead, to allow users to perform a regular Debian installation (and, of course, cdebootstrap and debootstrap are on the system too).</para>
-</sect1>
+</section>
 
 </section>
 
diff --git a/chapters/basics.xml b/chapters/basics.xml
index fac775c..f326633 100644
--- a/chapters/basics.xml
+++ b/chapters/basics.xml
@@ -29,7 +29,7 @@ $ lh_config
 
 <para>This process can take a while, depending on the speed of your network connection.</para>
 
-<sect1>
+<section>
 <title>Testing an ISO image with Qemu</title>
 <para>Testing an ISO is simple:</para>
 
@@ -37,9 +37,9 @@ $ lh_config
 # apt-get install qemu
 $ qemu -cdrom binary.iso
 </screen>
-</sect1>
+</section>
 
-<sect1>
+<section>
 <title>Burning an ISO image to physical medium</title>
 <para>Burning an ISO image is easy:</para>
 
@@ -47,7 +47,7 @@ $ qemu -cdrom binary.iso
 # apt-get install wodim
 $ wodim binary.iso
 </screen>
-</sect1>
+</section>
 
 </section>
 
@@ -73,20 +73,20 @@ $ lh_config -b usb-hdd
 # lh_build
 </screen>
 
-<sect1>
+<section>
 <title>Copying USB/HDD image to a USB stick</title>
 <screen>
 $ dd if=binary.img of=$USBDRV
 </screen>
-</sect1>
+</section>
 
-<sect1>
+<section>
 <title>Testing a USB/HDD image with Qemu</title>
 <screen>
 # apt-get install qemu
 $ qemu -hda binary.img
 </screen>
-</sect1>
+</section>
 </section>
 
 <section>
diff --git a/chapters/customisation-bootup.xml b/chapters/customisation-bootup.xml
index ee98f78..efd302b 100644
--- a/chapters/customisation-bootup.xml
+++ b/chapters/customisation-bootup.xml
@@ -18,20 +18,20 @@
 <title>Bootloaders</title>
 <para>FIXME</para>
 
-<sect1>
+<section>
 <title>Choosing a bootloader</title>
 <para>FIXME</para>
-</sect1>
+</section>
 
-<sect1 id="syslinux">
+<section id="syslinux">
 <title>Syslinux</title>
  <para>In the default configuration, Syslinux will pause indefinitely at its splash screen. To adjust ths, modify the <computeroutput>LH_SYSLINUX_TIMEOUT</computeroutput> value or pass <computeroutput>--syslinux-timeout <replaceable>TIMEOUT</replaceable></computeroutput> to <filename>lh_config</filename>. The value is specified in units of 1/10s and the maximum possible timeout is 35996. A timeout of 0 (zero) disables the timeout completely. For more information please see syslinux(1).</para>
-</sect1>
+</section>
 
-<sect1>
+<section>
 <title>Bootloader templates</title>
 <para>FIXME</para>
-</sect1>
+</section>
 </section>
 
 <section id="splash">
diff --git a/chapters/customisation-contents.xml b/chapters/customisation-contents.xml
index ebf72d1..ce933df 100644
--- a/chapters/customisation-contents.xml
+++ b/chapters/customisation-contents.xml
@@ -50,7 +50,7 @@
   Please see <xref linkend="terms"/> for more information about the distinction between the "Live" and "binary" images.
  </para>
 
-<sect1 id="chroot-local-includes">
+<section id="chroot-local-includes">
  <title>Live/chroot local includes</title>
  <para>
   Chroot local includes can be used to add or replace files in the chroot/Live filesystem so that they are visible when the Live system is booted. Typical uses for them are to populate the skeleton user directory (<filename class="directory">/etc/skel</filename>) or adding configuration files where additional processing is not required.
@@ -84,21 +84,21 @@
  <para>
   Chroot local includes are installed after package installation so that files installed by packages are overwritten.
  </para>
-</sect1>
+</section>
 
-<sect1 id="binary-local-includes">
+<section id="binary-local-includes">
 <title>Binary local includes</title>
  <para>
   FIXME.
  </para>
-</sect1>
+</section>
 
-<sect1 id="binary-includes">
+<section id="binary-includes">
 <title>Binary includes</title>
  <para>
   FIXME.
  </para>
-</sect1>
+</section>
 
 </section>
 
@@ -108,15 +108,15 @@
 <para>FIXME.</para>
 <para>Enabling hooks</para>
 
-<sect1 id="chroot-local-hooks">
+<section id="chroot-local-hooks">
 <title>Live/chroot local hooks</title>
 <para>FIXME.</para>
-</sect1>
+</section>
 
-<sect1 id="binary-local-hooks">
+<section id="binary-local-hooks">
 <title>Binary local hooks</title>
 <para>FIXME.</para>
-</sect1>
+</section>
 
 </section>
 
diff --git a/chapters/customisation-packages.xml b/chapters/customisation-packages.xml
index 24da677..7aeda5f 100644
--- a/chapters/customisation-packages.xml
+++ b/chapters/customisation-packages.xml
@@ -53,7 +53,7 @@
 <listitem><para>Tasks</para></listitem>
 </orderedlist>
 
-<sect1 id="lh-packages">
+<section id="lh-packages">
 <title>The <computeroutput>LH_PACKAGES</computeroutput> variable</title>
 <para>To install additional packages, simply add them to the <computeroutput>LH_PACKAGES</computeroutput> variable in <filename>config/chroot</filename>. For example:</para>
 
@@ -70,9 +70,9 @@ LH_PACKAGES="package1 package2 package3 ... "
 <para>The behaviour of &live-helper; when specifying a package that does not exist is determined by your choice of APT utility. See <xref linkend="package-installation"/> for more details.</para>
 
 <para>If you need to specify a large number of packages to be installed or you need flexibility regarding which packages to install, you should probably be using package lists. See <xref linkend="package-lists"/> for more information.</para>
-</sect1>
+</section>
 
-<sect1 id="package-lists">
+<section id="package-lists">
 <title>Package lists</title>
 <para>Package lists are a powerful way of expressing which packages should be installed. &live-helper; ships with a number of predefined package lists which provide sensible default package selections for the GNOME and KDE desktop environments, as well as standard systems.</para>
 
@@ -84,14 +84,14 @@ LH_PACKAGES_LISTS="gnome"
 
 <para>Packages lists that a distributed with &live-helper; reside in view in the <computeroutput>/usr/share/live-helper/lists</computeroutput> directory.</para>
 
-<sect2>
+<section>
 <title>Local packages lists</title>
 <para>You may supplement the supplied lists using local package lists stored in <computeroutput>config/chroot_local-packageslists</computeroutput>.</para>
 <para>Package lists that exist in this directory always override package lists distributed with &live-helper;. This can cause undesired effects when..</para>
 
-</sect2>
+</section>
 
-<sect2>
+<section>
 <title>Extending a provided package list using includes</title>
 <para>FIXME.</para>
 
@@ -101,9 +101,9 @@ iceweasel
 </screen>
 
 <para>The package lists that are included with &live-helper; make extensive use of includes. They are available to view in the <computeroutput>/usr/share/live-helper/lists</computeroutput> directory.</para>
-</sect2>
+</section>
 
-<sect2>
+<section>
 <title>Using conditionals inside packages lists</title>
 <para>FIXME</para>
 
@@ -140,14 +140,14 @@ vrms
 <para>Any &live-helper; configuration variable that begins with <computeroutput>LH_</computeroutput> can be tested in this way.</para>
 <para>The nesting of conditionals is not supported.</para>
 
-</sect2>
+</section>
 
-</sect1>
+</section>
 
-<sect1 id="tasks">
+<section id="tasks">
 <title>Tasks</title>
 <para>FIXME</para>
-</sect1>
+</section>
 
 </section>
 
@@ -166,7 +166,7 @@ vrms
 
 <para>The <filename>chroot_local-packages</filename> is simpler to achieve and useful for "one-off" customisations but has a number of drawbacks, whilst using a custom APT repository is more time-consuming to setup.</para>
 
-<sect1 id="local-packages">
+<section id="local-packages">
 <title>Using <filename>chroot_local-packages</filename> to install custom packages</title>
 <para>To install a custom package, simply copy it to the <computeroutput>config/chroot_local-packages</computeroutput> directory. Packages that are inside this directory will be automatically installed into the live system during build - you do not need to specify them elsewhere.</para>
 
@@ -178,28 +178,28 @@ vrms
 <listitem><para>You must install all appropriate packages in the <computeroutput>config/chroot_local-packages</computeroutput> directory</para></listitem>
 <listitem><para>Does not lend itself to storing Debian Live configurations in revision control</para></listitem>
 </orderedlist>
-</sect1>
+</section>
 
-<sect1 id="custom-apt-repo">
+<section id="custom-apt-repo">
 <title>Using an APT repository to install custom packages</title>
 <para>FIXME</para>
 <para>Unlike You must ensure that you specify the package elsewhere, see (FIXME)</para>
 <para>Whilst it may seem unnecessary effort to create an APT repository to install custom packages, the infrastructure can be easily re-used at a later date to offer updates of the modified package.</para>
-</sect1>
+</section>
 
-<sect1 id="custom-packages-apt">
+<section id="custom-packages-apt">
 <title>Custom packages and APT</title>
 <para>&live-helper; uses APT to install all packages into the live system so will therefore inherit behaviours from this program. One relevant example is that (assuming a default configuration) given a package is available in two different repositories, APT will elect to install the package with a higher version number over one with the lower.</para>
 
 <para>Because of this. you may wish to increment the version number in your custom packages' <computeroutput>debian/changelog</computeroutput> files to ensure that your modified version is installed over one in the official Debian repositories. This may also be achieved by altering the live system's APT pinning preferences - see <xref linkend="apt-preferences"/> for more information.</para>
 
-</sect1>
+</section>
 
-<sect1 id="apt-preferences">
+<section id="apt-preferences">
 <title>Altering APT preferences during Live system</title>
 <para>FIXME</para>
 <para>Whilst it may seem unnecessary effort to create an APT repository to install custom packages, the infrastructure can be easily re-used at a later date to offer updates of the modified package.</para>
-</sect1>
+</section>
 
 </section>
 
diff --git a/chapters/installation.xml b/chapters/installation.xml
index 594debc..574e434 100644
--- a/chapters/installation.xml
+++ b/chapters/installation.xml
@@ -36,7 +36,7 @@
 
 <para>If you are using &lenny; or &sid; the recommended way is to install &live-helper; via the Debian repository.</para>
 
-<sect1>
+<section>
  <title>From the Debian repository</title>
 
  <para>Simply install &live-helper; like any other package:</para>
@@ -51,9 +51,9 @@
  % aptitude install live-helper
 </screen>
 
-</sect1>
+</section>
 
-<sect1>
+<section>
  <title>From source</title>
 
  <para>&live-helper; is developed using the Git revision control system. On Debian systems, this is provided by the <computeroutput>git-core</computeroutput> package. To check out the latest code, execute:</para>
@@ -84,14 +84,14 @@
 <screen>
  $ make install
 </screen>
-</sect1>
+</section>
 
-<sect1>
+<section>
 <title>From 'snapshots'</title>
 <para>If you do not wish to build or install &live-helper; from source, you can use snapshots. These are built automatically from the latest version in Git.</para>
-</sect1>
+</section>
 
-<sect1>
+<section>
 <title>From Backports.org</title>
 
  <para>Whilst &live-helper; and friends are currently not a part of Debian stable relase, they will work on &etch; as well. You will need the following programs:</para>
@@ -101,7 +101,7 @@
 <listitem><para>The <emphasis>lenny</emphasis> or <emphasis>sid</emphasis> version of &live-helper;</para></listitem>
 </orderedlist>
 
-<sect2>
+<section>
 <title>Installing cdebootstrap from backports.org</title>
 <orderedlist>
 
@@ -124,9 +124,9 @@ apt-get install -t etch-backports cdebootstrap
 </screen></listitem>
 
 </orderedlist>
-</sect2>
+</section>
 
-<sect2>
+<section>
 <title>Installing &live-helper; on etch</title>
 
 <para>It is not recommended that you use &live-helper; from backports.org as it is likely to be out of date.
@@ -143,15 +143,15 @@ apt-get install -t unstable live-helper
 
 Of course you need the testing or unstable sources in /etc/apt/sources.list for this.</para>
 
-</sect2>
-</sect1>
+</section>
+</section>
 
 </section>
 <section>
 <title>&live-initramfs;</title>
 <para><emphasis>N.B. You do not need to install on your host system to create customised Debian Live systems. However, doing so will do no harm.</emphasis></para>
 
-<sect1>
+<section>
 <title>Using a customised &live-initramfs;</title>
 
 <para>To modify the code you can follow the process below. Please ensure you are familiar with the terms mentioned in <xref linkend="terms"/>.</para>
@@ -184,7 +184,7 @@ $ debuild -us -uc -b
 </listitem>
 
 </orderedlist>
-</sect1>
+</section>
 
 </section>
 
diff --git a/chapters/overview.xml b/chapters/overview.xml
index 132488d..a182f5b 100644
--- a/chapters/overview.xml
+++ b/chapters/overview.xml
@@ -56,7 +56,7 @@
 </variablelist>
 </para>
 
-<sect1 id="lh_config">
+<section id="lh_config">
 <title>The <filename>lh_config</filename> helper</title>
 <para>As discussed in <xref linkend="live-helper"/>, the scripts that make up &live-helper; source their configuration from a single directory named <computeroutput>config/</computeroutput>. As constructing this directory by hand would be time-consuming and error-prone, the <filename>lh_config</filename> helper can be used to create skeleton configuration folders.</para>
 
@@ -108,17 +108,17 @@ drwxr-xr-x 2 user group 4.1k 2008-05-09 21:37 templates
 
 <para>A full list of options is available FIXME. Most options have a parallel with an "<computeroutput>LH_</computeroutput>" prefixed variable.</para>
 
-</sect1>
+</section>
 
-<sect1 id="lh_build">
+<section id="lh_build">
 <title>The <filename>lh_build</filename> helper</title>
 <para>FIXME</para>
-</sect1>
+</section>
 
-<sect1 id="lh_clean">
+<section id="lh_clean">
 <title>The <filename>lh_clean</filename> helper</title>
 <para>It is the job of the <filename>lh_clean</filename> helper to remove various parts of a Live helper build.</para>
-</sect1>
+</section>
 </section>
 
 <section id="live-initramfs">

-- 
Debian Live manual

More information about the debian-live-changes mailing list