===
From: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com>
- Simplify the description of both man and usage.
- Add the description about short options for '--all-devices'
and '--mounted', '-d' and '-m' respectively.
- Fix to show -d and -m is not exclusive
with '<path>|<uuid>|<device>|<label>'.
- Move the descriptions of options to "Options" section in manpage.
Signed-off-by: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com>
Signed-off-by: Eric Sandeen <sandeen@redhat.com>
---
changelog:
- v2: Fix the description based on Eric's comment
- v3: Fix the incomplete update of btrfs-filesystem.txt
---
Documentation/btrfs-filesystem.txt | 22 ++++++++++++++--------
Documentation/btrfs-replace.txt | 1 +
cmds-filesystem.c | 15 ++++++++++-----
3 files changed, 25 insertions(+), 13 deletions(-)
@@ -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.
+By default, the show command scans all devices found in /proc/partitions.
++
+By default, the structure of all discovered filesystems is shown.
+If any one of [<path>|<uuid>|<device>|<label>] is specified, only filesystems
+matching that identifier are shown.
++
+`Options`
++
+-d|--all-devices::::
+all devices found under /dev are scanned
+-m|--mounted::::
+only mounted btrfs devices are scanned
*sync* <path>::
Force a sync for the filesystem identified by <path>.
@@ -49,6 +49,7 @@ containing a valid btrfs filesystem.
A valid filesystem is assumed if a btrfs superblock is found which contains a
correct checksum. Devices which are currently mounted are
never allowed to be used as the <targetdev>.
++
-B::::
no background replace.
@@ -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).",
+ "",
+ "By default, the show command scans all devices found in /proc/partitions.",
+ "If [-d|--all-devices] is specified, all devices found under /dev are scanned.",
+ "If [-m|--mounted] is specified, only mounted btrfs devices are scanned.",
+ "",
+ "By default, the structure of all discovered filesystems is shown.",
+ "If any one of [<path>|<uuid>|<device>|<label>] is specified, only filesystems",
+ "matching that identifier are shown.",
NULL
};