Skip site navigation (1)Skip section navigation (2)
Date:      Sun, 18 May 2003 02:13:33 +0300
From:      mdoc officer Ruslan <ru@FreeBSD.org>
To:        Tom Rhodes <trhodes@FreeBSD.org>
Cc:        Giorgos Keramidas <keramida@FreeBSD.org>
Subject:   Re: docs/39214: No my(4) man page
Message-ID:  <20030517231333.GB12759@sunbay.com>
In-Reply-To: <20030517121245.2ede0da9.trhodes@FreeBSD.org>
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>

next in thread | previous in thread | raw e-mail | index | archive | help

--ZoaI/ZTpAVc4A5k6
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

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:
>=20
> > 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-)
> >=20
> > 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.
> >=20
> > You should probably ask DES, Ruslan, Bruce Evans or another experienced
> > src-hacker before doing this.
> >=20
>=20
> /me puts Ruslan mask on.
>=20
> According to mdoc(7):
>=20
> 	    \" This next command is for sections 1, 6, 7 and 8 only.
>            .\" .Sh ENVIRONMENT
>            .\" .Sh FILES
>            .\" .Sh EXAMPLES
>=20
> Thus Giorgos is correct in this notion.
>=20
> /me removes Ruslan mask.
>=20
"This next command" refers to the ".Sh ENVIRONMENT" only;
".Sh FILES" can be legally used in section 4.

Ruslan takes his mask back.  ;)


Cheers,
--=20
Ruslan Ermilov		Sysadmin and DBA,
ru@sunbay.com		Sunbay Software AG,
ru@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

--ZoaI/ZTpAVc4A5k6
Content-Type: application/pgp-signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.1 (FreeBSD)

iD8DBQE+xsIdUkv4P6juNwoRAmkDAJ46uTf0D+FwKlmAdPBwaMHSVHEigwCeMTiD
bMXjMGjHpdT8Y0yQBadpiog=
=4Fv5
-----END PGP SIGNATURE-----

--ZoaI/ZTpAVc4A5k6--



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20030517231333.GB12759>