cosmetic bug in mdadm

cosmetic bug in mdadm

[Jon Nelson]

mdadm --grow --help shows

  --raid-disks=  -n   : Change the number of active devices in an array.
                      : array.

but the manpage uses:

  --raid-devices

The latter should be preferred?
Also, a --grow fails without a spare or --backup-file, however
--backup-file is only in the manpage, not in the --help. That's pretty
minor but useful.



-- 
Jon

Re: cosmetic bug in mdadm

[Neil Brown]

On Monday July 28, jnelson-linux-raid@jamponi.net wrote:
> mdadm --grow --help shows
> 
>   --raid-disks=  -n   : Change the number of active devices in an array.
>                       : array.
> 
> but the manpage uses:
> 
>   --raid-devices
> 
> The latter should be preferred?
> Also, a --grow fails without a spare or --backup-file, however
> --backup-file is only in the manpage, not in the --help. That's pretty
> minor but useful.

Fair comments.
Does this address your observations suitably?

Thanks.
NeilBrown



diff --git a/ReadMe.c b/ReadMe.c
index 0a736ed..7a67158 100644
--- a/ReadMe.c
+++ b/ReadMe.c
@@ -518,9 +518,12 @@ char Help_grow[] =
 "  --size=        -z   : Change the active size of devices in an array.\n"
 "                      : This is useful if all devices have been replaced\n"
 "                      : with larger devices.\n"
-"  --raid-disks=  -n   : Change the number of active devices in an array.\n"
+"  --raid-devices= -n  : Change the number of active devices in an array.\n"
 "                      : array.\n"
 "  --bitmap=      -b   : Add or remove a write-intent bitmap.\n"
+"  --backup-file= file : A file on a differt device to store data for a\n"
+"                      : short time while increasing raid-devices on a\n"
+"                      : RAID4/5/6 array. Not needed when a spare is present.\n"
 ;
 
 char Help_incr[] =
diff --git a/mdadm.8 b/mdadm.8
index fd26e12..be8568d 100644
--- a/mdadm.8
+++ b/mdadm.8
@@ -1729,7 +1729,7 @@ Currently the only support available is to
 change the "size" attribute
 for RAID1, RAID5 and RAID6.
 .IP \(bu 4
-increase the "raid-disks" attribute of RAID1, RAID5, and RAID6.
+increase the "raid\-devices" attribute of RAID1, RAID5, and RAID6.
 .IP \(bu 4
 add a write-intent bitmap to any array which supports these bitmaps, or
 remove a write-intent bitmap from such an array.
diff --git a/mdadm.c b/mdadm.c
index 641d717..3aa3b13 100644
--- a/mdadm.c
+++ b/mdadm.c
@@ -1155,7 +1155,7 @@ int main(int argc, char *argv[])
 			break;
 		}
 		if (raiddisks == 0) {
-			fprintf(stderr, Name ": no raid-disks specified.\n");
+			fprintf(stderr, Name ": no raid-devices specified.\n");
 			rv = 1;
 			break;
 		}
@@ -1179,7 +1179,7 @@ int main(int argc, char *argv[])
 			break;
 		}
 		if (raiddisks == 0) {
-			fprintf(stderr, Name ": no raid-disks specified.\n");
+			fprintf(stderr, Name ": no raid-devices specified.\n");
 			rv = 1;
 			break;
 		}

Re: cosmetic bug in mdadm

[Mr. James W. Laferriere]

 	Hello Neil ,  See below ...

On Tue, 29 Jul 2008, Neil Brown wrote:
> On Monday July 28, jnelson-linux-raid@jamponi.net wrote:
>> mdadm --grow --help shows
>>
>>   --raid-disks=  -n   : Change the number of active devices in an array.
>>                       : array.
>>
>> but the manpage uses:
>>
>>   --raid-devices
>>
>> The latter should be preferred?
>> Also, a --grow fails without a spare or --backup-file, however
>> --backup-file is only in the manpage, not in the --help. That's pretty
>> minor but useful.
>
> Fair comments.
> Does this address your observations suitably?
>
> Thanks.
> NeilBrown
>
>
>
> diff --git a/ReadMe.c b/ReadMe.c
> index 0a736ed..7a67158 100644
> --- a/ReadMe.c
> +++ b/ReadMe.c
> @@ -518,9 +518,12 @@ char Help_grow[] =
> "  --size=        -z   : Change the active size of devices in an array.\n"
> "                      : This is useful if all devices have been replaced\n"
> "                      : with larger devices.\n"
> -"  --raid-disks=  -n   : Change the number of active devices in an array.\n"
> +"  --raid-devices= -n  : Change the number of active devices in an array.\n"
> "                      : array.\n"
 	To what command  ^^^^^^^^^^^ is this associated in the --help output ?

 	Hth ,  JimL
-- 
+------------------------------------------------------------------+
| James   W.   Laferriere | System    Techniques | Give me VMS     |
| Network&System Engineer | 2133    McCullam Ave |  Give me Linux  |
| babydr@baby-dragons.com | Fairbanks, AK. 99701 |   only  on  AXP |
+------------------------------------------------------------------+

Re: cosmetic bug in mdadm

[Neil Brown]

On Monday July 28, babydr@baby-dragons.com wrote:
> > --- a/ReadMe.c
> > +++ b/ReadMe.c
> > @@ -518,9 +518,12 @@ char Help_grow[] =
                              ^^^^^^^^^
> > "  --size=        -z   : Change the active size of devices in an array.\n"
> > "                      : This is useful if all devices have been replaced\n"
> > "                      : with larger devices.\n"
> > -"  --raid-disks=  -n   : Change the number of active devices in an array.\n"
> > +"  --raid-devices= -n  : Change the number of active devices in an array.\n"
> > "                      : array.\n"
>  	To what command  ^^^^^^^^^^^ is this associated in the --help output ?

 mdadm --grow --help

(all the others already spelt it "--raid-devices").

NeilBrown

Re: cosmetic bug in mdadm

[Conway S. Smith]

On Tue, 29 Jul 2008 13:52:26 +1000
Neil Brown <neilb@suse.de> wrote:
> On Monday July 28, babydr@baby-dragons.com wrote:
> > > --- a/ReadMe.c
> > > +++ b/ReadMe.c
> > > @@ -518,9 +518,12 @@ char Help_grow[] =
>                               ^^^^^^^^^
> > > "  --size=        -z   : Change the active size of devices in
> > > an array.\n" "                      : This is useful if all
> > > devices have been replaced\n" "                      : with
> > > larger devices.\n" -"  --raid-disks=  -n   : Change the number
> > > of active devices in an array.\n" +"  --raid-devices= -n  :
> > > Change the number of active devices in an array.\n"
> > > "                      : array.\n"
> >  	To what command  ^^^^^^^^^^^ is this associated in the
> > --help output ?
> 
>  mdadm --grow --help
> 
> (all the others already spelt it "--raid-devices").
> 

I think he meant the last line, w/ just ": array.\n".  Is that
associated w/ a different command, or should it be removed since the
previous line already has the word array?


Conway S. Smith

Re: cosmetic bug in mdadm

[Neil Brown]

On Tuesday July 29, beolach@gmail.com wrote:
> On Tue, 29 Jul 2008 13:52:26 +1000
> Neil Brown <neilb@suse.de> wrote:
> > On Monday July 28, babydr@baby-dragons.com wrote:
> > > > --- a/ReadMe.c
> > > > +++ b/ReadMe.c
> > > > @@ -518,9 +518,12 @@ char Help_grow[] =
> >                               ^^^^^^^^^
> > > > "  --size=        -z   : Change the active size of devices in
> > > > an array.\n" "                      : This is useful if all
> > > > devices have been replaced\n" "                      : with
> > > > larger devices.\n" -"  --raid-disks=  -n   : Change the number
> > > > of active devices in an array.\n" +"  --raid-devices= -n  :
> > > > Change the number of active devices in an array.\n"
> > > > "                      : array.\n"
> > >  	To what command  ^^^^^^^^^^^ is this associated in the
> > > --help output ?
> > 
> >  mdadm --grow --help
> > 
> > (all the others already spelt it "--raid-devices").
> > 
> 
> I think he meant the last line, w/ just ": array.\n".  Is that
> associated w/ a different command, or should it be removed since the
> previous line already has the word array?

Ah yes, I see.  That dates from Feb 2007 when we changed:
-"  --raid-disks=  -n   : Change the number of active devices in a RAID1\n"
+"  --raid-disks=  -n   : Change the number of active devices in an array.\n"
 "                      : array.\n"

Fixed now.

Thanks.
NeilBrown