|author||Gui Hecheng <email@example.com>||2014-07-30 15:32:05 +0800|
|committer||David Sterba <firstname.lastname@example.org>||2014-08-22 15:07:01 +0200|
btrfs-progs: correct manpage option description for scrub
The -f option of scrub means to "force starting new scrub even if a scrub is already running" *not* "force to check whether scrub has started or resumed in userspace" as described originally. So replace the orignal description in the manpage and code. Also, add description of the potential failure as follows "If a scrub is already running, it fails." Signed-off-by: Gui Hecheng <email@example.com> Signed-off-by: Satoru Takeuchi <firstname.lastname@example.org> Cc: David Sterba <email@example.com> Signed-off-by: David Sterba <firstname.lastname@example.org>
Diffstat (limited to 'Documentation')
1 files changed, 3 insertions, 3 deletions
diff --git a/Documentation/btrfs-scrub.txt b/Documentation/btrfs-scrub.txt
index 7b27d63c..b8d3b658 100644
@@ -18,7 +18,7 @@ SUBCOMMAND
*start* [-BdqrRf] [-c <ioprio_class> -n <ioprio_classdata>] <path>|<device>::
Start a scrub on all devices of the filesystem identified by <path> or on
-a single <device>.
+a single <device>. If a scrub is already running, the new one fails.
Without options, scrub is started as a background process.
Progress can be obtained with the *scrub status* command. Scrubbing
@@ -47,8 +47,8 @@ manpage).
Set IO priority classdata (see `ionice`(1) manpage).
-force to check whether scrub has started or resumed in userspace.
-this is useful when scrub stat record file is damaged.
+Force starting new scrub even if a scrub is already running.
+This is useful when scrub stat record file is damaged.
If a scrub is running on the filesystem identified by <path>, cancel it.