From: Darrick J. Wong <djwong@kernel.org>
Date: Wed, 27 Nov 2024 22:13:50 +0000 (-0800)
Subject: man: document the -n parent mkfs option
X-Git-Tag: v6.13.0~213
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=98bf9c3b811be6980d80208a1cd78d76b5ab96db;p=thirdparty%2Fxfsprogs-dev.git

man: document the -n parent mkfs option

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>
Reviewed-by: Christoph Hellwig <hch@lst.de>
---

diff --git a/man/man8/mkfs.xfs.8.in b/man/man8/mkfs.xfs.8.in
index a854b0e8..e56c8f31 100644
--- a/man/man8/mkfs.xfs.8.in
+++ b/man/man8/mkfs.xfs.8.in
@@ -902,6 +902,18 @@ When CRCs are enabled (the default), the ftype functionality is always
 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