Bug 24010

Summary: assorted problems with hier(7) man page
Product: Documentation Reporter: rdm <rdm>
Component: Books & ArticlesAssignee: chris <chris>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description rdm 2001-01-02 01:10:01 UTC
  This PR contains a variety of problems that are related
  to the hier(7) manual page.  Once these problems are fixed,
  it might be nice to spruce up the page's format a bit...

  There are no listings for /usr/include/dev/{ppbus,ntfs,nwfs}.

  "msdosfs/    Chatacter set conversion tables"
  ---
  "msdosfs/    Character set conversion tables"

  There are no listings for /usr/libdata/{doscmd,doscmd/fonts,
  ldscripts} and no information in the /usr/libdata/gcc entry.

  "stallion/   holding the download firmware images"
  ---
  "stallion/   download images for Stallion firmware; see stlload(8)"

  There is no real information in the libdata/tcl entry.
 
  There are no listings for /usr/libexec/{lpr/ru,sendmail}.
 
  The entry for /usr/local is a bit garbled and incomplete.  How about:

     local/    local executables, libraries, etc.
               Also used as the default destination for the FreeBSD
               ports framework.  local/ should use the general layout
               sketched out by hier(7) for /usr.  Exceptions are the
               man directory (directly under local/, rather than under
               local/share/), ports documentation (in share/doc/<port>/),
               and /usr/local/etc (mimics /etc).

  In /usr, the "ports" entry should be "ports/" (it's a directory).

  /usr/share/fonts has questions marks for its description; the
  actual directory is empty.  Wazzup?

  /usr/share/locale is described as being for "internationalization
  files"; isn't it actually used for "localization files"?

  /usr/share/misc/termcap is described, but does not seem to exist.

  There is no listing for /usr/tmp.

  The listings in /usr/share/dict are not sorted alphabetically.
  Also, neither /usr/share/dict/{papers,special} seem to exist.

  The entry for /usr/share/doc has several problems.  It lists "FAQ",
  rather than "faq" and totally fails to list a number of entries.

  "syscons/   console staff; see syscons(4)"
  ---
  "syscons/   console stuff; see syscons(4)"

  "src/      BSD and/or local source files"
  ---
  "src/      BSD, third-party, and/or local source files"

  Also, the /usr/src/{crypto,secure} entries should be "crypto/"
  and "secure/" (they are directories).  

  There is no entry for /usr/src/CVS.

  The entry for /usr/src/contrib should read

  "src for file from contributed software"
  ---
  "src for files from contributed software"

  "tools used for maintaince and testing of FreeBSD"
  ---
  "tools used for maintenance and testing of FreeBSD"

  "architecture independant files"
  ---
  "architecture-independent files"

  The entry for /var/crash should read

  "default drectory to store kernel crash dumps; ..."
  ---
  "default directory to store kernel crash dumps; ..."

  There is no text in the description line for /var/cron.

  The entry for /var/cron/log is in error;
  this file is now in /var/log.

  There are entries for /var/quotas and /var/spool/secretmail,
  but no such directories exist.

Fix: 

Edit the hier(7) man page.
How-To-Repeat: 
  man hier
Comment 1 chris freebsd_committer freebsd_triage 2001-01-06 00:46:26 UTC
Responsible Changed
From-To: freebsd-doc->chris

I'm working on this.
Comment 2 chris freebsd_committer freebsd_triage 2001-01-13 19:04:20 UTC
State Changed
From-To: open->closed

Committed in revision 1.40 of hier.7.  Thanks!