From owner-cvs-all Wed Nov 6 1:10:49 2002 Delivered-To: cvs-all@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id B4BDD37B401; Wed, 6 Nov 2002 01:10:48 -0800 (PST) Received: from dragon.nuxi.com (trang.nuxi.com [66.92.13.169]) by mx1.FreeBSD.org (Postfix) with ESMTP id 3B2FF43E6E; Wed, 6 Nov 2002 01:10:48 -0800 (PST) (envelope-from obrien@NUXI.com) Received: from dragon.nuxi.com (obrien@localhost [127.0.0.1]) by dragon.nuxi.com (8.12.6/8.12.2) with ESMTP id gA69AlCE000677; Wed, 6 Nov 2002 01:10:47 -0800 (PST) (envelope-from obrien@dragon.nuxi.com) Received: (from obrien@localhost) by dragon.nuxi.com (8.12.6/8.12.6/Submit) id gA699WqH000575; Wed, 6 Nov 2002 01:09:32 -0800 (PST) Date: Wed, 6 Nov 2002 01:09:32 -0800 From: "David O'Brien" To: Mike Silbersack Cc: Tom Rhodes , cvs-committers@FreeBSD.ORG, cvs-all@FreeBSD.ORG Subject: Re: cvs commit: src/share/man/man4 rl.4 Message-ID: <20021106090932.GA530@dragon.nuxi.com> Reply-To: obrien@FreeBSD.ORG Mail-Followup-To: David O'Brien , Mike Silbersack , Tom Rhodes , cvs-committers@FreeBSD.ORG, cvs-all@FreeBSD.ORG References: <20021106082857.GB14415@rot13.obsecurity.org> <20021106030005.O90236-100000@patrocles.silby.com> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20021106030005.O90236-100000@patrocles.silby.com> User-Agent: Mutt/1.4i X-Operating-System: FreeBSD 5.0-CURRENT Organization: The NUXI BSD Group X-Pgp-Rsa-Fingerprint: B7 4D 3E E9 11 39 5F A3 90 76 5D 69 58 D9 98 7A X-Pgp-Rsa-Keyid: 1024/34F9F9D5 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 Wed, Nov 06, 2002 at 03:10:33AM -0600, Mike Silbersack wrote: > I think this brings up a question of how we want our manpages focused... > looking over the common ethernet driver manpages, it's clear that Bill's > the only person who lists chipset bugs in the BUGS section of manpages. > Although there are bugs with fxp, vr, and (most recently) bge, there are > no man page comments relating to these issues. > > I think it might be in our best interests to move the sections to comments > in source code in cases where the bug in question has been worked around > and is not an issue for the user. I totally disagree. I often read the manpages when deciding if a NIC is a good choice to use or not. The insight Bill's comments give in the easy to find and read documentation is invaluable. More driver writers should convey this good information in their manpages. To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe cvs-all" in the body of the message