Date: Mon, 10 Mar 2003 12:53:00 +0200 From: Sheldon Hearn <sheldonh@starjuice.net> To: Tom Rhodes <trhodes@FreeBSD.org> Cc: "M. Warner Losh" <imp@bsdimp.com>, dwmalone@FreeBSD.org, src-committers@FreeBSD.org, cvs-src@FreeBSD.org, cvs-all@FreeBSD.org Subject: Re: cvs commit: src/sys/dev/kbd kbd.c Message-ID: <20030310105300.GD12316@starjuice.net> In-Reply-To: <20030309225156.7c1ecc11.trhodes@FreeBSD.org> References: <200303092249.h29Mnma3080700@repoman.freebsd.org> <20030309.172900.25160079.imp@bsdimp.com> <20030309225156.7c1ecc11.trhodes@FreeBSD.org>
next in thread | previous in thread | raw e-mail | index | archive | help
On (2003/03/09 22:51), Tom Rhodes wrote:
> > I seem to recall objecting to this in the past. If you have ddb
> > enabled, then this sysctl is useless.... This fact should at least be
> > documented. As should this sysctl...
>
> Many tunables need documented, its something I've been looking
> over. Perhaps a manual page with all the tunables, or a doc in
> /usr/share, not sure yet.
We've argued about this a lot in the past, and I remember the outcome
being as follows from the last time, where I tried and failed:
a) Tunables are not documented well enough.
b) A sensible place for the source of such documentation to exist, is
alongside the declarations of the tunables.
c) Our tunable declaration mechanism in the source _already_ supports
a field for documentation.
d) The most thorough (and likely to stay consistent) approach is to
1) modify the kernel and modules build to include the contents of
this documentation field in generated objects,
2) at the end of a build, extract this text from generated objects,
and
3) compile the text into a documentation source file, like an mdoc
file or fragment.
There are all sorts of difficult details involved here, certainly enough
to derail me torward the end of my high-energy stint. I even deleted my
WIP.
You, on the other hand, have demonstrated remarkably high energy levels
when it comes to your work for FreeBSD, and I'm willing to bet you're
tenacious enough to see it through. :-)
Good luck!
Ciao,
Sheldon.
To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030310105300.GD12316>