diff mbox series

[2/2] man: document the -n parent mkfs option

Message ID 173352746331.121646.4339047798362935705.stgit@frogsfrogsfrogs (mailing list archive)
State Not Applicable, archived
Headers show
Series [1/2] man: fix ioctl_xfs_commit_range man page install | expand

Commit Message

Darrick J. Wong Dec. 6, 2024, 11:30 p.m. UTC
From: Darrick J. Wong <djwong@kernel.org>

Document the -n parent option to mkfs.xfs so that users will actually
know how to turn on directory parent pointers.

Signed-off-by: "Darrick J. Wong" <djwong@kernel.org>
---
 man/man8/mkfs.xfs.8.in |   12 ++++++++++++
 1 file changed, 12 insertions(+)

Comments

Darrick J. Wong Dec. 7, 2024, 4:38 a.m. UTC | #1
On Fri, Dec 06, 2024 at 03:30:16PM -0800, Darrick J. Wong wrote:
> From: Darrick J. Wong <djwong@kernel.org>
> 
> Document the -n parent option to mkfs.xfs so that users will actually
> know how to turn on directory parent pointers.
> 
> Signed-off-by: "Darrick J. Wong" <djwong@kernel.org>

Ooooops.  I forgot that hch already RVB'd this:
https://lore.kernel.org/linux-xfs/Z0fkd5si2ibRhehu@infradead.org/

--D

> ---
>  man/man8/mkfs.xfs.8.in |   12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> 
> diff --git a/man/man8/mkfs.xfs.8.in b/man/man8/mkfs.xfs.8.in
> index a854b0e87cb1a2..e56c8f31a52c78 100644
> --- a/man/man8/mkfs.xfs.8.in
> +++ b/man/man8/mkfs.xfs.8.in
> @@ -902,6 +902,18 @@ .SH OPTIONS
>  enabled, and cannot be turned off.
>  .IP
>  In other words, this option is only tunable on the deprecated V4 format.
> +.TP
> +.BI parent= value
> +This feature creates back references from child files to parent directories
> +so that online repair can reconstruct broken directory files.
> +The value is either 0 to disable the feature, or 1 to create parent pointers.
> +
> +By default,
> +.B mkfs.xfs
> +will not create parent pointers.
> +This feature is only available for filesystems created with the (default)
> +.B \-m crc=1
> +option set.
>  .RE
>  .PP
>  .PD 0
> 
>
diff mbox series

Patch

diff --git a/man/man8/mkfs.xfs.8.in b/man/man8/mkfs.xfs.8.in
index a854b0e87cb1a2..e56c8f31a52c78 100644
--- a/man/man8/mkfs.xfs.8.in
+++ b/man/man8/mkfs.xfs.8.in
@@ -902,6 +902,18 @@  .SH OPTIONS
 enabled, and cannot be turned off.
 .IP
 In other words, this option is only tunable on the deprecated V4 format.
+.TP
+.BI parent= value
+This feature creates back references from child files to parent directories
+so that online repair can reconstruct broken directory files.
+The value is either 0 to disable the feature, or 1 to create parent pointers.
+
+By default,
+.B mkfs.xfs
+will not create parent pointers.
+This feature is only available for filesystems created with the (default)
+.B \-m crc=1
+option set.
 .RE
 .PP
 .PD 0