aboutsummaryrefslogtreecommitdiffstats
diff options
authorDarrick J. Wong <djwong@kernel.org>2024-11-05 16:43:23 -0800
committerDarrick J. Wong <djwong@kernel.org>2024-11-07 15:23:58 -0800
commit22044056657e7b5d72ff01db12a6a8125fa49bb3 (patch)
tree8157b1c0732fae61d4c0ae21da18591d2635d428
parent91f54d295ec02bb358f61742a9e27ed941f39da5 (diff)
downloadxfs-documentation-online-fsck.tar.gz
design: document filesystem propertiesonline-fsck_2024-11-07online-fsck
Now that xfsprogs utilities can set properties to coordinate the behavior of other xfsprogs utilities, record them in the ondisk format documentation. Signed-off-by: Darrick J. Wong <djwong@kernel.org> Reviewed-by: Christoph Hellwig <hch@lst.de>
-rw-r--r--design/XFS_Filesystem_Structure/fs_properties.asciidoc28
-rw-r--r--design/XFS_Filesystem_Structure/xfs_filesystem_structure.asciidoc2
2 files changed, 30 insertions, 0 deletions
diff --git a/design/XFS_Filesystem_Structure/fs_properties.asciidoc b/design/XFS_Filesystem_Structure/fs_properties.asciidoc
new file mode 100644
index 0000000..b639aec
--- /dev/null
+++ b/design/XFS_Filesystem_Structure/fs_properties.asciidoc
@@ -0,0 +1,28 @@
+[[Filesystem_Properties]]
+= Filesystem Properties
+
+System administrators can set filesystem-wide properties to coordinate the
+behavior of userspace XFS administration tools. These properties are recorded
+as extended attributes of the +ATTR_ROOT+ namesace that are set on the root
+directory.
+
+[options="header"]
+|=====
+| Property | Description
+| +xfs:autofsck+ | Online fsck background scanning behavior
+|=====
+
+*xfs:autofsck*::
+This property controls the behavior of background online fsck.
+Unrecognized values are treated as if the property was not set.
+Check the +xfs_scrub+ manual page for more information.
+
+.autofsck property values
+[options="header"]
+|=====
+| Value | Description
+| +none+ | Do not perform background scans.
+| +check+ | Only check metadata.
+| +optimize+ | Check and optimize metadata.
+| +repair+ | Check, repair, or optimize metadata.
+|=====
diff --git a/design/XFS_Filesystem_Structure/xfs_filesystem_structure.asciidoc b/design/XFS_Filesystem_Structure/xfs_filesystem_structure.asciidoc
index a95a580..689e2a8 100644
--- a/design/XFS_Filesystem_Structure/xfs_filesystem_structure.asciidoc
+++ b/design/XFS_Filesystem_Structure/xfs_filesystem_structure.asciidoc
@@ -84,6 +84,8 @@ include::journaling_log.asciidoc[]
include::internal_inodes.asciidoc[]
+include::fs_properties.asciidoc[]
+
:leveloffset: 0
Dynamically Allocated Structures