Date: Sat, 17 May 2003 14:41:30 -0400 From: Tom Rhodes <trhodes@FreeBSD.org> To: freebsd-doc@FreeBSD.org Subject: Re: docs/39214: No my(4) man page Message-ID: <20030517144130.62b4f7ff.trhodes@FreeBSD.org> In-Reply-To: <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> <20030517172552.GA2910@perrin.int.nxad.com>
next in thread | previous in thread | raw e-mail | index | archive | help
On Sat, 17 May 2003 10:25:52 -0700 Hiten Pandya <hmp@freebsd.org> wrote: > On Sat, May 17, 2003 at 12:12:45PM -0400, Tom Rhodes wrote: > > On Sat, 17 May 2003 08:04:17 +0300 > > Giorgos Keramidas <keramida@freebsd.org> wrote: > > > > > On 2003-05-16 13:18, Hiten Pandya <hmp@freebsd.org> 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-) > Are you not supposed to be on yahoo right now?! -- Tom Rhodes
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030517144130.62b4f7ff.trhodes>