From: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com>
To: "linux-btrfs@vger.kernel.org" <linux-btrfs@vger.kernel.org>
Subject: [PATCH 1/3] btrfs-progs: random fixes of btrfs-filesystem documentation
Date: Mon, 11 Aug 2014 18:11:31 +0900 [thread overview]
Message-ID: <53E888C3.70807@jp.fujitsu.com> (raw)
From: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com>
- Simplify and unify the description of both man and usage.
- Fix to show -m and -d is not exclusive
with "<path>|<uuid>|<device>|<label>".
- Add the description about short options for "--mounted" and
"--all-devices", "-m" and "-d" respectively.
- Move the descriptions of options to "Options" section.
Signed-off-by: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com>
---
Documentation/btrfs-filesystem.txt | 22 ++++++++++++++--------
cmds-filesystem.c | 15 ++++++++++-----
2 files changed, 24 insertions(+), 13 deletions(-)
diff --git a/Documentation/btrfs-filesystem.txt b/Documentation/btrfs-filesystem.txt
index c9c0b00..fe68496 100644
--- a/Documentation/btrfs-filesystem.txt
+++ b/Documentation/btrfs-filesystem.txt
@@ -20,15 +20,21 @@ SUBCOMMAND
*df* <path> [<path>...]::
Show space usage information for a mount point.
-*show* [--mounted|--all-devices|<path>|<uuid>|<device>|<label>]::
-Show the btrfs filesystem with some additional info.
+*show* [-d|-m] [<path>|<uuid>|<device>|<label>]::
+Show the structure of btrfs filesystem(s).
+
-If no option nor <path>|<uuid>|<device>|<label> is passed, btrfs shows
-information of all the btrfs filesystem both mounted and unmounted.
-If '--mounted' is passed, it would probe btrfs kernel to list mounted btrfs
-filesystem(s);
-If '--all-devices' is passed, all the devices under /dev are scanned;
-otherwise the devices list is extracted from the /proc/partitions file.
+If none of '<path>|<uuid>|<device>|<label>' is passed, btrfs shows
+information of all the btrfs filesystems both mounted and unmounted.
++
+The show command finds btrfs filesystems by scanning all the devices
+in /proc/partitions by default.
++
+`Options`
++
+-d|--alldevices::::
+scan all the devices under /dev
+-m|--mounted::::
+scan only mounted filesystems
*sync* <path>::
Force a sync for the filesystem identified by <path>.
diff --git a/cmds-filesystem.c b/cmds-filesystem.c
index 38011e5..5a80a98 100644
--- a/cmds-filesystem.c
+++ b/cmds-filesystem.c
@@ -578,11 +578,16 @@ out:
}
static const char * const cmd_show_usage[] = {
- "btrfs filesystem show [options] [<path>|<uuid>|<device>|label]",
- "Show the structure of a filesystem",
- "-d|--all-devices show only disks under /dev containing btrfs filesystem",
- "-m|--mounted show only mounted btrfs",
- "If no argument is given, structure of all present filesystems is shown.",
+ "btrfs filesystem show [-d|-m] [<path>|<uuid>|<device>|<label>]",
+ "Show the structure of btrfs filesystem(s).",
+ "If none of '<path>|<uuid>|<device>|<label>' is passed, btrfs shows",
+ "information of all the btrfs filesystems both mounted and unmounted.",
+ "",
+ "The show command finds btrfs filesystems by scanning all the devices",
+ "in /proc/partitions by default.",
+ "",
+ "-d|--all-devices scan all the devices under /dev",
+ "-m|--mounted scan only mounted filesystems",
NULL
};
--
1.9.3
next reply other threads:[~2014-08-11 9:11 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-08-11 9:11 Satoru Takeuchi [this message]
2014-08-11 17:05 ` [PATCH 1/3] btrfs-progs: random fixes of btrfs-filesystem documentation Eric Sandeen
2014-08-11 17:14 ` Eric Sandeen
2014-08-11 23:55 ` Satoru Takeuchi
2014-08-11 23:51 ` Satoru Takeuchi
2014-08-12 0:07 ` Eric Sandeen
2014-08-12 7:25 ` [PATCH 1/3 v2] " Satoru Takeuchi
2014-08-12 7:45 ` [PATCH 1/3 v3] " Satoru Takeuchi
2014-08-12 8:06 ` [PATCH 1/3 v4] " Satoru Takeuchi
2014-08-19 15:07 ` David Sterba
2014-08-19 15:10 ` [PATCH 1/3] " David Sterba
2014-08-19 15:33 ` Eric Sandeen
2014-08-20 13:22 ` David Sterba
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=53E888C3.70807@jp.fujitsu.com \
--to=takeuchi_satoru@jp.fujitsu.com \
--cc=linux-btrfs@vger.kernel.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.