NeilBrown: Correct documentation for --rebuild-map

Martin F. Krafft madduck at alioth.debian.org
Sun Aug 29 11:54:55 UTC 2010


Module: mdadm
Branch: fixes/udev-blkid
Commit: 7e6140e6c614025aea1d20a8d790a651b7d5b8c4
URL:    http://git.debian.org/?p=pkg-mdadm/mdadm.git;a=commit;h=7e6140e6c614025aea1d20a8d790a651b7d5b8c4

Author: NeilBrown <neilb at suse.de>
Date:   Wed Jun 30 16:52:54 2010 +1000

Correct documentation for --rebuild-map

In some places it is referred to as "--rebuild", and while
that works due to getopt allowing prefixes, it could appear
confusing (rebuild means other things too) and being explicit
is some safeguard if we want to add e.g. --rebuild-foo later.

Reported-by: Doug Ledford <dledford at redhat.com>
Signed-off-by: NeilBrown <neilb at suse.de>

---

 ReadMe.c   |   14 +++++++-------
 mdadm.8.in |    4 ++--
 2 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/ReadMe.c b/ReadMe.c
index 9d5a211..a3f556a 100644
--- a/ReadMe.c
+++ b/ReadMe.c
@@ -542,13 +542,13 @@ char Help_incr[] =
 "devices, it will be started.\n"
 "\n"
 "Options that are valid with incremental assembly (-I --incremental) more are:\n"
-"  --run       -R  : run arrays as soon as a minimal number of devices are\n"
-"                  : present rather than waiting for all expected.\n"
-"  --quiet     -q  : Don't print any information messages, just errors.\n"
-"  --rebuild   -r  : Rebuild the 'map' file that mdadm uses for tracking\n"
-"                  : partial arrays.\n"
-"  --scan      -s  : Use with -R to start any arrays that have the minimal\n"
-"                  : required number of devices, but are not yet started.\n"
+"  --run         -R : run arrays as soon as a minimal number of devices are\n"
+"                   : present rather than waiting for all expected.\n"
+"  --quiet       -q : Don't print any information messages, just errors.\n"
+"  --rebuild-map -r : Rebuild the 'map' file that mdadm uses for tracking\n"
+"                   : partial arrays.\n"
+"  --scan        -s : Use with -R to start any arrays that have the minimal\n"
+"                   : required number of devices, but are not yet started.\n"
 ;
 
 char Help_config[] =
diff --git a/mdadm.8.in b/mdadm.8.in
index 67fabf3..e5cc89e 100644
--- a/mdadm.8.in
+++ b/mdadm.8.in
@@ -2145,7 +2145,7 @@ Usage:
 .I component-device
 .HP 12
 Usage:
-.B mdadm \-\-incremental \-\-rebuild
+.B mdadm \-\-incremental \-\-rebuild\-map
 .HP 12
 Usage:
 .B mdadm \-\-incremental \-\-run \-\-scan
@@ -2391,7 +2391,7 @@ pid of mdadm daemon to
 Try to incorporate newly discovered device into some array as
 appropriate.
 
-.B "  mdadm \-\-incremental \-\-rebuild \-\-run \-\-scan"
+.B "  mdadm \-\-incremental \-\-rebuild\-map \-\-run \-\-scan"
 .br
 Rebuild the array map from any current arrays, and then start any that
 can be started.




More information about the pkg-mdadm-commits mailing list