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

Eric Sandeen
2020-10-27T17:50:47Z

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.
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,