From owner-freebsd-doc@FreeBSD.ORG  Sat May 17 09:18:06 2003
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
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 1CA6C37B401; Sat, 17 May 2003 09:18:06 -0700 (PDT)
Received: from pittgoth.com (14.zlnp1.xdsl.nauticom.net [209.195.149.111])
	by mx1.FreeBSD.org (Postfix) with ESMTP
	id F3F2043FAF; Sat, 17 May 2003 09:18:02 -0700 (PDT)
	(envelope-from trhodes@FreeBSD.org)
Received: from mobile.pittgoth.com (acs-24-154-229-196.zoominternet.net
	[24.154.229.196])
	by pittgoth.com (8.12.9/8.12.9) with SMTP id h4HGI1ka006662;
	Sat, 17 May 2003 12:18:01 -0400 (EDT)
	(envelope-from trhodes@FreeBSD.org)
Date: Sat, 17 May 2003 12:12:45 -0400
From: Tom Rhodes <trhodes@FreeBSD.org>
To: Giorgos Keramidas <keramida@FreeBSD.org>
Message-Id: <20030517121245.2ede0da9.trhodes@FreeBSD.org>
In-Reply-To: <20030517050417.GA20807@gothmog.gr>
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>
X-Mailer: Sylpheed version 0.8.10claws (GTK+ 1.2.10; i386-portbld-freebsd5.1)
Mime-Version: 1.0
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 7bit
cc: hmp@FreeBSD.org
cc: freebsd-doc@FreeBSD.org
cc: mdoc officer Ruslan <ru@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 <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
	<mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Sat, 17 May 2003 16:18:06 -0000

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.

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.

Take care, 

--
Tom Rhodes