From owner-freebsd-current  Fri Feb 21  7:24:17 2003
Delivered-To: freebsd-current@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP
	id 5729537B401; Fri, 21 Feb 2003 07:24:15 -0800 (PST)
Received: from centaur.acm.jhu.edu (centaur.acm.jhu.edu [128.220.223.65])
	by mx1.FreeBSD.org (Postfix) with ESMTP
	id 8DB4843FBD; Fri, 21 Feb 2003 07:24:14 -0800 (PST)
	(envelope-from jflemer@acm.jhu.edu)
Received: by centaur.acm.jhu.edu (Postfix, from userid 556)
	id 5AAEE13E9A; Fri, 21 Feb 2003 10:24:13 -0500 (EST)
Received: from localhost (localhost [127.0.0.1])
	by centaur.acm.jhu.edu (Postfix) with ESMTP
	id 59DBB37E08; Fri, 21 Feb 2003 10:24:13 -0500 (EST)
Date: Fri, 21 Feb 2003 10:24:13 -0500 (EST)
From: "James E. Flemer" <jflemer@acm.jhu.edu>
Reply-To: "James E. Flemer" <jflemer@acm.jhu.edu>
To: Ruslan Ermilov <ru@freebsd.org>
Cc: Tom Rhodes <trhodes@freebsd.org>, <current@freebsd.org>
Subject: Re: cvs commit: src/share/man/man4 Makefile
In-Reply-To: <20030221120132.GB30966@sunbay.com>
Message-ID: <Pine.LNX.4.33L2.0302211006500.22240-100000@centaur.acm.jhu.edu>
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII
Sender: owner-freebsd-current@FreeBSD.ORG
Precedence: bulk
List-ID: <freebsd-current.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20freebsd-current>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20freebsd-current>
X-Loop: FreeBSD.ORG

On Fri, 21 Feb 2003, Ruslan Ermilov wrote:

> On Sat, Feb 15, 2003 at 02:28:34PM -0800, Tom Rhodes wrote:
> > trhodes     2003/02/15 14:28:34 PST
> >
> >   Modified files:
> >     share/man/man4       Makefile
> >   Log:
> >   Link several of the if_* modules to their respected manual pages.
> >
> >   Revision  Changes    Path
> >   1.190     +40 -0     src/share/man/man4/Makefile
> >
> Hmm, if we really want this, mdoc(7) rules say that we should also
> add "if_*"'s to the NAME sections of all affected manpages, e.g.:
>
--snip patch--
>
> But my personal opinion on this change is that it is unnecessary.
> The "if_*" convention on calling network interface modules is an
> internal implementation detail, and only to allow ifconfig(8) to
> automatically load driver modules.
>
> Any other opinions?

Well for those who know the convention its fine to leave as
is, but I could see how it might be useful for someone new
to FreeBSD to be able to do a 'whatis' on the modules:

# whatis ciss
ciss(4) ...
# whatis aio
aio(4) ...
aio_waitcomplete(2) ...
# whatis if_kue
if_kue: nothing appropriate
# apropos if_kue
if_kue: nothing appropriate
# whatis exca
exca: nothing appropriate

There are some non-if_* modules in there now that seem to
be only documented in /usr/src, exca is a good example.

-James



To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-current" in the body of the message