diff mbox series

[xfsprogs,6.12] man: document the -n parent mkfs option

Message ID 20241128022942.GV9438@frogsfrogsfrogs (mailing list archive)
State New
Headers show
Series [xfsprogs,6.12] man: document the -n parent mkfs option | expand

Commit Message

Darrick J. Wong Nov. 28, 2024, 2:29 a.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>
---
This fell out at some point when hch and I were refactoring parent
pointers; can this be included in 6.12?
---
 man/man8/mkfs.xfs.8.in |   14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

Comments

Christoph Hellwig Nov. 28, 2024, 3:33 a.m. UTC | #1 
On Wed, Nov 27, 2024 at 06:29:42PM -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>

Looks good:

Reviewed-by: Christoph Hellwig <hch@lst.de>
diff mbox series

Patch

diff --git a/man/man8/mkfs.xfs.8.in b/man/man8/mkfs.xfs.8.in
index a854b0e87cb1a2..95b3d42700cf0e 100644
--- a/man/man8/mkfs.xfs.8.in
+++ b/man/man8/mkfs.xfs.8.in
@@ -900,8 +900,20 @@  .SH OPTIONS
 
 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