Bug 158955 - 'mount' man page does not describe 'mtpt' option required for XFS+DMAPI
Summary: 'mount' man page does not describe 'mtpt' option required for XFS+DMAPI
Status: RESOLVED FIXED
Alias: None
Product: SUSE Linux 10.1
Classification: openSUSE
Component: Documentation (show other bugs)
Version: Beta 6
Hardware: All SuSE Linux 10.1
: P5 - None : Minor (vote)
Target Milestone: ---
Assignee: Mads Martin Joergensen
QA Contact: Karl Eichwalder
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-03-17 05:10 UTC by Mike Montour
Modified: 2006-04-24 12:34 UTC (History)
3 users (show)

See Also:
Found By: Other
Services Priority:
Business Priority:
Blocker: ---
Marketing QA Status: ---
IT Deployment: ---

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Mike Montour 2006-03-17 05:10:45 UTC 
Mounting a DMAPI-enabled XFS filesystem requires mount options 'dmapi' and 'mtpt=<xxx>', where <xxx> is the location at which the filesystem is mounted. For example:

mount ./xfs.img /mnt -o loop,dmapi,mtpt=/mnt

The mount will fail if only 'dmapi' is specified. The man page for mount(8) describes the 'dmapi' option for XFS:
       dmapi  /  xdsm
              Enable the DMAPI (Data Management API) event callouts.

but does not mention the "mtpt" option. This page comes from the util-linux-2.12r-13 package.
Comment 1 Thomas Roelz 2006-03-17 16:24:53 UTC 
This is not a documentatioj bug but has to be fixed in the package.
Reassigning to maintainer.
Comment 2 Hendrik Vogelsang 2006-03-28 09:37:20 UTC 
Mike could you come up with a description that we could put in the man page? Or even better a patch. You obviously know what should be in there...
Comment 3 Mike Montour 2006-03-28 19:32:18 UTC 
These descriptions are taken from the kernel "Documentation/filesystems/xfs.txt" file, except that I added the " / xdsm" string that was in the original manpage. I checked that "xdsm" is accepted as a synonym for "dmapi" when mounting a filesystem.  

  dmapi / xdsm
        Enable the DMAPI (Data Management API) event callouts.
        Use with the "mtpt" option.

  mtpt=mountpoint
        Use with the "dmapi" option.  The value specified here will be
        included in the DMAPI mount event, and should be the path of
        the actual mountpoint that is used.

Note that there are several other mount options described in "xfs.txt" that are not mentioned in the mount manpage, e.g. "ikeep". It might be best to update the whole "Mount options for XFS" section of the manpage from this file. 

Any technical questions about these options would be best answered by the XFS developers at linux-xfs@oss.sgi.com.
Comment 4 Gerald Pfeifer 2006-04-20 23:42:59 UTC 
SGI, can you help with a text proposal perhaps?
Comment 5 Nathan Scott 2006-04-20 23:54:25 UTC 
hi Gerald,

The text from comment #3 is fine - recommend using that, its straight from
xfs kernel docs as Mike said.  Wouldn't worry about auditing the rest, any
other remaining options are very specific, or on by default, etc (ikeep is
default in sles for example).

cheers.
Comment 6 Gerald Pfeifer 2006-04-20 23:58:47 UTC 
Thanks for the quick response, Nathan!  Mads, Henne, is this sufficient?
Comment 7 Hendrik Vogelsang 2006-04-24 12:34:07 UTC 
sure. Now reads:

Mount options for xfs
       dmapi  /  xdsm
              Enable the DMAPI (Data Management API) event callouts.  Use with  
              the "mtpt" option.

       mtpt=mountpoint
              Use with the "dmapi" option. The value specified here will be  
              included in the DMAPI mount event, and should be the path of the 
              actual mountpoint that is used.

submitted for next beta.