From owner-freebsd-doc@FreeBSD.ORG Sat May 17 10:25:55 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 E9CDC37B401; Sat, 17 May 2003 10:25:55 -0700 (PDT) Received: from perrin.int.nxad.com (internal.ext.nxad.com [69.1.70.251]) by mx1.FreeBSD.org (Postfix) with ESMTP id 41D4B43FA3; Sat, 17 May 2003 10:25:53 -0700 (PDT) (envelope-from hmp@perrin.int.nxad.com) Received: by perrin.int.nxad.com (Postfix, from userid 1072) id 8AD7D20F01; Sat, 17 May 2003 10:25:52 -0700 (PDT) Date: Sat, 17 May 2003 10:25:52 -0700 From: Hiten Pandya To: Tom Rhodes Message-ID: <20030517172552.GA2910@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> <20030517050417.GA20807@gothmog.gr> <20030517121245.2ede0da9.trhodes@FreeBSD.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20030517121245.2ede0da9.trhodes@FreeBSD.org> X-Operating-System: FreeBSD FreeBSD 4.7-STABLE User-Agent: Mutt/1.5.4i cc: freebsd-doc@FreeBSD.org cc: mdoc officer Ruslan cc: Giorgos Keramidas 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: Sat, 17 May 2003 17:25:56 -0000 On Sat, May 17, 2003 at 12:12:45PM -0400, Tom Rhodes wrote: > On Sat, 17 May 2003 08:04:17 +0300 > Giorgos Keramidas wrote: > > > On 2003-05-16 13:18, Hiten Pandya wrote: > > >On Fri, May 16, 2003 at 03:56:37PM -0400, Tom Rhodes wrote: > > >> - 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-) > > > > I'm not sure, but it's your work so don't let me stop you from doing > > useful things. The only manpages in section 4 that mention files > > under /usr/src are vlan.4 and vinum.4. Drivers aren't very likely to > > move around in the tree but I don't feel very comfortable with paths > > being hardwired in manpages unless it's absolutely unavoidable. > > > > You should probably ask DES, Ruslan, Bruce Evans or another experienced > > src-hacker before doing this. > > > > /me puts Ruslan mask on. > > [ snip } > Thus Giorgos is correct in this notion. > Right, I thought about it after sending the mail and browsing some well know man pages, like fxp(4) and xl(4), and since I couldn't find any decent man page with a FILES section in section 4, I just dropped the idea, also, it saved me the time of the whole Review-Change-GoBackToStep1 process. 8-) Cheers! -- Hiten (hmp@FreeBSD.ORG)