From owner-cvs-all Wed May 30 15:51:13 2001 Delivered-To: cvs-all@freebsd.org Received: from lists01.iafrica.com (lists01.iafrica.com [196.7.0.141]) by hub.freebsd.org (Postfix) with ESMTP id 7270D37B422; Wed, 30 May 2001 15:51:05 -0700 (PDT) (envelope-from sheldonh@uunet.co.za) Received: from nwl.fw.uunet.co.za ([196.31.2.162]) by lists01.iafrica.com with esmtp (Exim 3.12 #2) id 155Ens-00071J-00; Thu, 31 May 2001 00:51:00 +0200 Received: (from nobody@localhost) by nwl.fw.uunet.co.za (8.8.8/8.6.9) id AAA16161; Thu, 31 May 2001 00:50:58 +0200 (SAST) Received: by nwl.fw.uunet.co.za via recvmail id 16142; Thu May 31 00:50:27 2001 Received: from sheldonh (helo=axl.fw.uunet.co.za) by axl.fw.uunet.co.za with local-esmtp (Exim 3.22 #1) id 155EnK-0006aS-00; Thu, 31 May 2001 00:50:26 +0200 From: Sheldon Hearn To: Jesper Skriver Cc: Greg Lehey , Dima Dorfman , cvs-committers@freebsd.org, cvs-all@freebsd.org Subject: Re: Documenting sysctls (was: cvs commit: src/sbin/sysctl sysctl.8) In-reply-to: Your message of "Thu, 31 May 2001 00:39:43 +0200." <20010531003943.E78414@skriver.dk> Date: Thu, 31 May 2001 00:50:26 +0200 Message-ID: <25323.991263026@axl.fw.uunet.co.za> Sender: owner-cvs-all@FreeBSD.ORG Precedence: bulk List-ID: List-Archive: (Web Archive) List-Help: (List Instructions) List-Subscribe: List-Unsubscribe: X-Loop: FreeBSD.ORG 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: 1) Document all the sysctls in one place so they're easy to find. 2) Document each sysctl in the documentation for the device that it controls. The second option is great for thorough documentation, because it means that the description can rely on the surrounding text of the manual page. The problem is that not all sysctl's belong to a specific device. 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). Ciao, Sheldon. To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe cvs-all" in the body of the message