docs/39214: No my(4) man page

mdoc officer Ruslan ru at FreeBSD.org
Sat May 17 23:13:40 UTC 2003


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 at freebsd.org> wrote:
> 
> > On 2003-05-16 13:18, Hiten Pandya <hmp at 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.
> 
> According to mdoc(7):
> 
> 	    \" This next command is for sections 1, 6, 7 and 8 only.
>            .\" .Sh ENVIRONMENT
>            .\" .Sh FILES
>            .\" .Sh EXAMPLES
> 
> Thus Giorgos is correct in this notion.
> 
> /me removes Ruslan mask.
> 
"This next command" refers to the ".Sh ENVIRONMENT" only;
".Sh FILES" can be legally used in section 4.

Ruslan takes his mask back.  ;)


Cheers,
-- 
Ruslan Ermilov		Sysadmin and DBA,
ru at sunbay.com		Sunbay Software AG,
ru at FreeBSD.org		FreeBSD committer,
+380.652.512.251	Simferopol, Ukraine

http://www.FreeBSD.org	The Power To Serve
http://www.oracle.com	Enabling The Information Age
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20030518/58e2bffe/attachment.sig>


More information about the freebsd-doc mailing list