[3/4] man: update mkfs.xfs inode flag option documentation
diff mbox series

Message ID 159736125533.3063459.18063990185908155478.stgit@magnolia
State New
Headers show
Series
  • xfsprogs: various small enhancements
Related show

Commit Message

Darrick J. Wong Aug. 13, 2020, 11:27 p.m. UTC
From: Darrick J. Wong <darrick.wong@oracle.com>

The mkfs manpage says that the extent size, cow extent size, realtime,
and project id inheritance bits are passed on to "newly created
children".  This isn't technically true -- it's only passed on to newly
created regular files and directories.  It is not passed on to special
files.

Fix this minor inaccuracy in the documentation.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
---
 man/man8/mkfs.xfs.8 |   12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

Comments

Christoph Hellwig Aug. 17, 2020, 6:54 a.m. UTC | #1
On Thu, Aug 13, 2020 at 04:27:35PM -0700, Darrick J. Wong wrote:
> From: Darrick J. Wong <darrick.wong@oracle.com>
> 
> The mkfs manpage says that the extent size, cow extent size, realtime,
> and project id inheritance bits are passed on to "newly created
> children".  This isn't technically true -- it's only passed on to newly
> created regular files and directories.  It is not passed on to special
> files.
> 
> Fix this minor inaccuracy in the documentation.
> 
> Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>

Looks good,

Reviewed-by: Christoph Hellwig <hch@lst.de>
Carlos Maiolino Aug. 17, 2020, 11:27 a.m. UTC | #2
On Thu, Aug 13, 2020 at 04:27:35PM -0700, Darrick J. Wong wrote:
> From: Darrick J. Wong <darrick.wong@oracle.com>
> 
> The mkfs manpage says that the extent size, cow extent size, realtime,
> and project id inheritance bits are passed on to "newly created
> children".  This isn't technically true -- it's only passed on to newly
> created regular files and directories.  It is not passed on to special
> files.
> 
> Fix this minor inaccuracy in the documentation.
> 
> Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
> ---

Reviewed-by: Carlos Maiolino <cmaiolino@redhat.com>

>  man/man8/mkfs.xfs.8 |   12 ++++++++----
>  1 file changed, 8 insertions(+), 4 deletions(-)
> 
> 
> diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8
> index 9d762a43011a..7d3f3552ff12 100644
> --- a/man/man8/mkfs.xfs.8
> +++ b/man/man8/mkfs.xfs.8
> @@ -285,7 +285,8 @@ Set the copy-on-write extent size hint on all inodes created by
>  .BR mkfs.xfs "."
>  The value must be provided in units of filesystem blocks.
>  If the value is zero, the default value (currently 32 blocks) will be used.
> -Directories will pass on this hint to newly created children.
> +Directories will pass on this hint to newly created regular files and
> +directories.
>  .TP
>  .BI name= value
>  This can be used to specify the name of the special file containing
> @@ -380,20 +381,23 @@ this information.
>  If set, all inodes created by
>  .B mkfs.xfs
>  will be created with the realtime flag set.
> -Directories will pass on this flag to newly created children.
> +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.
> -Directories will pass on the project id to newly created children.
> +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.
>  The value must be provided in units of filesystem blocks.
> -Directories will pass on this hint to newly created children.
> +Directories will pass on this hint to newly created regular files and
> +directories.
>  .RE
>  .TP
>  .B \-f
>

Patch
diff mbox series

diff --git a/man/man8/mkfs.xfs.8 b/man/man8/mkfs.xfs.8
index 9d762a43011a..7d3f3552ff12 100644
--- a/man/man8/mkfs.xfs.8
+++ b/man/man8/mkfs.xfs.8
@@ -285,7 +285,8 @@  Set the copy-on-write extent size hint on all inodes created by
 .BR mkfs.xfs "."
 The value must be provided in units of filesystem blocks.
 If the value is zero, the default value (currently 32 blocks) will be used.
-Directories will pass on this hint to newly created children.
+Directories will pass on this hint to newly created regular files and
+directories.
 .TP
 .BI name= value
 This can be used to specify the name of the special file containing
@@ -380,20 +381,23 @@  this information.
 If set, all inodes created by
 .B mkfs.xfs
 will be created with the realtime flag set.
-Directories will pass on this flag to newly created children.
+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.
-Directories will pass on the project id to newly created children.
+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.
 The value must be provided in units of filesystem blocks.
-Directories will pass on this hint to newly created children.
+Directories will pass on this hint to newly created regular files and
+directories.
 .RE
 .TP
 .B \-f