From owner-cvs-all  Wed Nov  6  1: 4:45 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 3225C37B401; Wed,  6 Nov 2002 01:04:44 -0800 (PST)
Received: from out2.mx.nwbl.wi.voyager.net (out2.mx.nwbl.wi.voyager.net [169.207.3.120])
	by mx1.FreeBSD.org (Postfix) with ESMTP
	id AFB6B43E75; Wed,  6 Nov 2002 01:04:43 -0800 (PST)
	(envelope-from silby@silby.com)
Received: from [10.1.1.6] (d150.as7.nwbl0.wi.voyager.net [169.207.130.88])
	by out2.mx.nwbl.wi.voyager.net (Postfix) with ESMTP
	id 1418B29DD4; Wed,  6 Nov 2002 03:04:36 -0600 (CST)
Date: Wed, 6 Nov 2002 03:10:33 -0600 (CST)
From: Mike Silbersack <silby@silby.com>
To: Kris Kennaway <kris@obsecurity.org>
Cc: Tom Rhodes <trhodes@FreeBSD.ORG>, <cvs-committers@FreeBSD.ORG>,
	<cvs-all@FreeBSD.ORG>
Subject: Re: cvs commit: src/share/man/man4 rl.4
In-Reply-To: <20021106082857.GB14415@rot13.obsecurity.org>
Message-ID: <20021106030005.O90236-100000@patrocles.silby.com>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII
Sender: owner-cvs-all@FreeBSD.ORG
Precedence: bulk
List-ID: <cvs-all.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20cvs-all>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20cvs-all>
X-Loop: FreeBSD.ORG


On Wed, 6 Nov 2002, Kris Kennaway wrote:

> On Tue, Nov 05, 2002 at 07:53:08PM -0800, Tom Rhodes wrote:
> > trhodes     2002/11/05 19:53:08 PST
> >
> >   Modified files:
> >     share/man/man4       rl.4
> >   Log:
> >   Remove Realtek discriminating comments from the rl(4) manual page.
> >   This leaves us with 'just the facts'
>
> The realtek comments are one of the hidden treasures of the FreeBSD
> source code..I'd like to see them stay.
>
> Kris

In this case, the file in question is a manpage rather than a piece of
source code.  The source code remains unchanged (as it should be.)

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.

Mike "Silby" Silbersack


To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe cvs-all" in the body of the message