From: Darrick J. Wong <darrick.wong@oracle.com>
Date: Thu, 24 Aug 2017 21:43:46 +0000 (-0500)
Subject: xfs_io: clarify the fsmap documentation
X-Git-Tag: v4.13.0-rc1~8
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=2fc6b1671ae21fb3694ca93c46ced22ac60f6396;p=thirdparty%2Fxfsprogs-dev.git

xfs_io: clarify the fsmap documentation

Explicitly declare that the 'start' and 'end' arguments to fsmap require
one of -d, -l, or -r to select the data, log, or realtime device, and fix
misspelled command name while we're at it.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Eric Sandeen <sandeen@redhat.com>
Signed-off-by: Eric Sandeen <sandeen@sandeen.net>
---

diff --git a/io/fsmap.c b/io/fsmap.c
index 9e70c7b48..448fb5356 100644
--- a/io/fsmap.c
+++ b/io/fsmap.c
@@ -48,6 +48,8 @@ fsmap_help(void)
 " -n -- query n extents at a time.\n"
 " -m -- output machine-readable format.\n"
 " -v -- Verbose information, show AG and offsets.  Show flags legend on 2nd -v\n"
+"\n"
+"The optional start and end arguments require one of -d, -l, or -r to be set.\n"
 "\n"));
 }
 
diff --git a/man/man8/xfs_io.8 b/man/man8/xfs_io.8
index 273b9c54c..0fd9b9511 100644
--- a/man/man8/xfs_io.8
+++ b/man/man8/xfs_io.8
@@ -323,6 +323,9 @@ and
 .I end
 arguments can be used to constrain the output to a particular range of
 disk blocks.
+If these two options are specified, exactly one of
+.BR "-d" ", " "-l" ", or " "-r"
+must also be set.
 .RE
 .RS 1.0i
 .PD 0
@@ -372,12 +375,12 @@ for other filesystem metadata.
 .TP
 .BI \-n " num_extents"
 If this option is given,
-.B xfs_fsmap
+.B fsmap
 obtains the extent list of the file in groups of
 .I num_extents
 extents.
 In the absence of
-.BR \-n ", " xfs_fsmap
+.BR "-n" ", " "fsmap"
 queries the system for extents in groups of 131,072 records.
 .TP
 .B \-v