diff mbox series

: mkfs.xfs: correct the error prompt in usage()

Message ID 2a51a8b8-a993-7b15-d86f-8244d1bfce44@huawei.com (mailing list archive)
State New
Headers show
Series : mkfs.xfs: correct the error prompt in usage() | expand

Commit Message

Wu Guanghao Dec. 20, 2023, 1:59 a.m. UTC
According to the man page description, su=value and sunit=value are both
used to specify the unit for a RAID device/logical volume. And swidth and
sw are both used to specify the stripe width.

So in the prompt we need to associate su with sunit and sw with swidth.

Signed-by-off: Wu Guanghao <wuguanghao3@huawei.com>
---
 mkfs/xfs_mkfs.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--
2.27.0

Comments

Darrick J. Wong Dec. 20, 2023, 2:43 a.m. UTC | #1
On Wed, Dec 20, 2023 at 09:59:04AM +0800, Wu Guanghao wrote:
> According to the man page description, su=value and sunit=value are both
> used to specify the unit for a RAID device/logical volume. And swidth and
> sw are both used to specify the stripe width.
> 
> So in the prompt we need to associate su with sunit and sw with swidth.
> 
> Signed-by-off: Wu Guanghao <wuguanghao3@huawei.com>
> ---
>  mkfs/xfs_mkfs.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/mkfs/xfs_mkfs.c b/mkfs/xfs_mkfs.c
> index dd3360dc..c667b904 100644
> --- a/mkfs/xfs_mkfs.c
> +++ b/mkfs/xfs_mkfs.c
> @@ -993,7 +993,7 @@ usage( void )
>  /* metadata */         [-m crc=0|1,finobt=0|1,uuid=xxx,rmapbt=0|1,reflink=0|1,\n\
>                             inobtcount=0|1,bigtime=0|1]\n\
>  /* data subvol */      [-d agcount=n,agsize=n,file,name=xxx,size=num,\n\
> -                           (sunit=value,swidth=value|su=num,sw=num|noalign),\n\
> +                           (sunit=value|su=num,swidth=value|sw=num,noalign),\n\

Doesn't mkfs require sunit/swidth or su/sw to be used together, but not
intermixed?

--D

>                             sectsize=num\n\
>  /* force overwrite */  [-f]\n\
>  /* inode size */       [-i perblock=n|size=num,maxpct=n,attr=0|1|2,\n\
> --
> 2.27.0
>
Wu Guanghao Dec. 20, 2023, 8:48 a.m. UTC | #2
在 2023/12/20 10:43, Darrick J. Wong 写道:
> On Wed, Dec 20, 2023 at 09:59:04AM +0800, Wu Guanghao wrote:
>> According to the man page description, su=value and sunit=value are both
>> used to specify the unit for a RAID device/logical volume. And swidth and
>> sw are both used to specify the stripe width.
>>
>> So in the prompt we need to associate su with sunit and sw with swidth.
>>
>> Signed-by-off: Wu Guanghao <wuguanghao3@huawei.com>
>> ---
>>  mkfs/xfs_mkfs.c | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/mkfs/xfs_mkfs.c b/mkfs/xfs_mkfs.c
>> index dd3360dc..c667b904 100644
>> --- a/mkfs/xfs_mkfs.c
>> +++ b/mkfs/xfs_mkfs.c
>> @@ -993,7 +993,7 @@ usage( void )
>>  /* metadata */         [-m crc=0|1,finobt=0|1,uuid=xxx,rmapbt=0|1,reflink=0|1,\n\
>>                             inobtcount=0|1,bigtime=0|1]\n\
>>  /* data subvol */      [-d agcount=n,agsize=n,file,name=xxx,size=num,\n\
>> -                           (sunit=value,swidth=value|su=num,sw=num|noalign),\n\
>> +                           (sunit=value|su=num,swidth=value|sw=num,noalign),\n\
> 
> Doesn't mkfs require sunit/swidth or su/sw to be used together, but not
> intermixed?
> 
> --D
> 

I think the '|' in usage() should be related to the modification of the same feature,
so there is also 'sunit|su' in the -l parameter. There are already other prompts for
mixed use of su/sw, and I don’t think there is a need to remind it in usage().
The current 'swidth=value|su=num' prompt makes me think that the two modifications
are the same. There may be other people who think so too, so I suggest changing
the description.

>>                             sectsize=num\n\
>>  /* force overwrite */  [-f]\n\
>>  /* inode size */       [-i perblock=n|size=num,maxpct=n,attr=0|1|2,\n\
>> --
>> 2.27.0
>>
> 
> .
>
Carlos Maiolino Dec. 20, 2023, 1:50 p.m. UTC | #3
On Wed, Dec 20, 2023 at 04:48:36PM +0800, Wu Guanghao wrote:
> 
> 
> 在 2023/12/20 10:43, Darrick J. Wong 写道:
> > On Wed, Dec 20, 2023 at 09:59:04AM +0800, Wu Guanghao wrote:
> >> According to the man page description, su=value and sunit=value are both
> >> used to specify the unit for a RAID device/logical volume. And swidth and
> >> sw are both used to specify the stripe width.
> >>
> >> So in the prompt we need to associate su with sunit and sw with swidth.
> >>
> >> Signed-by-off: Wu Guanghao <wuguanghao3@huawei.com>
> >> ---
> >>  mkfs/xfs_mkfs.c | 2 +-
> >>  1 file changed, 1 insertion(+), 1 deletion(-)
> >>
> >> diff --git a/mkfs/xfs_mkfs.c b/mkfs/xfs_mkfs.c
> >> index dd3360dc..c667b904 100644
> >> --- a/mkfs/xfs_mkfs.c
> >> +++ b/mkfs/xfs_mkfs.c
> >> @@ -993,7 +993,7 @@ usage( void )
> >>  /* metadata */         [-m crc=0|1,finobt=0|1,uuid=xxx,rmapbt=0|1,reflink=0|1,\n\
> >>                             inobtcount=0|1,bigtime=0|1]\n\
> >>  /* data subvol */      [-d agcount=n,agsize=n,file,name=xxx,size=num,\n\
> >> -                           (sunit=value,swidth=value|su=num,sw=num|noalign),\n\
> >> +                           (sunit=value|su=num,swidth=value|sw=num,noalign),\n\
> >
> > Doesn't mkfs require sunit/swidth or su/sw to be used together, but not
> > intermixed?
> >
> > --D
> >
> 
> I think the '|' in usage() should be related to the modification of the same feature,
> so there is also 'sunit|su' in the -l parameter. There are already other prompts for
> mixed use of su/sw, and I don’t think there is a need to remind it in usage().
> The current 'swidth=value|su=num' prompt makes me think that the two modifications
> are the same. There may be other people who think so too, so I suggest changing
> the description.

The | suggests either one or another value, and that is what it is doing on the
other options.

finobt=0|1  ... rmapbt=0|1 ... etc.

Same applies here:

Either you use: sunit=value,swidth=value OR su=num,sw=num.

The -l option has the same principle:

-l ...  sunit=value|su=num

You either use sunit=value OR su=num.

Carlos
> 
> >>                             sectsize=num\n\
> >>  /* force overwrite */  [-f]\n\
> >>  /* inode size */       [-i perblock=n|size=num,maxpct=n,attr=0|1|2,\n\
> >> --
> >> 2.27.0
> >>
> >
> > .
> >
diff mbox series

Patch

diff --git a/mkfs/xfs_mkfs.c b/mkfs/xfs_mkfs.c
index dd3360dc..c667b904 100644
--- a/mkfs/xfs_mkfs.c
+++ b/mkfs/xfs_mkfs.c
@@ -993,7 +993,7 @@  usage( void )
 /* metadata */         [-m crc=0|1,finobt=0|1,uuid=xxx,rmapbt=0|1,reflink=0|1,\n\
                            inobtcount=0|1,bigtime=0|1]\n\
 /* data subvol */      [-d agcount=n,agsize=n,file,name=xxx,size=num,\n\
-                           (sunit=value,swidth=value|su=num,sw=num|noalign),\n\
+                           (sunit=value|su=num,swidth=value|sw=num,noalign),\n\
                            sectsize=num\n\
 /* force overwrite */  [-f]\n\
 /* inode size */       [-i perblock=n|size=num,maxpct=n,attr=0|1|2,\n\