xfs: Verify correctness of upgrading an fs to support large extent counters

[xfstests-dev.git] / README.overlay

diff --git a/README.overlay b/README.overlay
index 30b5ddb2d1c3bc93ea2cd6577a2e5bc212e9b363..ec4671c39698e48640132023183bccf426e213f5 100644 (file)
--- a/README.overlay
+++ b/README.overlay
@@ -31,7 +31,8 @@ partly supported with './check -overlay'. Only multi-section files that
 do not change FSTYP and MKFS_OPTIONS can be safely used with -overlay.
 
 For example, the following multi-section config file can be used to
-run overlay tests on the same base fs, but with different mount options:
+run overlay tests on the same base fs, but with different mount options, and on
+top of idmapped mounts:
 
  [xfs]
  TEST_DEV=/dev/sda5
@@ -46,7 +47,25 @@ run overlay tests on the same base fs, but with different mount options:
  OVERLAY_MOUNT_OPTIONS="-o redirect_dir=off"
  OVERLAY_FSCK_OPTIONS="-n -o redirect_dir=off"
 
+ [idmapped]
+ IDMAPPED_MOUNTS=true
+
 In the example above, MOUNT_OPTIONS will be used to mount the base scratch fs,
 TEST_FS_MOUNT_OPTS will be used to mount the base test fs,
 OVERLAY_MOUNT_OPTIONS will be used to mount both test and scratch overlay and
 OVERLAY_FSCK_OPTIONS will be used to check both test and scratch overlay.
+
+
+Unionmount Testsuite
+====================
+
+xfstests can be used as a test harness to run unionmount testsuite test cases
+and provide extended test coverage for overlayfs.
+
+To enable running unionmount testsuite, clone the git repository from:
+  https://github.com/amir73il/unionmount-testsuite.git
+under the xfstests src directory, or set the environment variable
+UNIONMOUNT_TESTSUITE to the local path where the repository was cloned.
+
+Run './check -overlay -g overlay/union' to execute all the unionmount testsuite
+test cases.