Re: Take A deep Breath - Kernel Documentation

Darin Johnson (darin@connectnet.com)
Mon, 21 Jul 1997 11:39:31 -0700 (PDT)


> Good, as long as someone other than the coder takes the responsibility
> of maintaining said document. I don't think it's to anyone's benefit to
> delay code changes so that docs can be written.

That's the wrong attitude. Doc is easy; just don't put it off! The
coder must have that responsibility, because only the coder knows what
changed! It doesn't take much time, but it can take forever if the
coder waits until the coding is done! Just add a few lines to
ChangeLog that describe what's being changed and why! Also, whenever
*any* patch is given to someone, it should always include
documentation on what the patch is for. It doesn't need to be
end-user doc, but enough that someone can then take that information
and write something more complete.

Ie, something like "Block wasn't being freed, which could have
resulted in lost memory over time" or "added mount option".

And while you're at it, add some comments too! Linux is woefully
short on comments in the kernel. Code can't be considered complete if
there's no docs or comments to go with it.