Skip to contentSkip to conversation

btrfs-progs: correct manpage option description for scrub

PATCH New Gui Hecheng 1 participant 1 message Jul 31, 2014 1 message not in the archive

Subsystems (2)
Documentation Btrfs file system
lore
Share & tools
lore

Gui Hecheng

author
#1 lore raw

PATCH v3 1/1 btrfs-progs: correct manpage option description for scrub

In reply to a message not in the archive

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 protected]>
Signed-off-by Satoru Takeuchi <[email protected]>
Cc David Sterba <[email protected]>

---
changelog

	v1->v2: adopt more precise expression of the checking behavior
		add description of potential failure
	v2->v3: remove duplicate word in description
---
 Documentation/btrfs-scrub.txt | 6 +++---
 cmds-scrub.c                  | 4 ++--
 2 files changed, 5 insertions(+), 5 deletions(-)
Documentation/btrfs-scrub.txt +3 -3
index 7b27d63..b8d3b65 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).
 -n <ioprio_classdata>::::
 Set IO priority classdata (see `ionice`(1) manpage).
 -f::::
-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.
 
 *cancel* <path>|<device>::
 If a scrub is running on the filesystem identified by <path>, cancel it.
cmds-scrub.c +2 -2
index 03eb9ba..8c3d61c 100644
@@ -1529,7 +1529,7 @@ out:
 
 static const char * const cmd_scrub_start_usage[] = {
 	"btrfs scrub start [-BdqrRf] [-c ioprio_class -n ioprio_classdata] <path>|<device>",
-	"Start a new scrub",
+	"Start a new scrub. If a scrub is already running, the new one fails.",
 	"",
 	"-B     do not background",
 	"-d     stats per device (-B only)",

@@ -1538,7 +1538,7 @@ static const char * const cmd_scrub_start_usage[] = {
 	"-R     raw print mode, print full data instead of summary"
 	"-c     set ioprio class (see ionice(1) manpage)",
 	"-n     set ioprio classdata (see ionice(1) manpage)",
-	"-f     force to skip checking whether scrub has started/resumed in userspace ",
+	"-f     force starting new scrub even if a scrub is already running.",
 	"       this is useful when scrub stats record file is damaged",
 	NULL
 };
Signature · 1 line
1.8.1.4