src/open_by_handle: flexible usage options

[xfstests-dev.git] / doc / requirement-checking.txt

diff --git a/doc/requirement-checking.txt b/doc/requirement-checking.txt
index f3fc9f49eba2a61bbac9a158406eec3437713c94..95d10e64495ec430a8ee8464111f4039271772fc 100644 (file)
--- a/doc/requirement-checking.txt
+++ b/doc/requirement-checking.txt
@@ -12,7 +12,12 @@ they have.  This is done with _require_<xxx> macros, which may take parameters.
        _require_test_program <name>
        _require_xfs_io_command <name> [<switch>]
 
- (2) System call requirements.
+ (2) Filesystem capability requirements.
+
+       _require_chattr <letters>
+       _require_exportfs
+
+ (3) System call requirements.
 
        _require_statx
 
@@ -67,6 +72,28 @@ _require_xfs_io_command <name> [<switch>]
      the +x and -x arguments (DAX attribute).
 
 
+==================================
+FILESYSTEM CAPABILITY REQUIREMENTS
+==================================
+
+_require_chattr <letters>
+
+     The test requires that the filesystem attribute set by the chattr command
+     with +<letters> as an argument be available and supported by the $TEST_DEV
+     filesystem.  No check is made of the scratch filesystem.  For example:
+
+       _require_chattr ai
+
+     tests to see if setting the append-only and immutable attributes on a file
+     (chattr +a +i) is supported.
+
+_require_exportfs
+
+     The test requires that the $TEST_DEV filesystem supports NFS export.
+     The test also requires the use of the open_by_handle_at() system call and
+     will be skipped if it isn't available in the kernel.
+
+
 ========================
 SYSTEM CALL REQUIREMENTS
 ========================