diff mbox series

[1.5/5] mkfs: clarify valid "inherit" option values

Message ID d59f5cbc-42b0-70f0-5471-210f87bf0fe3@sandeen.net (mailing list archive)
State Superseded, archived
Headers show
Series None | expand

Commit Message

Eric Sandeen Oct. 27, 2020, 5:24 p.m. UTC
Clarify which values are valid for the various *inherit= mkfs
options.

Signed-off-by: Eric Sandeen <sandeen@redhat.com>
---

Comments

Darrick J. Wong Oct. 27, 2020, 5:40 p.m. UTC | #1
On Tue, Oct 27, 2020 at 12:24:29PM -0500, Eric Sandeen wrote:
> Clarify which values are valid for the various *inherit= mkfs
> options.
> 
> Signed-off-by: Eric Sandeen <sandeen@redhat.com>
> ---
> 
> diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8
> index 0a785874..a2be066b 100644
> --- a/man/man8/mkfs.xfs.8
> +++ b/man/man8/mkfs.xfs.8
> @@ -377,21 +377,21 @@ This option disables automatic geometry detection and creates the filesystem
>  without stripe geometry alignment even if the underlying storage device provides
>  this information.
>  .TP
> -.BI rtinherit= value
> -If set, all inodes created by
> +.BI rtinherit= [0|1]
> +If set to 1, all inodes created by
>  .B mkfs.xfs
>  will be created with the realtime flag set.
>  Directories will pass on this flag to newly created regular files and
>  directories.
>  .TP
> -.BI projinherit= value
> +.BI projinherit= projid
>  All inodes created by
>  .B mkfs.xfs
>  will be assigned this project quota id.
>  Directories will pass on the project id to newly created regular files and
>  directories.
>  .TP
> -.BI extszinherit= value
> +.BI extszinherit= extentsize

Hmm... if you're going to make this change to extszinherit, you might as
well do the same for cowextsize.

With that fixed,
Reviewed-by: Darrick J. Wong <darrick.wong@oracle.com>

--D

>  All inodes created by
>  .B mkfs.xfs
>  will have this extent size hint applied.
> @@ -399,8 +399,8 @@ The value must be provided in units of filesystem blocks.
>  Directories will pass on this hint to newly created regular files and
>  directories.
>  .TP
> -.BI daxinherit= value
> -If set, all inodes created by
> +.BI daxinherit= [0|1]
> +If set to 1, all inodes created by
>  .B mkfs.xfs
>  will be created with the DAX flag set.
>  Directories will pass on this flag to newly created regular files and
>
Eric Sandeen Oct. 27, 2020, 5:49 p.m. UTC | #2
On 10/27/20 12:40 PM, Darrick J. Wong wrote:
> On Tue, Oct 27, 2020 at 12:24:29PM -0500, Eric Sandeen wrote:
>> Clarify which values are valid for the various *inherit= mkfs
>> options.
>>
>> Signed-off-by: Eric Sandeen <sandeen@redhat.com>
>> ---
>>
>> diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8
>> index 0a785874..a2be066b 100644
>> --- a/man/man8/mkfs.xfs.8
>> +++ b/man/man8/mkfs.xfs.8
>> @@ -377,21 +377,21 @@ This option disables automatic geometry detection and creates the filesystem
>>  without stripe geometry alignment even if the underlying storage device provides
>>  this information.
>>  .TP
>> -.BI rtinherit= value
>> -If set, all inodes created by
>> +.BI rtinherit= [0|1]
>> +If set to 1, all inodes created by
>>  .B mkfs.xfs
>>  will be created with the realtime flag set.
>>  Directories will pass on this flag to newly created regular files and
>>  directories.
>>  .TP
>> -.BI projinherit= value
>> +.BI projinherit= projid
>>  All inodes created by
>>  .B mkfs.xfs
>>  will be assigned this project quota id.
>>  Directories will pass on the project id to newly created regular files and
>>  directories.
>>  .TP
>> -.BI extszinherit= value
>> +.BI extszinherit= extentsize
> 
> Hmm... if you're going to make this change to extszinherit, you might as
> well do the same for cowextsize.

Well, "inherit=" /sounds/ like a boolean, so I figured that one needed clarification,
whereas "size=" seems pretty clear to me, and is described already?

But perhaps it would be more consistent to keep it all as "=value" and then just
more clearly describe the valid *inherit= values in the explanatory text... let me try
a V2 ;)

> With that fixed,
> Reviewed-by: Darrick J. Wong <darrick.wong@oracle.com>
> 
> --D
> 
>
Christoph Hellwig Oct. 28, 2020, 7:32 a.m. UTC | #3
On Tue, Oct 27, 2020 at 12:49:08PM -0500, Eric Sandeen wrote:
> Well, "inherit=" /sounds/ like a boolean, so I figured that one needed clarification,
> whereas "size=" seems pretty clear to me, and is described already?
> 
> But perhaps it would be more consistent to keep it all as "=value" and then just
> more clearly describe the valid *inherit= values in the explanatory text... let me try
> a V2 ;)

Yes, that sounds pretty sensible.
diff mbox series

Patch

diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8
index 0a785874..a2be066b 100644
--- a/man/man8/mkfs.xfs.8
+++ b/man/man8/mkfs.xfs.8
@@ -377,21 +377,21 @@  This option disables automatic geometry detection and creates the filesystem
 without stripe geometry alignment even if the underlying storage device provides
 this information.
 .TP
-.BI rtinherit= value
-If set, all inodes created by
+.BI rtinherit= [0|1]
+If set to 1, all inodes created by
 .B mkfs.xfs
 will be created with the realtime flag set.
 Directories will pass on this flag to newly created regular files and
 directories.
 .TP
-.BI projinherit= value
+.BI projinherit= projid
 All inodes created by
 .B mkfs.xfs
 will be assigned this project quota id.
 Directories will pass on the project id to newly created regular files and
 directories.
 .TP
-.BI extszinherit= value
+.BI extszinherit= extentsize
 All inodes created by
 .B mkfs.xfs
 will have this extent size hint applied.
@@ -399,8 +399,8 @@  The value must be provided in units of filesystem blocks.
 Directories will pass on this hint to newly created regular files and
 directories.
 .TP
-.BI daxinherit= value
-If set, all inodes created by
+.BI daxinherit= [0|1]
+If set to 1, all inodes created by
 .B mkfs.xfs
 will be created with the DAX flag set.
 Directories will pass on this flag to newly created regular files and