From owner-freebsd-doc@FreeBSD.ORG Fri May 16 13:18:10 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 68D2637B401; Fri, 16 May 2003 13:18:08 -0700 (PDT) Received: from perrin.int.nxad.com (internal.ext.nxad.com [69.1.70.251]) by mx1.FreeBSD.org (Postfix) with ESMTP id 0A23D43FCB; Fri, 16 May 2003 13:18:07 -0700 (PDT) (envelope-from hmp@perrin.int.nxad.com) Received: by perrin.int.nxad.com (Postfix, from userid 1072) id E21E92105F; Fri, 16 May 2003 13:18:05 -0700 (PDT) Date: Fri, 16 May 2003 13:18:05 -0700 From: Hiten Pandya To: Tom Rhodes Message-ID: <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> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20030516155637.668d03e0.trhodes@FreeBSD.org> User-Agent: Mutt/1.4i X-Operating-System: FreeBSD FreeBSD 4.7-STABLE cc: "Bruce A. Mah" 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:18:10 -0000 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. > > > - My(4) at the top. This should be MY like many (if not all) of our > driver manual pages (e.g: dc, fxp, miibus, smapi, etc.). > > - Can we rephrase under NAME? Perhaps PCI Ethernet Driver? It sounds > better when read aloud. Ok, this is just the stupid ascii text copy is not updated, my fault again. I really need to get some sleep; been working on man pages and Problem Reports since yesterday without sleep. > - Something must not have parsed correctly under DESCRIPTION: > The driver provides ... > Could you double check that please? I would rather it say something > like The .Nm driver provides ... (with applicable spaces of course). Done. > > - Under AUTHORS you have 'Myson Technology.' but in NAME you have 'Myson > Technologies', and I'm going to assume that the 'Technologies' is the > correct one. Myson Technology is the right one. > > - Under DESCRIPTION you could put something like: > > 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. > - 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-) > - This email was not ment to be so long... Cheers! -- Hiten (hmp@FreeBSD.ORG)