On 1/2/06, Joern Nettingsmeier <[EMAIL PROTECTED]> wrote:
>
> <mini-rant obnoxiousness="medium">
>         we do need good documentation of the entire filesystem layout
>         under /build/lenya/ and what each directory and file does.
> </mini-rant>
> i'll start a wiki page for that.
>

A wiki page would be a good thing.  But I think it might be better to
have instead (or in addition), within most of the Lenya directories, a
README.txt file that contains a brief description of the purpose of
each directory, and a paragraph at the top of each file describing its
purpose.  As has been noted elsewhere, there are thousands of files in
Lenya and many of them lack internal documentation.

If the dev's agree with this, I will help where I can.  For example,
if Joern makes a wiki page describing each directory, then after
others have reviewed it, I'll copy his text into a bunch of README.txt
files and assemble them as a patch, attached to a bug in bugzilla,
that a committer can then add to the appropriate directories.

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to