[PATCH 0/2] mdadm/manpage: update manpage for readonly and array-size

[PATCH 0/2] mdadm/manpage: update manpage for readonly and array-size

[Zhilong Liu]

Hi, Jes;
  These two patches is to update the description for readonly and array-size
sectors.

Thanks,
Zhilong

---

Zhilong Liu (2):
  mdadm/manpage:update description for readonly in manpage
  mdadm/manpage:clustered array doesn't support --array-size yet

 mdadm.8.in | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

-- 
2.6.6

[PATCH 1/2] mdadm/manpage:update description for readonly in manpage

[Zhilong Liu]

update readonly/readwrite in man page:
Currently both the readwrite and readonly are worked well,
thus updates description for them.

Signed-off-by: Zhilong Liu <zlliu@suse.com>
---
 mdadm.8.in | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/mdadm.8.in b/mdadm.8.in
index 744c12b..f006cf5 100644
--- a/mdadm.8.in
+++ b/mdadm.8.in
@@ -925,7 +925,8 @@ will not try to be so clever.
 Start the array
 .B read only
 rather than read-write as normal.  No writes will be allowed to the
-array, and no resync, recovery, or reshape will be started.
+array, and no resync, recovery, or reshape will be started. It works with
+Create, Assemble, Manage and Misc mode.
 
 .TP
 .BR \-a ", " "\-\-auto{=yes,md,mdp,part,p}{NN}"
@@ -2232,7 +2233,7 @@ be in use.
 
 .TP
 .B \-\-readonly
-start the array readonly \(em not supported yet.
+start the array with readonly status.
 
 .SH MANAGE MODE
 .HP 12
@@ -2438,12 +2439,11 @@ This will fully activate a partially assembled md array.
 
 .TP
 .B \-\-readonly
-This will mark an active array as read-only, providing that it is
-not currently being used.
+This will set an active array as read-only status.
 
 .TP
 .B \-\-readwrite
-This will change a
+This will change an
 .B readonly
 array back to being read/write.
 
-- 
2.6.6

[PATCH 2/2] mdadm/manpage:clustered array doesn't support --array-size yet

[Zhilong Liu]

update man page for --array-size:
clustered array isn't allowed to change array_sector by now.

Signed-off-by: Zhilong Liu <zlliu@suse.com>
---
 mdadm.8.in | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/mdadm.8.in b/mdadm.8.in
index f006cf5..3555516 100644
--- a/mdadm.8.in
+++ b/mdadm.8.in
@@ -541,6 +541,10 @@ A value of
 restores the apparent size of the array to be whatever the real
 amount of available space is.
 
+The
+.B clustered
+array isn't supported this parameter yet.
+
 .TP
 .BR \-c ", " \-\-chunk=
 Specify chunk size of kilobytes.  The default when creating an
-- 
2.6.6

Re: [PATCH 2/2] mdadm/manpage:clustered array doesn't support --array-size yet

[Jes Sorensen]

On 04/10/2017 04:04 AM, Zhilong Liu wrote:
> update man page for --array-size:
> clustered array isn't allowed to change array_sector by now.
>
> Signed-off-by: Zhilong Liu <zlliu@suse.com>
> ---
>  mdadm.8.in | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/mdadm.8.in b/mdadm.8.in
> index f006cf5..3555516 100644
> --- a/mdadm.8.in
> +++ b/mdadm.8.in
> @@ -541,6 +541,10 @@ A value of
>  restores the apparent size of the array to be whatever the real
>  amount of available space is.
>
> +The
> +.B clustered
> +array isn't supported this parameter yet.

Should this say "Clustered arrays do not support this parameter yet." ?

Thanks,
Jes

Re: [PATCH 1/2] mdadm/manpage:update description for readonly in manpage

[Jes Sorensen]

On 04/10/2017 04:04 AM, Zhilong Liu wrote:
> update readonly/readwrite in man page:
> Currently both the readwrite and readonly are worked well,
> thus updates description for them.
>
> Signed-off-by: Zhilong Liu <zlliu@suse.com>
> ---
>  mdadm.8.in | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)

A couple of comments below.

>  .TP
>  .B \-\-readonly
> -start the array readonly \(em not supported yet.
> +start the array with readonly status.

I believe it would be more correct to say "start the array in readonly 
mode" here.

>  .SH MANAGE MODE
>  .HP 12
> @@ -2438,12 +2439,11 @@ This will fully activate a partially assembled md array.
>
>  .TP
>  .B \-\-readonly
> -This will mark an active array as read-only, providing that it is
> -not currently being used.
> +This will set an active array as read-only status.

I think this chance is not good, and should be omitted.

>  .TP
>  .B \-\-readwrite
> -This will change a
> +This will change an
>  .B readonly
>  array back to being read/write.

This change is grammatically incorrect I believe and the original text 
is correct.

Thanks,
Jes

Re: [PATCH 1/2] mdadm/manpage:update description for readonly in manpage

[Wols Lists]

On 11/04/17 15:51, Jes Sorensen wrote:
>>
>>  .TP
>>  .B \-\-readonly
>> -This will mark an active array as read-only, providing that it is
>> -not currently being used.
>> +This will set an active array as read-only status.
> 
> I think this chance is not good, and should be omitted.

Agreed, except that I would change "providing" to "provided".
> 
>>  .TP
>>  .B \-\-readwrite
>> -This will change a
>> +This will change an
>>  .B readonly
>>  array back to being read/write.
> 
> This change is grammatically incorrect I believe and the original text
> is correct.

Agreed.

Cheers,
Wol

[PATCH v1 1/2] mdadm/manpage:update manpage for readonly parameter

[Zhilong Liu]

update readonly in manpage:
Currently both the readwrite and readonly are worked well,
update the readonly section.
One commit in linux/driver/md. Cleared "MD_CLOSING bit" to
Fixes: af8d8e6f0315 ("md: changes for MD_STILL_CLOSED flag")

Signed-off-by: Zhilong Liu <zlliu@suse.com>
---
 mdadm.8.in | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/mdadm.8.in b/mdadm.8.in
index 744c12b..f10a8b8 100644
--- a/mdadm.8.in
+++ b/mdadm.8.in
@@ -925,7 +925,8 @@ will not try to be so clever.
 Start the array
 .B read only
 rather than read-write as normal.  No writes will be allowed to the
-array, and no resync, recovery, or reshape will be started.
+array, and no resync, recovery, or reshape will be started. It works with
+Create, Assemble, Manage and Misc mode.
 
 .TP
 .BR \-a ", " "\-\-auto{=yes,md,mdp,part,p}{NN}"
@@ -2232,7 +2233,7 @@ be in use.
 
 .TP
 .B \-\-readonly
-start the array readonly \(em not supported yet.
+start the array in readonly mode.
 
 .SH MANAGE MODE
 .HP 12
-- 
2.6.6

[PATCH v1 2/2] mdadm/manpage:clustered arrays don't support array-size yet

[Zhilong Liu]

Update manpage for array-size section:
Clustered arrays don't support the --array-size yet.

Signed-off-by: Zhilong Liu <zlliu@suse.com>
---
 mdadm.8.in | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/mdadm.8.in b/mdadm.8.in
index f10a8b8..fb99a5c 100644
--- a/mdadm.8.in
+++ b/mdadm.8.in
@@ -541,6 +541,8 @@ A value of
 restores the apparent size of the array to be whatever the real
 amount of available space is.
 
+Clustered arrays do not support this parameter yet.
+
 .TP
 .BR \-c ", " \-\-chunk=
 Specify chunk size of kilobytes.  The default when creating an
-- 
2.6.6

Re: [PATCH v1 1/2] mdadm/manpage:update manpage for readonly parameter

[Jes Sorensen]

On 04/12/2017 04:36 AM, Zhilong Liu wrote:
> update readonly in manpage:
> Currently both the readwrite and readonly are worked well,
> update the readonly section.
> One commit in linux/driver/md. Cleared "MD_CLOSING bit" to
> Fixes: af8d8e6f0315 ("md: changes for MD_STILL_CLOSED flag")
>
> Signed-off-by: Zhilong Liu <zlliu@suse.com>
> ---
>  mdadm.8.in | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)

Applied!

Thanks,
Jes

> diff --git a/mdadm.8.in b/mdadm.8.in
> index 744c12b..f10a8b8 100644
> --- a/mdadm.8.in
> +++ b/mdadm.8.in
> @@ -925,7 +925,8 @@ will not try to be so clever.
>  Start the array
>  .B read only
>  rather than read-write as normal.  No writes will be allowed to the
> -array, and no resync, recovery, or reshape will be started.
> +array, and no resync, recovery, or reshape will be started. It works with
> +Create, Assemble, Manage and Misc mode.
>
>  .TP
>  .BR \-a ", " "\-\-auto{=yes,md,mdp,part,p}{NN}"
> @@ -2232,7 +2233,7 @@ be in use.
>
>  .TP
>  .B \-\-readonly
> -start the array readonly \(em not supported yet.
> +start the array in readonly mode.
>
>  .SH MANAGE MODE
>  .HP 12
>

Re: [PATCH v1 2/2] mdadm/manpage:clustered arrays don't support array-size yet

[Jes Sorensen]

On 04/12/2017 04:37 AM, Zhilong Liu wrote:
> Update manpage for array-size section:
> Clustered arrays don't support the --array-size yet.
>
> Signed-off-by: Zhilong Liu <zlliu@suse.com>
> ---
>  mdadm.8.in | 2 ++
>  1 file changed, 2 insertions(+)

Applied!

Thanks,
Jes