From 97fc7e1f816caf8fe3cca09a5d02a239741bcfb2 Mon Sep 17 00:00:00 2001 From: Steve McIntyre <93sam@debian.org> Date: Thu, 28 Dec 2006 02:39:00 +0000 Subject: [PATCH] Added more docs, updated old ones to match current reality --- docs/getting.html | 4 +- docs/index.html | 11 ++- docs/makefile.html | 149 +++++++++++++++++++++++++++++++++++++++++ docs/requirements.html | 8 +-- docs/running.html | 61 +++++++++++++++++ docs/setup.html | 31 +++++++-- 6 files changed, 245 insertions(+), 19 deletions(-) create mode 100644 docs/makefile.html create mode 100644 docs/running.html diff --git a/docs/getting.html b/docs/getting.html index f2822203..0beb8de8 100644 --- a/docs/getting.html +++ b/docs/getting.html @@ -2,7 +2,7 @@ getting debian-cd -

getting debian-cd

Development versions - using svn

@@ -33,7 +33,7 @@ for archives and details of how to subscribe.

-(c) Steve McIntyre <steve@einval.com>, April 2006. GPL v2
+(c) Steve McIntyre <steve@einval.com>, December 2006. GPL v2
Prev - Overview
Next - Requirements diff --git a/docs/index.html b/docs/index.html index 067fcf34..1dbbd832 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@ debian-cd -

debian-cd

An attempt at documentation!

@@ -44,8 +44,8 @@ href="cd-contents.html">CD contents.

debian-cd is made up of a large central Makefile and lots of small(ish) helper scripts written in sh and perl. It depends on various other packages to do lots of the hard work, for example apt to -calculate t package dependencies and debootstrap to provide the list -of packages needed for a base installation.

+calculate package dependencies and debootstrap to provide the list of +packages needed for a base installation.

A typical debian-cd run will involve:

@@ -57,12 +57,11 @@ there are other config options.
  • Running a build wrapper script (build.sh or build_all.sh); the wrapper script will call various rules in the Makefile
  • Parse Packages files from the mirror to work out what packages are available -
  • Work out what will fit on each CD, and how many CDs are needed
  • Make temporary trees, one for each output image
  • Set up volume information in each tree
  • Copy in boot files and d-i bits onto each CD where they are wanted
  • Copy documentation files onto CDs as required -
  • Copy the packages files onto each CD; generate Packages metadata +
  • Copy packages files onto each CD; generate Packages metadata files along the way
  • Generate checksums of the files on each CD
  • Run mkisofs to turn the temporary trees into ISO images and/or @@ -73,7 +72,7 @@ jigdo files details on each of the steps!

    -(c) Steve McIntyre <steve@einval.com>, April 2006. GPL v2
    +(c) Steve McIntyre <steve@einval.com>, December 2006. GPL v2
    Next - Getting debian-cd diff --git a/docs/makefile.html b/docs/makefile.html new file mode 100644 index 00000000..f540e974 --- /dev/null +++ b/docs/makefile.html @@ -0,0 +1,149 @@ + + +The Makefile + + +

    The Makefile

    + +

    A quick overview of the debian-cd Makefile: what it does, and +how.

    + +

    Variable setup and checking

    + +

    Simple sanity checking that all the needed variables from CONF.sh +are present and correct, and also set up some more internal +variables:

    + +

    Setting these options is sufficient to allow creation of a standard @@ -46,8 +57,9 @@ wanting to make different images include:

  • NONFREE - whether or not to allow packages from the non-free section onto the CDs
  • EXTRANONFREE - like NONFREE, but sort the non-free packages to a separate last CD instead of mixing them in
  • LOCAL - if you have a local set of packages that you want to merge into your CDs, specify the location here. The location should look just like the other sections (main, contrib, non-free) with Packages files etc. -
  • DEFBINSIZE - the approximate target size of a binary image, in megabytes. See CONF.sh for more details on how this works. -
  • DEFSRCSIZE - the approximate target size of a source image, in megabytes. See CONF.sh for more details on how this works. +
  • LOCALDEBS - if you have set LOCAL above +and the local packages are outside of the MIRROR tree, +specify the local here.
  • EXCLUDE - specifies a file listing packages that should be omitted from consideration when laying out the CDs
  • UNEXCLUDE$N - a way to re-add excluded packages back into the set, starting with CD number $N. Using EXCLUDE and UNEXCLUDE allows some finer-grained control of package placement if desired
  • DOJIGDO - specify what to create: 0 means ISOs only; 1 means ISOs and jigdo files; 2 means jigdo files only @@ -62,11 +74,16 @@ wanting to make different images include:

  • SPLASHPNG - specify the image to be used on the boot splash screen, on architectures where this is supported -

    If you do tweak some of these options, especially image sizes, it -may take quite a few iterations of testing to get exactly what you're -looking for...

    +

    If you do tweak some of these options, it may take quite a few +iterations of testing to get exactly what you're looking for. Be +warned!

    +

    For more information and yet more configuration, please see the +comments in the shipped CONF.sh file. Or, if in doubt, ask!

    + +
    +(c) Steve McIntyre <steve@einval.com>, December 2006. GPL v2
    Prev - debian-cd requirements
    -Next - Full details of CONF.sh configuration +Next - Running debian-cd to make some disc images