public inbox for linux-xfs@vger.kernel.org
 help / color / mirror / Atom feed
From: "Darrick J. Wong" <darrick.wong@oracle.com>
To: Eric Sandeen <sandeen@redhat.com>
Cc: xfs <linux-xfs@vger.kernel.org>
Subject: [PATCH] xfs_io: clarify -c from documentation
Date: Thu, 21 Jun 2018 13:14:04 -0700	[thread overview]
Message-ID: <20180621201404.GI4838@magnolia> (raw)

From: Darrick J. Wong <darrick.wong@oracle.com>

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.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
---
 io/bmap.c         |    1 +
 man/man8/xfs_io.8 |    2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/io/bmap.c b/io/bmap.c
index 2e4ff7b2..345f276e 100644
--- a/io/bmap.c
+++ b/io/bmap.c
@@ -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"
diff --git a/man/man8/xfs_io.8 b/man/man8/xfs_io.8
index 2bd77ee8..eb2b862e 100644
--- a/man/man8/xfs_io.8
+++ b/man/man8/xfs_io.8
@@ -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.

             reply	other threads:[~2018-06-21 20:14 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-06-21 20:14 Darrick J. Wong [this message]
2018-06-21 20:21 ` [PATCH] xfs_io: clarify -c from documentation Eric Sandeen
2018-06-21 20:23   ` Darrick J. Wong

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180621201404.GI4838@magnolia \
    --to=darrick.wong@oracle.com \
    --cc=linux-xfs@vger.kernel.org \
    --cc=sandeen@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox