Satoru Takeuchi
2014-Aug-11 09:11 UTC
[PATCH 1/3] btrfs-progs: random fixes of btrfs-filesystem documentation
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
--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs"
in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html