[PATCH] btrfs-progs: doc: fix incorrect format of 'l' option in mkfs.btrfs

[PATCH] btrfs-progs: doc: fix incorrect format of 'l' option in mkfs.btrfs

[Tsutomu Itoh]

The format of 'l' option in mkfs.btrfs.txt is wrong.
And, when the head of the character string is 65536, the following warning
is displayed.

    $ make
    Making all in Documentation
        [ASCII]  mkfs.btrfs.xml
    asciidoc: WARNING: mkfs.btrfs.xml.tmp1: line 67: list item index: expected 1 got 65536
        [XMLTO]  mkfs.btrfs.8
        [GZ]     mkfs.btrfs.8.gz
    rm mkfs.btrfs.8 mkfs.btrfs.xml

So, fix it.

Signed-off-by: Tsutomu Itoh <t-itoh@jp.fujitsu.com>
---
 Documentation/mkfs.btrfs.txt | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/Documentation/mkfs.btrfs.txt b/Documentation/mkfs.btrfs.txt
index ba7e42b..01b615d 100644
--- a/Documentation/mkfs.btrfs.txt
+++ b/Documentation/mkfs.btrfs.txt
@@ -59,19 +59,18 @@ By default, mkfs.btrfs will not write to the device if it suspects that
 there is a filesystem or partition table on the device already.
 
 -n|--nodesize <size>
-+
+
 -l|--leafsize <size>::
 Specify the nodesize, the tree block size in which btrfs stores
 data. The default value is 16KB (16384) or the page size, whichever is
-bigger. Must be a multiple of the sectorsize, but not larger than
-65536. Leafsize always equals nodesize and the options are aliases.
+bigger. Must be a multiple of the sectorsize, but not larger than 65536.
+Leafsize always equals nodesize and the options are aliases.
 
 -L|--label <name>::
 Specify a label for the filesystem.
 +
 NOTE: <name> should be less than 256 characters.
 
-
 -m|--metadata <profile>::
 Specify how metadata must be spanned across the devices specified. Valid
 values are 'raid0', 'raid1', 'raid5', 'raid6', 'raid10', 'single' or 'dup'.
-- 
2.1.0

Re: [PATCH] btrfs-progs: doc: fix incorrect format of 'l' option in mkfs.btrfs

[Satoru Takeuchi]

Hi Tsutomu,

On 2014/12/24 16:10, Tsutomu Itoh wrote:
> The format of 'l' option in mkfs.btrfs.txt is wrong.
> And, when the head of the character string is 65536, the following warning
> is displayed.
>
>      $ make
>      Making all in Documentation
>          [ASCII]  mkfs.btrfs.xml
>      asciidoc: WARNING: mkfs.btrfs.xml.tmp1: line 67: list item index: expected 1 got 65536
>          [XMLTO]  mkfs.btrfs.8
>          [GZ]     mkfs.btrfs.8.gz
>      rm mkfs.btrfs.8 mkfs.btrfs.xml
>
> So, fix it.
>
> Signed-off-by: Tsutomu Itoh <t-itoh@jp.fujitsu.com>

It looks good to me.

Reviewed-by: Satoru Takeuchi <takeuchi_satoru@jp.fujitsu.com>

Current man 8 mkfs.btrfs is wrong as follows.

===============================================================================
...
        -n|--nodesize <size>
                                                                                                                              
        + -l|--leafsize <size>:: Specify the nodesize, the tree block size in which btrfs stores data. The default value
        is 16KB (16384) or the page size, whichever is bigger. Must be a multiple of the sectorsize, but not larger than
        65536. Leafsize always equals nodesize and the options are aliases.
...
===============================================================================

In addition, after removing '+' between '-n' and '-l'
to fix this problem, the warning which you said is displayed.
After applying this patch, both two problems disappeared.

Thanks,
Satoru

> ---
>   Documentation/mkfs.btrfs.txt | 7 +++----
>   1 file changed, 3 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/mkfs.btrfs.txt b/Documentation/mkfs.btrfs.txt
> index ba7e42b..01b615d 100644
> --- a/Documentation/mkfs.btrfs.txt
> +++ b/Documentation/mkfs.btrfs.txt
> @@ -59,19 +59,18 @@ By default, mkfs.btrfs will not write to the device if it suspects that
>   there is a filesystem or partition table on the device already.
>
>   -n|--nodesize <size>
> -+
> +
>   -l|--leafsize <size>::
>   Specify the nodesize, the tree block size in which btrfs stores
>   data. The default value is 16KB (16384) or the page size, whichever is
> -bigger. Must be a multiple of the sectorsize, but not larger than
> -65536. Leafsize always equals nodesize and the options are aliases.
> +bigger. Must be a multiple of the sectorsize, but not larger than 65536.
> +Leafsize always equals nodesize and the options are aliases.
>
>   -L|--label <name>::
>   Specify a label for the filesystem.
>   +
>   NOTE: <name> should be less than 256 characters.
>
> -
>   -m|--metadata <profile>::
>   Specify how metadata must be spanned across the devices specified. Valid
>   values are 'raid0', 'raid1', 'raid5', 'raid6', 'raid10', 'single' or 'dup'.
>