Re: [patch] kernel API documentation system

Nat Lanza (magus@cs.cmu.edu)
26 Sep 1999 13:17:50 -0400


Jes Sorensen <Jes.Sorensen@cern.ch> writes:

> Documentation/autogenerated or something else that makes it clear it
> is not to be mixed with static documents. Documentation/api doesn't
> imply that.

Hmm, good point. Then again, if I was a new kernel hacker looking for
API documentation, 'Documentation/autogenerated' wouldn't necessarily
be the first place I looked.

Would a README in Documentation/api explaining that everything in that
directory is autogenerated and how to generate it be sufficient?

--nat

-- 
nat lanza --------------------- research programmer, parallel data lab, cmu scs
magus@cs.cmu.edu -------------------------------- http://www.cs.cmu.edu/~magus/
there are no whole truths; all truths are half-truths -- alfred north whitehead

- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.rutgers.edu Please read the FAQ at http://www.tux.org/lkml/