Subject: misc/19609: hier(7) man page has some errors
To: None <gnats-bugs@gnats.netbsd.org>
From: None <sobrado@acm.org>
List: netbsd-bugs
Date: 12/30/2002 09:23:02
>Number:         19609
>Category:       misc
>Synopsis:       hier(7) man page has some errors
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Mon Dec 30 09:24:01 PST 2002
>Closed-Date:
>Last-Modified:
>Originator:     Igor Sobrado
>Release:        1.6
>Organization:
University of Oviedo
>Environment:
NetBSD ns1.localnet 1.6 NetBSD 1.6 (GENERIC) #0: Sun Sep  8 19:43:40 UTC 2002
     autobuild@tgm.daemon.org:/autobuild/i386/OBJ/autobuild/src/sys/arch/i386/compile/GENERIC i386

>Description:
The NetBSD 1.6 hier(7) man page has some errors.  Some improvements
to that man page are possible too.

Errors:  I am aware that not all entries in this man page are
available in every system.  But the next entries are wrong:

  /usr/lkm - the loadable kernel modules directory should exist,
    the interface and other lkm-related entries are described.

Improvements:  I have observed that most entries are in alphabetical
order.  It is nice, as simplifies looking for the description of a
file, directory, or filesystem.  It makes the general layout of this
page similar to the default layout of the filesystem hierarchy
as shown by ls(1).  But some entries are NOT in alphabetical order:

  /dev/fd - must be placed after /dev/drum
  /dev/null - must be placed after /dev/mem
  /etc/master.passwd, /etc/passwd, /etc/pwd.db, /etc/spwd.db - are in
    the wrong place too, a description of each file should be nice
    too (the only way to know the differences between pwd.db and
    spwd.db is reading the pwd_mkdb(8) man page).
  /etc/rc.* - same about those entries
  /root/.rhosts - perhaps it is in the wrong place (except if we
    want to group the start-up files together.)
  /usr/include/natm - is it in the wrong place too?
  /usr/local/libdata - is in the wrong place?
  /usr/pkg/sbin - is it in the wrong place?
  /usr/pkg/libdata - is it in the wrong place?
  /usr/obj - is it in wrong place?
  /usr/share/dict/* - are in the wrong order?

  /usr/src and its subdirectories should follow the same
    layout as, for example, /usr/local and its subdirectories.
  /usr/src/distrib - is it in the wrong place?
  /usr/src/ntfs - is in the wrong order?

    
>How-To-Repeat:
$ man hier
>Fix:
A simple change to /usr/share/man/man7/hier.7, followed by catman(8).
>Release-Note:
>Audit-Trail:
>Unformatted: