btrfs-progs: docs: update the rescue mount options

Commit Message

Qu Wenruo June 19, 2024, 5:16 a.m. UTC

Enhance the rescue mount option group by:

- Add a simple explanation on each rescue option

- Add the new 'ignoremetacsums' option

Signed-off-by: Qu Wenruo <[e-mail]>
---
 Documentation/ch-mount-options.rst | 27 ++++++++++++++++++++++++---
 1 file changed, 24 insertions(+), 3 deletions(-)

Patch

diff --git a/Documentation/ch-mount-options.rst b/Documentation/ch-mount-options.rst
index 2961837e9e71..1d968f37c14a 100644
--- a/Documentation/ch-mount-options.rst
+++ b/Documentation/ch-mount-options.rst
@@ -335,14 +335,35 @@  rescan_uuid_tree
 rescue
         (since: 5.9)
 
-        Modes allowing mount with damaged filesystem structures.
+        Modes allowing mount with damaged filesystem structures, all requires
+	the filesystem to be mounted read-only and doesn't allow remount to read-write.
+
+        * *usebackuproot* (since 5.9)
+
+	  Try to use backup root slots inside super block.
+	  Replaces standalone option *usebackuproot*
+
+        * *nologreplay* (since 5.9)
+
+	  Do not replay any dirty logs.
+	  Replaces standalone option *nologreplay*
 
-        * *usebackuproot* (since: 5.9, replaces standalone option *usebackuproot*)
-        * *nologreplay* (since: 5.9, replaces standalone option *nologreplay*)
         * *ignorebadroots*, *ibadroots* (since: 5.11)
+
+	  Ignore bad tree roots, greatly improve the chance for data salvage.
+
         * *ignoredatacsums*, *idatacsums* (since: 5.11)
+
+	  Ignore data checksum verification.
+
+	* *ignoremetacsums*, *imetacsums* (since 6.12)
+
+	  Ignore metadata checksum verification, useful for interrupted checksum conversion.
+
         * *all* (since: 5.9)
 
+	  Enable all supported rescue options.
+
 skip_balance
         (since: 3.3, default: off)