Subject: Re: CVS commit: src/sys/fs/tmpfs
To: Perry E. Metzger <perry@piermont.com>
From: Julio M. Merino Vidal <jmmv84@gmail.com>
List: source-changes
Date: 09/13/2005 16:02:29
On 9/13/05, Perry E. Metzger <perry@piermont.com> wrote:
>=20
> YAMAMOTO Takashi <yamt@mwd.biglobe.ne.jp> writes:
> > it makes sense for interface descriptions like vnode(9).
> > and it might make sense for high-level design explanation.
> >
> > however, in this case, what we are talking about are merely
> > implementation details.
> > IMO, having comments near the code is better,
> > especially for immature and changing code like this.
>=20
> We can always do both. :)
>=20
> I tend to agree that it is necessary to have the comments in the code
> as well.

Hmm... I initially had all the comments in the source files.  But while
writing the manual page, I removed them from there to avoid redundancy.
The comments left in the code are those that do not fit the manual page.
Sure, we can do both, but that means duplicates :-/

Maybe the manual page currently has too many details (like describing
each field of each structure), but if this information is not there, it is
difficult to explain general concepts.

--=20
Julio M. Merino Vidal <jmmv84@gmail.com>
http://www.livejournal.com/users/jmmv/
The NetBSD Project - http://www.NetBSD.org/