Re: [PATCH 3/4] Add support for producing disks with (optional) extra variants.

[Frans Pop <elendil@planet.nl>]

On Friday 07 August 2009, Ian Campbell wrote:
> On Fri, 2009-08-07 at 16:13 +0200, Frans Pop wrote:
> > On Friday 07 August 2009, Ian Campbell wrote:
> > > This patch just adds the generic support code:
> > >    * CONF.sh:           Add $(VARIANTS) configuration variable.
> > >    * eash-build.sh:     Add command line parameter to enable
> > > variants. * Makefile:          Define VARIANT_xxx when
> > > preprocessing package list. * boot/?/common.sh:  Add a function for
> > > checking if a variant is enabled. * generate_di_list:  Allow
> > > variant overrides in udeb exclusion list.
> >
> > It would be nice to have the variants functionality documented a bit,
> > especially as it adds syntax extentions in various existing files.
>
> Sure.
>
> > Given the already fragmented state of the documentation, a separate
> > document in the docs directory probably makes most sense.
>
> Do I need to html it up and wire it into the existing documents? Looks
> like that stuff is very incomplete, a bunch of the links are dead and a
> variants chapter doesn't really seem to fit in anywhere in the existing
> narrative (such as it is), would a simple standalone text document to
> acceptable?

Eh, that's why I wrote "a separate document in the docs directory" :-)
I'd suggest a simple 'README.variants' text document.

I'd also suggest adding a reference to that doc in the CONF.sh instead of 
the example, and documenting the supported variants in the README.