From owner-cvs-all Sun Jan 10 21:21:15 1999 Return-Path: Received: (from majordom@localhost) by hub.freebsd.org (8.8.8/8.8.8) id VAA06819 for cvs-all-outgoing; Sun, 10 Jan 1999 21:21:15 -0800 (PST) (envelope-from owner-cvs-all@FreeBSD.ORG) Received: from dingo.cdrom.com (castles351.castles.com [208.214.167.51]) by hub.freebsd.org (8.8.8/8.8.8) with ESMTP id VAA06814 for ; Sun, 10 Jan 1999 21:21:11 -0800 (PST) (envelope-from mike@dingo.cdrom.com) Received: from dingo.cdrom.com (LOCALHOST [127.0.0.1]) by dingo.cdrom.com (8.9.1/8.8.8) with ESMTP id VAA86539; Sun, 10 Jan 1999 21:17:20 -0800 (PST) (envelope-from mike@dingo.cdrom.com) Message-Id: <199901110517.VAA86539@dingo.cdrom.com> X-Mailer: exmh version 2.0.2 2/24/98 To: "Justin T. Gibbs" cc: Mike Smith , Brian Somers , committers@FreeBSD.ORG Subject: Re: sysctl descriptions In-reply-to: Your message of "Sun, 10 Jan 1999 22:04:47 MST." <199901110512.WAA18140@pluto.plutotech.com> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Date: Sun, 10 Jan 1999 21:17:19 -0800 From: Mike Smith Sender: owner-cvs-all@FreeBSD.ORG Precedence: bulk > >I have a driver for a new peripheral. It's from a vendor that doesn't > >want to distribute source code, so the driver comes as a KLD module. > >The driver has a number of tuning options, which are exposed via the > >sysctl MIB. > > > >Please explain how I am to find documentation for these tuning options > >in the system manpages. > > If the vendor didn't provide a manual for their object module then the > vendor sucks. *shrug* Maybe the vendor sucks. Maybe you don't have the documentation for any one of a hundred reasons. > >Suggest how your approach is better than, for > >example, being able to directly ascertain what it is that the tuning > >options do using the same tool that I plan to use to adjust them. > > I personally question this approach which, unless you intend to embed full > documentation for the sysctl variable in the kernel, will not adequately > describe the value or consequences of adjusting a given parameter. So I should remove all of the help for the bootloader commands, all of the help in userconfig, and all of the usage strings in all of the user-space commands? Come on, you know as well as I do the benefits of succinct descriptions of things; if I am trying to find something already knowing that it exists, and it has a stupid name (as many do), the extra hinting from the description is usually all I'll need to find it. -- \\ Sometimes you're ahead, \\ Mike Smith \\ sometimes you're behind. \\ mike@smith.net.au \\ The race is long, and in the \\ msmith@freebsd.org \\ end it's only with yourself. \\ msmith@cdrom.com To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe cvs-all" in the body of the message