From owner-freebsd-doc@FreeBSD.ORG Fri May 16 13:24:18 2003 Return-Path: Delivered-To: freebsd-doc@freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 5447A37B401; Fri, 16 May 2003 13:24:18 -0700 (PDT) Received: from pittgoth.com (14.zlnp1.xdsl.nauticom.net [209.195.149.111]) by mx1.FreeBSD.org (Postfix) with ESMTP id 2DFC643F85; Fri, 16 May 2003 13:24:17 -0700 (PDT) (envelope-from trhodes@FreeBSD.org) Received: from mobile.pittgoth.com (acs-24-154-229-196.zoominternet.net [24.154.229.196]) by pittgoth.com (8.12.9/8.12.9) with SMTP id h4GKOFka001580; Fri, 16 May 2003 16:24:16 -0400 (EDT) (envelope-from trhodes@FreeBSD.org) Date: Fri, 16 May 2003 16:19:06 -0400 From: Tom Rhodes To: Hiten Pandya Message-Id: <20030516161906.5f75c31e.trhodes@FreeBSD.org> In-Reply-To: <20030516201805.GA34240@perrin.int.nxad.com> References: <200305161127.h4GBR0QJ013946@freefall.freebsd.org> <20030516114541.26131d4f.trhodes@FreeBSD.org> <20030516175320.GA91137@intruder.bmah.org> <20030516155637.668d03e0.trhodes@FreeBSD.org> <20030516201805.GA34240@perrin.int.nxad.com> X-Mailer: Sylpheed version 0.8.10claws (GTK+ 1.2.10; i386-portbld-freebsd5.1) Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit cc: bmah@FreeBSD.org cc: freebsd-doc@FreeBSD.org Subject: Re: docs/39214: No my(4) man page X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 16 May 2003 20:24:18 -0000 On Fri, 16 May 2003 13:18:05 -0700 Hiten Pandya wrote: > On Fri, May 16, 2003 at 03:56:37PM -0400, Tom Rhodes wrote: > > Oh, we're doing *real* nitpicks? Well then, I might as well chime in > > here then! Below I've listed several comments. > > > > > > The > > .Nm > > driver will probe for a Myson chip, check the PCI vendor and device IDs > > against our list of supported devices, and return a device name if we find a match. > > If a device is located > > > > [ ... snip ...] > > Tom, this stuff is implementation details which are unwated. > Well, maybe I could put it in my(4) IMPLEMENTATION NOTES, but I > highly doubt it will be of use to anyone since these steps are > taken by just about any network driver, and should go to a more > generic place. That would be fine. Personally, I think manual pages should be as descriptive as possible without being redundant. The IMPLEMENTATION NOTES would be fine. If you do a cut'n paste, please do an s/BPF/bpf which I noticed after I sent the email. > > > - Another thing you could do, to expand on the page a > > little bit is add a .Sh FILES section and list the two files: > > > > .Pa /usr/src/sys/dev/my/if_my.c > > and > > .Pa /usr/src/sys/dev/my/if_myreg.h > > > > and add a small description of them. > > Ok, a FILES section sounds a like a good idea. 8-) > > > - ifmedia (used in the above list) could use a manual page, I've got a > > WIP for this. Actually, I have many WIPs, but I need time to get them > > reviewed before the patches are applied. > > Send 'em over to me. Some people can't thank me enough for my > delegation skills. 8-) Oh you don't want them! Trust me. :) > > > - This email was not ment to be so long... > Take care Hiten, thanks for all your work! -- Tom Rhodes