Skip to content

Commit 2b01da5

Browse files
adam900710kdave
authored andcommitted
btrfs-progs: docs: add notes about interruption to scrub/dev-replace
Since the kernel patch is queued for v6.19, add notes to scrub and dev-replace about the new behavior change. For scrub it's not a huge deal as we can just resume using 'btrfs scrub resume' command. But for dev-replace one has to start from the beginning, thus it's recommended to disable pm during dev-replace. Signed-off-by: Qu Wenruo <wqu@suse.com> Signed-off-by: David Sterba <dsterba@suse.com>
1 parent cc7ad82 commit 2b01da5

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

Documentation/btrfs-replace.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,18 @@ start [options] <srcdev>|<devid> <targetdev> <path>
3737
larger target device; this can be achieved with
3838
``btrfs filesystem resize <devid>:max /path``
3939

40+
.. note::
41+
Device replace can be interrupted by various events after v6.19 kernel,
42+
including but not limited to power management suspend/hibernate,
43+
filesystem freezing, cgroup freezing (utilized by systemd for slice freezing)
44+
and pending signals.
45+
46+
The running device replace will be cancelled after such interruption, and
47+
the end user needs to restart the device replace from the beginning.
48+
49+
Thus it's recommended to inhibit suspend/hiberate before executing the
50+
device replace operation.
51+
4052
``Options``
4153

4254
-r

Documentation/ch-scrub-intro.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,14 @@ read-write mounted filesystem.
5656
To avoid any writes from scrub, one has to run read-only scrub on read-only
5757
filesystem.
5858

59+
.. note::
60+
Scrub can be interrupted by various events after v6.19 kernel, including
61+
but not limited to power management suspend/hibernate, filesystem freezing,
62+
cgroup freezing (utilized by systemd for slice freezing) and pending signals.
63+
64+
The running scrub will be cancelled after such interruption, and can be resumed
65+
by :command:`btrfs scrub resume` command.
66+
5967
The user is supposed to run it manually or via a periodic system service. The
6068
recommended period is a month but it could be less. The estimated device bandwidth
6169
utilization is about 80% on an idle filesystem.

0 commit comments

Comments
 (0)