Subject: Re: CVS commit: src/sys/fs/tmpfs
To: None <jmmv84@gmail.com>
From: Perry E. Metzger <perry@piermont.com>
List: source-changes
Date: 09/13/2005 09:37:01
"Julio M. Merino Vidal" <jmmv84@gmail.com> writes:
> On 9/13/05, YAMAMOTO Takashi <yamt@mwd.biglobe.ne.jp> wrote:
>> > Please add a little description of the new tp_name field into tmpfs.9.
>> 
>> having a manpage to describe the code looks a little weird to me.
>> why not to comment on the code itsself?
>
> I started this manual page to explain how tmpfs works overall, the
> design decisions taken in its development, etc.  And in order to explain
> many things, I had to detail its structures.  I think it can work well, as it
> can explain many more things than a single comment in the file...
>
> 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.

Perry