Date: Thu, 24 Jun 1999 00:53:42 -0500 (CDT) From: Mike Pritchard <mpp@mpp.pro-ns.net> To: jesus.monroy@usa.net (Jesus Monroy) Cc: doc@FreeBSD.ORG, advocacy@FreeBSD.ORG Subject: Re: Survey: online documentation 15% incorrect Message-ID: <199906240553.AAA14021@mpp.pro-ns.net> In-Reply-To: <19990623133428.22679.qmail@nwcst323.netaddress.usa.net> from Jesus Monroy at "Jun 23, 1999 06:34:28 am"
next in thread | previous in thread | raw e-mail | index | archive | help
> Document: Documentation errors in FreeBSD > Run Date: 6/17/99 > Description: The following is a listing of incomplete, ambigous or > failed references for FreeBSD using whatit(1) and man(1). > This survey was conducted using FreeBSD 3.1. > > A complete Listing can be found at: > http://www.geocities.com/SiliconValley/Hub/8031/psuedo-indicators/fbsdutils.html > > Score: > directory no reference ambigous reference other total available > /bin 0 1 1 2 32 > /sbin 8 5 0 13 82 > /usr/bin 42 33 0 75 394 > /usr/sbin 8 7 2 17 183 > ---- ---- > total total 107 691 > > Final Score 107.0/691.0 = 0.1548 (15.5%) I took a look through this list and by my count only about 55 of the references are bogus or incorrect or ambiguous. A number of them in your list are producing exactly what they should be. Some others have been fixed in -current already. There are a handful of man pages with links to other man pages that do not show the links in the NAME/SYSNOPSIS section. I'm going to go fix the easy ones right now. A number of man pages/commands are links for historical names for commands, which have been replaced by new/GNU replacements and the man pages reflect the updated versions, not the historical name for the command. These should probably be fixed, too. 'man cc' is a good example. You get what you need - the gcc man page. I've never been sure what we should do with these. One interesting problem your survery points out is that whatis/makewhatis get confused about inetd.conf and inetd. It lists them both as section 5 man pages, when only inetd is section 8. This is because the inetd Makefile MLINKS inetd.8 to inetd.conf.5. There are probably a few other commands that might be doing this. I'll have to look at this closer. Then there are the commands without manual pages, which is just plain wrong. -- Mike Pritchard mpp@FreeBSD.ORG or mpp@mpp.pro-ns.net To Unsubscribe: send mail to majordomo@FreeBSD.org with "unsubscribe freebsd-advocacy" in the body of the message
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?199906240553.AAA14021>