Date: Fri, 21 Feb 2003 10:24:13 -0500 (EST) From: "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 Message-ID: <Pine.LNX.4.33L2.0302211006500.22240-100000@centaur.acm.jhu.edu> In-Reply-To: <20030221120132.GB30966@sunbay.com>
next in thread | previous in thread | raw e-mail | index | archive | help
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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?Pine.LNX.4.33L2.0302211006500.22240-100000>