Bug 53303

Summary: mount(2) man page error
Product: Documentation Reporter: larse <larse>
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
mount.2.patch none

Description larse 2003-06-14 00:50:13 UTC
The mount(2) man page implicitly refers to a nonexisting mount_ufs man page
in this paragraph:

     Data is a pointer to a structure that contains the type specific argu-
     ments to mount.  The format for these argument structures is described in
     the manual page for each filesystem.  By convention filesystem manual
     pages are named by prefixing ``mount_'' to the name of the filesystem as
     returned by lsvfs(1).  Thus the NFS filesystem is described by the
     mount_nfs(8) manual page.

Since lsvfs lists "ufs" as a file system name, mount_ufs should exist that
documents toe appropriate structure.

How-To-Repeat: # lsvfs 
Filesystem                        Refs Flags
-------------------------------- ----- ---------------
ufs                                  2 
procfs                               1 synthetic
linprocfs                            1 synthetic
ntfs                                 1 
nfs                                  4 network

# man mount_ufs
No manual entry for mount_ufs
Comment 1 Marc Silver 2004-01-17 08:51:53 UTC
Hi,

It seems as though UFS is currently seen as an internally known file
system type, and therefore there is no mount_ufs command or man page.
I've modified the man page for mount(2) slightly, so that it now reads:

      The data argument is a pointer to a structure that contains the
      type spe- cific arguments to mount.  The format for these argument
      structures is described in the manual page for each file system.
      By convention file system manual pages are named by prefixing
      ``mount_'' to the name of the file system as returned by lsvfs(1).
      Thus the NFS file system is described by the mount_nfs(8) manual
      page.  It should however be noted that manual pages for internally
      known file system types such as UFS, do not exist.

Would that be sufficient?

- Marc
Comment 2 Lars Eggert 2004-04-22 08:56:49 UTC
Hi,

the proposed change addresses the issue.

Even better though would be a reference to where the respective 
information can be found for UFS (but I don't know where that would 
be.)

Lars
-- 
Lars Eggert                                     NEC Network Laboratories
Comment 3 Tom Rhodes freebsd_committer freebsd_triage 2005-02-24 00:33:29 UTC
State Changed
From-To: open->patched

Slightly different version of the patch committed, thanks 
for the submission! 


Comment 4 Tom Rhodes freebsd_committer freebsd_triage 2005-02-24 00:33:29 UTC
Responsible Changed
From-To: freebsd-doc->trhodes

Over to me, MFC reminder.
Comment 5 Tom Rhodes freebsd_committer freebsd_triage 2005-02-26 04:45:28 UTC
State Changed
From-To: patched->closed

MFC complete, close this PR.