xfs/004: don't fail test due to realtime files

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

diff --git a/doc/requirement-checking.txt b/doc/requirement-checking.txt
index f3fc9f49eba2a61bbac9a158406eec3437713c94..45d2756bd2ceec07cb6b2ed5b4e6997dc0a14f60 100644 (file)
--- a/doc/requirement-checking.txt
+++ b/doc/requirement-checking.txt
@@ -12,10 +12,19 @@ they have.  This is done with _require_<xxx> macros, which may take parameters.
        _require_test_program <name>
        _require_xfs_io_command <name> [<switch>]
 
        _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
 
 
        _require_statx
 

+ (4) Device mapper requirement.
+
+       _require_dm_target
+       _require_log_writes

 
 ====================
 GENERAL REQUIREMENTS
 
 ====================
 GENERAL REQUIREMENTS


@@ -60,13 +69,35 @@ _require_xfs_io_command <name> [<switch>]
      switch.  For example:
 
        _require_xfs_io_command "falloc"
      switch.  For example:
 
        _require_xfs_io_command "falloc"

-       _require_xfs_io_command "chattr" "+/-x"
+       _require_xfs_io_command "chattr" "x"

 
      The first requires that xfs_io support the falloc command and the second
      that it supports the chattr command and that the chattr command supports
      the +x and -x arguments (DAX attribute).
 
 
 
      The first requires that xfs_io support the falloc command and the second
      that it supports the chattr command and that the chattr command supports
      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
 ========================
 ========================
 SYSTEM CALL REQUIREMENTS
 ========================


@@ -75,3 +106,28 @@ _require_statx
 
      The test requires the use of the statx() system call and will be skipped
      if it isn't available in the kernel.
 
      The test requires the use of the statx() system call and will be skipped
      if it isn't available in the kernel.

+
+
+==========================
+DEVICE MAPPER REQUIREMENTS
+==========================
+
+_require_dm_target <name>
+
+     The test requires the use of the device mapper target and will be skipped
+     if it isn't available in the kernel.
+
+_require_log_writes
+
+     The test requires the use of the device mapper target log-writes.
+     The test also requires the test program log-writes/replay-log is built
+     and will be skipped if either isn't available.
+
+======================
+PERF TEST REQUIREMENTS
+======================
+
+_require_fio_results
+
+     This test requires the supporting tools for saving and comparing fio based
+     perf test results.