Re: CVS commit: src/sys/fs/tmpfs

["Perry E. Metzger" <perry%piermont.com@localhost>]

[We should move this to a different mailing list -- ideas?]

Jason Thorpe <thorpej%shagadelic.org@localhost> writes:
> On Sep 13, 2005, at 6:37 AM, Perry E. Metzger wrote:
>
>>> FWIW, we already describe structures in manual pages, e.g., vnode(9).
>>
>> I think having man pages explaining the structure of various kernel
>> subsystems is actually a pretty good idea.
>
> Except tmpfs is not a subsystem.  It does not export an API.  It is
> therefore not appropriate to document it in a section 9 man page.

I have to say I disagree. Often, in trying to debug one portion of the
kernel or another, it is VERY valuable to understand the inside of how
that portion of the kernel works. The 4.4 book is pretty old at this
point and was woefully incomplete.

Man pages explaining how things work -- even if they aren't kernel
APIs -- are very valuable. They give people a way to orient themselves
when trying to figure out a portion of the system they've never looked
at before.

Even though tmpfs or ufs or what have you aren't things we call via
APIs, I think it is reasonable to have man pages explaining the
general structure of how things work. It saves ever so much time.

Surely you don't think less documentation is better than more?

Perry