Skip to contentSkip to conversation

xfs_io: clarify -c from documentation

PATCH In review Darrick J. Wong 2 participants 3 messages Jun 21, 2018

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 xfs_io: clarify -c from documentation

From: Darrick J. Wong <[email protected]>

The -c parameter displays the cow fork information for a file if the kernel was built with CONFIG_XFS_DEBUG=y. Since xfs_bmap doesn't support it and it doesn't work generally, remove it from the manpages. However, xfstests relies on the -c command to be documented in the help screen so leave it there with a warning about its use.

---
 io/bmap.c         |    1 +
 man/man8/xfs_io.8 |    2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)
io/bmap.c +1 -0
index 2e4ff7b2..345f276e 100644
@@ -43,6 +43,7 @@ bmap_help(void)
 " All the file offsets and disk blocks are in units of 512-byte blocks.\n"
 " -a -- prints the attribute fork map instead of the data fork.\n"
 " -c -- prints the copy-on-write fork map instead of the data fork.\n"
+"       This works only if the kernel was compiled in debug mode.\n"
 " -d -- suppresses a DMAPI read event, offline portions shown as holes.\n"
 " -e -- print delayed allocation extents.\n"
 " -l -- also displays the length of each extent in 512-byte blocks.\n"
man/man8/xfs_io.8 +1 -1
index 2bd77ee8..eb2b862e 100644
@@ -315,7 +315,7 @@ See the
 .B pwrite
 command.
 .TP
-.BI "bmap [ \-acdelpv ] [ \-n " nx " ]"
+.BI "bmap [ \-adelpv ] [ \-n " nx " ]"
 Prints the block mapping for the current open file. Refer to the
 .BR xfs_bmap (8)
 manual page for complete documentation.
Reviewed-by on v1 1/1
#1 lore raw
Quoted 9 lines · Darrick J. Wong

From: Darrick J. Wong <[email protected]>

The -c parameter displays the cow fork information for a file if the kernel was built with CONFIG_XFS_DEBUG=y. Since xfs_bmap doesn't support it and it doesn't work generally, remove it from the manpages. However, xfstests relies on the -c command to be documented in the help screen so leave it there with a warning about its use.

I'm not sure xfstests actually cares (xfs/293?) but anyway, this works for me, thanks.

Quoted 31 lines
---
 io/bmap.c         |    1 +
 man/man8/xfs_io.8 |    2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)
io/bmap.c +1 -0
index 2e4ff7b2..345f276e 100644
@@ -43,6 +43,7 @@ bmap_help(void)
 " All the file offsets and disk blocks are in units of 512-byte blocks.\n"
 " -a -- prints the attribute fork map instead of the data fork.\n"
 " -c -- prints the copy-on-write fork map instead of the data fork.\n"
+"       This works only if the kernel was compiled in debug mode.\n"
 " -d -- suppresses a DMAPI read event, offline portions shown as holes.\n"
 " -e -- print delayed allocation extents.\n"
 " -l -- also displays the length of each extent in 512-byte blocks.\n"
man/man8/xfs_io.8 +1 -1
index 2bd77ee8..eb2b862e 100644
@@ -315,7 +315,7 @@ See the
 .B pwrite
 command.
 .TP
-.BI "bmap [ \-acdelpv ] [ \-n " nx " ]"
+.BI "bmap [ \-adelpv ] [ \-n " nx " ]"
 Prints the block mapping for the current open file. Refer to the
 .BR xfs_bmap (8)
 manual page for complete documentation.
#2 lore raw
Quoted 9 lines · Eric Sandeen
Quoted 8 lines · Darrick J. Wong

From: Darrick J. Wong <[email protected]>

The -c parameter displays the cow fork information for a file if the kernel was built with CONFIG_XFS_DEBUG=y. Since xfs_bmap doesn't support it and it doesn't work generally, remove it from the manpages. However, xfstests relies on the -c command to be documented in the help screen so leave it there with a warning about its use.

Quoted 4 lines
Quoted 1 line

I'm not sure xfstests actually cares (xfs/293?) but anyway, this works for me, thanks.

xfs/243 does:
_require_xfs_io_command "bmap" "-c"

which in turn greps the xfs_io -c 'help bmap' output for:

/^ -c --/

--D

Quoted 38 lines
Quoted 23 lines
---
 io/bmap.c         |    1 +
 man/man8/xfs_io.8 |    2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)
io/bmap.c +1 -0
index 2e4ff7b2..345f276e 100644
@@ -43,6 +43,7 @@ bmap_help(void)
 " All the file offsets and disk blocks are in units of 512-byte blocks.\n"
 " -a -- prints the attribute fork map instead of the data fork.\n"
 " -c -- prints the copy-on-write fork map instead of the data fork.\n"
+"       This works only if the kernel was compiled in debug mode.\n"
 " -d -- suppresses a DMAPI read event, offline portions shown as holes.\n"
 " -e -- print delayed allocation extents.\n"
 " -l -- also displays the length of each extent in 512-byte blocks.\n"
man/man8/xfs_io.8 +0 -0
index 2bd77ee8..eb2b862e 100644

man/man8/xfs_io.8 See the · line 321

Quoted 8 lines
man/man8/xfs_io.8 +1 -1
@@ -315,7 +315,7 @@ See the
 .B pwrite
 command.
 .TP
-.BI "bmap [ \-acdelpv ] [ \-n " nx " ]"
+.BI "bmap [ \-adelpv ] [ \-n " nx " ]"
 Prints the block mapping for the current open file. Refer to the
 .BR xfs_bmap (8)
 manual page for complete documentation.

--
To unsubscribe from this list: send the line "unsubscribe linux-xfs" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html