Date: Thu, 31 May 2001 15:11:12 +1000 From: Peter Jeremy <peter.jeremy@alcatel.com.au> To: Sheldon Hearn <sheldonh@starjuice.net> Cc: Jesper Skriver <jesper@skriver.dk>, Greg Lehey <grog@FreeBSD.ORG>, Dima Dorfman <dd@FreeBSD.ORG>, cvs-committers@FreeBSD.ORG, cvs-all@FreeBSD.ORG Subject: Re: Documenting sysctls (was: cvs commit: src/sbin/sysctl sysctl.8) Message-ID: <20010531151112.A26747@gsmx07.alcatel.com.au> In-Reply-To: <25323.991263026@axl.fw.uunet.co.za>; from sheldonh@starjuice.net on Thu, May 31, 2001 at 12:50:26AM %2B0200 References: <20010531003943.E78414@skriver.dk> <25323.991263026@axl.fw.uunet.co.za>
next in thread | previous in thread | raw e-mail | index | archive | help
On 2001-May-31 00:50:26 +0200, Sheldon Hearn <sheldonh@starjuice.net> wrote: >On Thu, 31 May 2001 00:39:43 +0200, Jesper Skriver wrote: >> If we can agree it's in sysctl(8) it should be, I'll start with >> the net.inet ones, apart from the net.inet.tcp ones which are in tcp(4) > >Last time this came up, there were two schools of thought: Note that there is also provision for a description in the sysctl definitions in the source code. This probably isn't the best place for a detailed description, but would be good for a 1-line summary. The descriptions can be extracted either by a tool that greps them out of the source code, or by compiling them into an ELF segment that isn't loaded. (I've had a go at the latter, but couldn't get the linker description correct). It would be nice if the sysctl descriptions in the man pages could be automatically built from the sysctl descriptions in the source, but I suspect this would be non-trivial to implement. >I think a balance can be struck, where sysctls that belong to a device >are documented in the documentation for that device, while sysctls that >don't can be documented in sysctl(8) (or some other common place). I agree with Brooks Davis that it would be nice if sysctl(8) [or whatever] at least had pointers to where other hierarchies were described. Peter 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?20010531151112.A26747>