Source-Changes archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

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



On Tue, Sep 13, 2005 at 04:02:29PM +0200, Julio M. Merino Vidal wrote:
> 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.

This is exactly the wrong way to handle it. The code should contain
as much details on implementation details as possible. The manpage
should not be the primary information source - I'd be quite
annoyed if I had to continually refer to the manpage while
trying to read and understand the code.

Jaromir
-- 
Jaromir Dolecek <jdolecek%NetBSD.org@localhost>            http://www.NetBSD.cz/
-=- We can walk our road together if our goals are all the same;     -=-
-=- We can run alone and free if we pursue a different aim.          -=-



Home | Main Index | Thread Index | Old Index