Source-Changes-D archive

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

Re: CVS commit: src

On Thu, Mar 25, 2010 at 04:42:10PM +0000, Andrew Doran wrote:
 > > Well wouldn't it then be better to document that "they are not of
 > > any use to the general kernel"? From a quick look around, I see
 > > also quite a few instances of stathz and profhz being
 > > used/defined.
 > What Joerg said.  They are low level kernel implementation details.  These
 > belong in a book or article or a wiki page or something, not the manual.

We just went around on this like two or three weeks ago on spl
internals. On the one hand, the man page should document the
interface, not the implementation; on the other hand, anything global
someone might run across while debugging or rototilling should be
documented. The resolution the last time was to document the internals
in a different man page. (And if we weren't out of man sections, it
would seem like a good section distinction: kernel interfaces
vs. kernel internals...)

David A. Holland

Home | Main Index | Thread Index | Old Index