RE: desparately trying to get pxe-bootversionofpxesworking...

"Mitch (WebCob)" <[email protected]> Wed, 29 Jun 2005 14:58:18 -0700
Newsgroups gmane.linux.pxes.devel
Message-ID <[email protected]>
> Congratulations.
> 
[Mitch says:] Now on to refining and documenting ;-)

A question for you - how do you feel about self-documenting config files?

Courier for example provides config files of the form:

#Set options as indicate in selection list - default is shown
#boolean or on / off values are indicated by 1 or 0

#RDP_ASK_ENABLED='1'
#If enabled, ask the user to confirm default values for RDP_SERVER_NAME,
#RDP_COLOR_DEPTH, and ?
RDP_ASK_ENABLED='0'

#RDP_ATTACH_TO_CONSOLE='0'
#RDP_CLIENT_HOSTNAME=''

That way the document can be more generic, and all options don't need to be
listed - especially ones that are very obvious... - just a thought.

It could be in the web page too, but I've seen that in a lot of projects
that are changing a lot or have a smaller team, the web / wiki often lags
the release unless the control files are self documenting.

m/



-------------------------------------------------------
SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
from IBM. Find simple to follow Roadmaps, straightforward articles,
informative Webcasts and more! Get everything you need to get up to
speed, fast. http://ads.osdn.com/?ad_id=7477&alloc_id=16492&op=click