diff mbox series

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

Message ID 04d65a53-00f9-527d-2b4c-c66b1799d2d4@sandeen.net (mailing list archive)
State Superseded
Headers show
Series None | expand

Commit Message

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

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

V2: Keep the same "=value" as elsewhere in the manpage but still clarify
what those values should be and what they do.

Comments

Darrick J. Wong Oct. 27, 2020, 6:37 p.m. UTC | #1
On Tue, Oct 27, 2020 at 12:50:43PM -0500, Eric Sandeen wrote:
> Clarify which values are valid for the various *inherit= mkfs
> options.
> 
> Signed-off-by: Eric Sandeen <sandeen@redhat.com>
> ---
> 
> V2: Keep the same "=value" as elsewhere in the manpage but still clarify
> what those values should be and what they do.
> 
> 
> diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8
> index 0a785874..10ceea30 100644
> --- a/man/man8/mkfs.xfs.8
> +++ b/man/man8/mkfs.xfs.8
> @@ -378,31 +378,38 @@ without stripe geometry alignment even if the underlying storage device provides
>  this information.
>  .TP
>  .BI rtinherit= value
> -If set, all inodes created by
> +If
> +.I value
> +is set to 1, all inodes created by
>  .B mkfs.xfs
> -will be created with the realtime flag set.
> +will be created with the realtime flag set.  Default is 0.

Nit: Start new sentences on a new line.

>  Directories will pass on this flag to newly created regular files and
>  directories.
>  .TP
>  .BI projinherit= value
>  All inodes created by
>  .B mkfs.xfs
> -will be assigned this project quota id.
> +will be assigned the project quota id provided in 

Nit: Blank space at end of line.

> +.I value.
>  Directories will pass on the project id to newly created regular files and
>  directories.
>  .TP
>  .BI extszinherit= value
>  All inodes created by
>  .B mkfs.xfs
> -will have this extent size hint applied.
> +will have this
> +.I value
> +extent size hint applied.
>  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
> +If
> +.I value
> +is set to 1, all inodes created by
>  .B mkfs.xfs
> -will be created with the DAX flag set.
> +will be created with the DAX flag set.  Default is 0.

The first nit again...

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

--D

>  Directories will pass on this flag to newly created regular files and
>  directories.
>  By default,
>
diff mbox series

Patch

diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8
index 0a785874..10ceea30 100644
--- a/man/man8/mkfs.xfs.8
+++ b/man/man8/mkfs.xfs.8
@@ -378,31 +378,38 @@  without stripe geometry alignment even if the underlying storage device provides
 this information.
 .TP
 .BI rtinherit= value
-If set, all inodes created by
+If
+.I value
+is set to 1, all inodes created by
 .B mkfs.xfs
-will be created with the realtime flag set.
+will be created with the realtime flag set.  Default is 0.
 Directories will pass on this flag to newly created regular files and
 directories.
 .TP
 .BI projinherit= value
 All inodes created by
 .B mkfs.xfs
-will be assigned this project quota id.
+will be assigned the project quota id provided in 
+.I value.
 Directories will pass on the project id to newly created regular files and
 directories.
 .TP
 .BI extszinherit= value
 All inodes created by
 .B mkfs.xfs
-will have this extent size hint applied.
+will have this
+.I value
+extent size hint applied.
 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
+If
+.I value
+is set to 1, all inodes created by
 .B mkfs.xfs
-will be created with the DAX flag set.
+will be created with the DAX flag set.  Default is 0.
 Directories will pass on this flag to newly created regular files and
 directories.
 By default,