Skip to content

Commit b6ce282

Browse files
committed
btrfs-porgs: docs: update btrfs-rescue
The 'btrfs rescue zero-log' text says that it's for old bugs with log replay but there were some recent ones in 6.15.x, the command will stay just in case. The rest are minor updates. Issue: #1000 Signed-off-by: David Sterba <dsterba@suse.com>
1 parent a42e3fc commit b6ce282

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

Documentation/btrfs-rescue.rst

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ SYNOPSIS
99
DESCRIPTION
1010
-----------
1111

12-
:command:`btrfs rescue` is used to try to recover a damaged btrfs filesystem.
12+
A set of commands that are targeting to fix a specific problem and may not
13+
suitable for :doc`btrfs-check`.
1314

1415
SUBCOMMAND
1516
----------
@@ -29,10 +30,10 @@ chunk-recover [options] <device>
2930

3031
.. note::
3132
Since :command:`chunk-recover` will scan the whole device, it will be very
32-
slow especially executed on a large device.
33+
slow especially if executed on a large device.
3334

3435
fix-device-size <device>
35-
fix device size and super block total bytes values that do not match
36+
Fix device size and super block total bytes values that do not match.
3637

3738
Kernel 4.11 starts to check the device size more strictly and this might
3839
mismatch the stored value of total bytes. See the exact error message below.
@@ -51,7 +52,7 @@ fix-device-size <device>
5152
WARNING: CPU: 3 PID: 439 at fs/btrfs/ctree.h:1559 btrfs_update_device+0x1c5/0x1d0 [btrfs]
5253
5354
fix-data-checksum <device>
54-
fix data checksum mismatch
55+
Selectively fix data checksum mismatch.
5556

5657
There is a long existing problem that if a user space program is doing
5758
direct IO and modifies the buffer before the write back finished, it
@@ -81,15 +82,15 @@ fix-data-checksum <device>
8182
.. _man-rescue-clear-ino-cache:
8283

8384
clear-ino-cache <device>
84-
Remove leftover items pertaining to the deprecated `inode cache` feature.
85+
Remove leftover items pertaining to the deprecated *inode number cache* feature.
8586

86-
The `inode cache` feature (enabled by mount option "inode_cache") has been
87-
completely removed in 5.11 kernel.
87+
The feature enabled by mount option *inode_cache* has been completely
88+
removed in 5.11 kernel.
8889

8990
clear-space-cache <v1|v2> <device>
9091
Completely remove the on-disk data of free space cache of given version.
9192

92-
Especially for v1 free space cache, `clear_cache` mount option would only
93+
Especially for v1 free space cache, *clear_cache* mount option would only
9394
remove the cache for updated block groups, the remaining would not be removed.
9495
Thus this command is provided to manually clear the free space cache.
9596

@@ -116,16 +117,12 @@ super-recover [options] <device>
116117
(deprecated) alias for global *-v* option
117118

118119
zero-log <device>
119-
clear the filesystem log tree
120+
Clear the filesystem log tree.
120121

121122
This command will clear the filesystem log tree. This may fix a specific
122-
set of problem when the filesystem mount fails due to the log replay. See below
123+
set of problem when the filesystem mount fails during log replay. See below
123124
for sample stack traces that may show up in system log.
124125

125-
The common case where this happens was fixed a long time ago,
126-
so it is unlikely that you will see this particular problem, but the command is
127-
kept around.
128-
129126
.. note::
130127
Clearing the log may lead to loss of changes that were made
131128
since the last transaction commit. This may be up to 30 seconds

0 commit comments

Comments
 (0)