Subject: Re: section 9 man pages
To: None <perry@piermont.com>
From: Jason Thorpe <thorpej@nas.nasa.gov>
List: current-users
Date: 12/19/1995 08:47:51
On Tue, 19 Dec 1995 11:22:57 -0500
"Perry E. Metzger" <perry@piermont.com> wrote:
> SHUTDOWNHOOK_ESTABLISH(9NetBSD Kernel Internals ManuaSHUTDOWNHOOK_ESTABLISH(9)
>
> Do people think this is enough of a problem to merit chopping it to
> the much less descriptive "Kernel Manual" or "Internals Manual" from
> "Kernel Internals Manual"? Or should we live with it? Or should we
> pick shorter names for our man pages?
Well, then you might consider a shorter name. I'm not sure how we can
really avoid the long manpage names if that's really the name of the
function :-)
Shutdown hooks aren't the only ones. Typically, interrupt hook routines
have long names (like vmeintr_establish()). The sparc also has the
`bootpath' functions (like bootpath_restore()) that are worth documenting.
Long function names just come with the territory (in the kernel, anyhow),
and changing the names of the manpages doesn't really seem like an
appropriate way to deal with them :-)
--------------------------------------------------------------------------
Jason R. Thorpe thorpej@nas.nasa.gov
NASA Ames Research Center Home: 408.866.1912
NAS: M/S 258-6 Work: 415.604.0935
Moffett Field, CA 94035 Pager: 415.428.6939