btrfs-progs: docs: add note about mount option applicability

[platform/upstream/btrfs-progs.git] / Documentation / btrfs-inspect-internal.asciidoc

diff --git a/Documentation/btrfs-inspect-internal.asciidoc b/Documentation/btrfs-inspect-internal.asciidoc
index aa79150..62b1029 100644 (file)
--- a/Documentation/btrfs-inspect-internal.asciidoc
+++ b/Documentation/btrfs-inspect-internal.asciidoc
@@ -19,6 +19,48 @@ requires calls to privileged ioctls.
 
 SUBCOMMAND
 ----------
+*dump-super* [options] <device> [device...]::
+(replaces the standalone tool *btrfs-show-super*)
++
+Show btrfs superblock information stored on given devices in textual form.
+By default the first superblock is printed, more details about all copies or
+additional backup data can be printed.
++
+Besides verification of the filesystem signature, there are no other sanity
+checks. The superblock checksum status is reported, the device item and
+filesystem UUIDs are checked and reported.
++
+NOTE: the meaning of option '-s' has changed in version 4.8 to be consistent
+with other tools to specify superblock copy rather the offset. The old way still
+works, but prints a warning. Please update your scripts to use '--bytenr'
+instead. The option '-i' has been deprecated.
++
+`Options`
++
+-f|--full::::
+print full superblock information, including the system chunk array and backup roots
+-a|--all::::
+print information about all present superblock copies (cannot be used together
+with '-s' option)
+-i <super>::::
+(deprecated since 4.8, same behaviour as '--super')
+--bytenr <bytenr>::::
+specify offset to a superblock in a non-standard location at 'bytenr', useful
+for debugging (disables the '-f' option)
++
+If there are multiple options specified, only the last one applies.
++
+-F|--force::::
+attempt to print the superblock even if a valid BTRFS signature is not found;
+the result may be completely wrong if the data does not resemble a superblock
++
+-s|--super <bytenr>::::
+(see compatibility note above)
++
+specify which mirror to print, valid values are 0, 1 and 2 and the superblock
+must be present on the device with a valid signature, can be used together with
+'--force'
+
 *dump-tree* [options] <device>::
 (replaces the standalone tool *btrfs-debug-tree*)
 +
@@ -100,46 +142,20 @@ subvolume itself return it's own tree id (ie. subvol id)
 NOTE: The result is undefined for the so-called empty subvolumes (identified by
 inode number 2), but such subvolume does not contain any files anyway
 
-*show-super* [options] <device> [device...]::
+*subvolid-resolve* <subvolid> <path>::
 (needs root privileges)
 +
-Show btrfs superblock information stored in devices.
-It is used to print the information of superblock,
-you can specify which mirror to print out.
-+
-By default, every device's first superblock will be printed out.
+resolve the absolute path of a the subvolume id 'subvolid'
+
+*tree-stats* [options] <device>::
+(needs root privileges)
 +
-Mainly used for debug purpose.
+Print sizes and statistics of trees.
 +
 `Options`
 +
--f::::
-Print full superblock information.
-+
-Including the system chunk array and backup roots.
-+
--a::::
-Print information of all superblocks.
-+
-If this option is given, '-i' option will be ignored.
-+
--i <super_mirror>::::
-Specify which mirror to print out.
-+
-<super_mirror> is between 0 and 2.
-If several '-i <super_mirror>' are given, only the last one is valid.
-+
--F::::
-Attempt to print the superblock even if no superblock magic is found.  May end
-badly.
--s <bytenr>::::
-specifiy offset to a superblock in a non-standard location at 'bytenr', useful
-for debugging (disables the '-f' option)
-
-*subvolid-resolve* <subvolid> <path>::
-(needs root privileges)
-+
-resolve the absolute path of a the subvolume id 'subvolid'
+-b::::
+Print raw numbers in bytes.
 
 EXIT STATUS
 -----------