Re: Kernel Documentation

John Levon
2001-07-18T02:19:41Z

On Tue, Jul 17, 2001 at 02:25:03PM -0700, Charles Samuels wrote:

> On Tuesday 17 July 2001 02:18 pm, you wrote:
> > ++ 17/07/01 14:02 -0700 - Charles Samuels:
> > 2 things:
> >
> > 1: there is a project in the kernel to establish API references.
> > you should not duplicate this work, but should add to it.
> > Reason: There is no way you can get or stay ahead.
>
> make htmldoc ? I don't have docbook, and don't want to have to install it,
> well, unless I know that it'l get me what I want. Does it create an actual
> API reference?

yes. you can read a recent version at http://kernelnewbies.org/documents/kdoc/

Everyone would much prefer it if you pitched in with this instead I think...

one simple advantage is the docs are inline so have a slightly higher chance
of staying up to date.

regards
john

--
"Voodoo Programming: Things programmers do that they know shouldn't work but
they try anyway, and which sometimes actually work, such as recompiling
everything."
- Karl Lehenbauer