Bug 14677

Summary: listing of (48) utilities in /bin:/sbin:/usr/bin:/usr/sbin without whatis(1) information
Product: Documentation Reporter: thepinkpages <thepinkpages>
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description thepinkpages 1999-11-03 05:00:01 UTC
The PR was submitted as
http://www.FreeBSD.org/cgi/query-pr.cgi?pr=12486
The PR clearly illustrates a number of failures in the 
man(8) documentation system.
Please note the list that follows, may not be the
same as PR=12486.

However, the PR fails to be reconginzed by the FreeBSD Project
This seems to stem for a personal vendeta of some type.
I'll quote the response:

How-To-Repeat: cat ~/bin/testMan.sh
#!/bin/sh
#
#  written by Jesus Monroy, Jr. (thepinkpages@email.com)
#  date: 1999.07.02
#  purpose: validate the base utilities whatis(1) entry
#
D="/bin /sbin /usr/bin /usr/sbin"

for DIR in $D ; do
    cd $DIR
    echo ----------
    echo $DIR
    echo ----------
    L=`ls -1`
    for U in $L; do
        R=`whatis $U | grep "nothing"`
        if [ X"$R" != X"" ] ; then
            echo $R
        fi
     done
done
Comment 1 chris 1999-11-03 05:35:08 UTC
On Tue, Nov 02, 1999, thepinkpages@email.com wrote:
> However, the PR fails to be reconginzed by the FreeBSD Project
> This seems to stem for a personal vendeta of some type.

   The reason for this is in your own report:

>  >The gist of my message is that you are full of bullshit, and that your
>  >PR is just as useless as your rants on -chat and -advocay.

>  ----------
>  /bin
>  ----------
>  [: nothing appropriate

   A man page exists.

>  red: nothing appropriate

   Here, too.

>  ----------
>  /sbin
>  ----------
>  fastboot: nothing appropriate
>  fasthalt: nothing appropriate

   And these.

>  init: nothing appropriate

   And here.

>  rdump: nothing appropriate
>  rrestore: nothing appropriate

   And here.

>  ----------
>  /usr/bin
>  ----------
>  CC: nothing appropriate

   This can be fixed.

>  bdes: nothing appropriate

   Man page exists.

>  byacc: nothing appropriate

   Man page exists.

>  c++filt: nothing appropriate

   This seems to be a link to gdb.  I'll look into it.  So far
you've actually found one really missing man page.

>  cc: nothing appropriate

   Your install is clearly broken.  This has had a man page
pretty much forever.

>  find2perl: nothing appropriate

   Two.

>  flex++: nothing appropriate

   Exists.

>  gdbreplay: nothing appropriate

   Here's one that actually doesn't have a man page.  It appears
to be part of binutils.

>  gensetdefs: nothing appropriate

   Man page seems to be in -CURRENT, it should be merged.

>  gprof4: nothing appropriate
>  gzcat: nothing appropriate

   These exist.

>  hoststat: nothing appropriate

   This appears to be a Sendmail thing.  Please contact them and
ask them to ship a man page for hoststat in their future
releases.

>  lex: nothing appropriate
>  lex++: nothing appropriate

   These exist.

>  makeinfo: nothing appropriate

   makeinfo is a Texinfo thing, and it has a Texinfo manual page.

   From here on, I will only quote the ones that are actually not
there.

>  miniperl: nothing appropriate

   miniperl is a perl thing.  The perl folks are responsible
here.

>  mk_cmds: nothing appropriate

   Here's another man page that's missing.  If you're
volunteering, you can write some of these man pages.

>  perl5.00503: nothing appropriate

   "man perl" should be fine for people who are not shell
scripts.

>  pod2latex: nothing appropriate
>  pod2text: nothing appropriate

   Perl people.

>  ptx: nothing appropriate

   Has info pages.  Wish they'd write man pages.

>  splain: nothing appropriate
>  suidperl: nothing appropriate

   Perl.

>  systags: nothing appropriate

   Contact the global people -- this is contributed software.

>  ----------
>  /usr/sbin
>  ----------
>  callbootd: nothing appropriate

   Another real case.  I'll look into it.

>  memcontrol: nothing appropriate

   Exists in -CURRENT.  I'll talk to Mike (the maintainer) and
merge it into -STABLE.  (I wrote the man page recently.)

>  named-bootconf: nothing appropriate
>  nsupdate: nothing appropriate

   BIND people, contributed software.

>  pmap_dump: nothing appropriate
>  pmap_set: nothing appropriate

   I'd have to look into these.

-- 
|Chris Costello <chris@calldei.com>
|To err is human; to forgive, beyond the scope of the Operating System.
`----------------------------------------------------------------------
Comment 2 chris freebsd_committer freebsd_triage 1999-11-03 05:39:40 UTC
Responsible Changed
From-To: freebsd-doc->chris

I'll take care of these. 

Comment 3 jessem 1999-11-03 05:52:11 UTC
Perhaps my report was not correct in it's content.
My subject line was correct. "..(48).. without whatis(1) information"

How would suggest I write this, so that it may be understood.
This may be a failing in my PR.

As for the PR, I'll followup on people (ie. bind/perl/sendmail people, et. al)
that should send in the appropriate fixes. I'd be happy to do this. :-)

For other things (ie. write manpages), my time is just too limited, sorry.

Lastly, Thanks for a civil response. My intent has always been
to be helpful, it's not always interpeted that way. :-)

                                  Regards.
                                  Jessem.


At 11:35 PM 11/2/99 -0600, Chris Costello wrote:
>On Tue, Nov 02, 1999, thepinkpages@email.com wrote:
>> However, the PR fails to be reconginzed by the FreeBSD Project
>> This seems to stem for a personal vendeta of some type.
>
>   The reason for this is in your own report:
>
>>  >The gist of my message is that you are full of bullshit, and that your
>>  >PR is just as useless as your rants on -chat and -advocay.
>
>>  ----------
>>  /bin
>>  ----------
>>  [: nothing appropriate
>
>   A man page exists.
>
>>  red: nothing appropriate
>
>   Here, too.
>
>>  ----------
>>  /sbin
>>  ----------
>>  fastboot: nothing appropriate
>>  fasthalt: nothing appropriate
>
>   And these.
>
>>  init: nothing appropriate
>
>   And here.
>
>>  rdump: nothing appropriate
>>  rrestore: nothing appropriate
>
>   And here.
>
>>  ----------
>>  /usr/bin
>>  ----------
>>  CC: nothing appropriate
>
>   This can be fixed.
>
>>  bdes: nothing appropriate
>
>   Man page exists.
>
>>  byacc: nothing appropriate
>
>   Man page exists.
>
>>  c++filt: nothing appropriate
>
>   This seems to be a link to gdb.  I'll look into it.  So far
>you've actually found one really missing man page.
>
>>  cc: nothing appropriate
>
>   Your install is clearly broken.  This has had a man page
>pretty much forever.
>
>>  find2perl: nothing appropriate
>
>   Two.
>
>>  flex++: nothing appropriate
>
>   Exists.
>
>>  gdbreplay: nothing appropriate
>
>   Here's one that actually doesn't have a man page.  It appears
>to be part of binutils.
>
>>  gensetdefs: nothing appropriate
>
>   Man page seems to be in -CURRENT, it should be merged.
>
>>  gprof4: nothing appropriate
>>  gzcat: nothing appropriate
>
>   These exist.
>
>>  hoststat: nothing appropriate
>
>   This appears to be a Sendmail thing.  Please contact them and
>ask them to ship a man page for hoststat in their future
>releases.
>
>>  lex: nothing appropriate
>>  lex++: nothing appropriate
>
>   These exist.
>
>>  makeinfo: nothing appropriate
>
>   makeinfo is a Texinfo thing, and it has a Texinfo manual page.
>
>   From here on, I will only quote the ones that are actually not
>there.
>
>>  miniperl: nothing appropriate
>
>   miniperl is a perl thing.  The perl folks are responsible
>here.
>
>>  mk_cmds: nothing appropriate
>
>   Here's another man page that's missing.  If you're
>volunteering, you can write some of these man pages.
>
>>  perl5.00503: nothing appropriate
>
>   "man perl" should be fine for people who are not shell
>scripts.
>
>>  pod2latex: nothing appropriate
>>  pod2text: nothing appropriate
>
>   Perl people.
>
>>  ptx: nothing appropriate
>
>   Has info pages.  Wish they'd write man pages.
>
>>  splain: nothing appropriate
>>  suidperl: nothing appropriate
>
>   Perl.
>
>>  systags: nothing appropriate
>
>   Contact the global people -- this is contributed software.
>
>>  ----------
>>  /usr/sbin
>>  ----------
>>  callbootd: nothing appropriate
>
>   Another real case.  I'll look into it.
>
>>  memcontrol: nothing appropriate
>
>   Exists in -CURRENT.  I'll talk to Mike (the maintainer) and
>merge it into -STABLE.  (I wrote the man page recently.)
>
>>  named-bootconf: nothing appropriate
>>  nsupdate: nothing appropriate
>
>   BIND people, contributed software.
>
>>  pmap_dump: nothing appropriate
>>  pmap_set: nothing appropriate
>
>   I'd have to look into these.
>
>-- 
>|Chris Costello <chris@calldei.com>
>|To err is human; to forgive, beyond the scope of the Operating System.
>`----------------------------------------------------------------------
>
>
>
Comment 4 chris 1999-11-03 05:58:43 UTC
On Tue, Nov 02, 1999, Jesse Monroy, Jr. wrote:
> Perhaps my report was not correct in it's content.
> My subject line was correct. "..(48).. without whatis(1) information"
> 
> How would suggest I write this, so that it may be understood.
> This may be a failing in my PR.

   "whatis" will also find things by the existance of their man
page:

$ whatis memcontrol
memcontrol(8) - Control system cache behaviour with respect to memory

> As for the PR, I'll followup on people (ie. bind/perl/sendmail people, et. al)
> that should send in the appropriate fixes. I'd be happy to do this. :-)

   Thanks!

> For other things (ie. write manpages), my time is just too limited, sorry.

   I couldn't pass up an opportunity.  FreeBSD is maintained by
volunteers.

> Lastly, Thanks for a civil response. My intent has always been
> to be helpful, it's not always interpeted that way. :-)

   The few that actually didn't have man pages should have man
pages.  Thanks for (though somehow indirectly) indirectly
pointing that out.

-- 
|Chris Costello <chris@calldei.com>
|"That must be wonderful!  I don't understand it at all."
`--------------------------------------------------------
Comment 5 asmodai 1999-12-24 11:27:00 UTC
mk_cmds.1 has been added.

Another one shot down.

-- 
Jeroen Ruigrok van der Werven          Network- and systemadministrator
<asmodai@bart.nl>                      bART Internet Services /
Tel: +31 - (0) 10 - 240 39 70          VIA NET.WORKS Netherlands
Comment 6 Tom Rhodes freebsd_committer freebsd_triage 2003-04-24 17:02:09 UTC
State Changed
From-To: open->closed

Switch this PR to me. 
The list printed now shows that most utilities lacking the manual pages 
either have MLINKS or are from contributed software. 


Comment 7 Tom Rhodes freebsd_committer freebsd_triage 2003-04-24 17:02:09 UTC
Responsible Changed
From-To: chris->trhodes

Switch this PR to me. 
The list printed now shows that most utilities lacking the manual pages 
either have MLINKS or are from contributed software.