populate: support compressing metadumps

[xfstests-dev.git] / README

diff --git a/README b/README
index 094a77422ea1c7a50928c59925da1e7a4ea65ed2..569b574ad512d97823444e975e05e73d88550a5c 100644 (file)
--- a/README
+++ b/README
@@ -6,15 +6,15 @@ _______________________
 - install prerequisite packages
   For example, for Ubuntu:
        sudo apt-get install xfslibs-dev uuid-dev libtool-bin \
-       e2fsprogs automake gcc libuuid1 quota attr libattr1-dev make \
+       e2fsprogs automake gcc libuuid1 quota attr make \
        libacl1-dev libaio-dev xfsprogs libgdbm-dev gawk fio dbench \
-       uuid-runtime python sqlite3
+       uuid-runtime python sqlite3 liburing-dev
   For Fedora, RHEL, or CentOS:
        yum install acl attr automake bc dbench dump e2fsprogs fio \
        gawk gcc indent libtool lvm2 make psmisc quota sed \
        xfsdump xfsprogs \
-       libacl-devel libattr-devel libaio-devel libuuid-devel \
-       xfsprogs-devel btrfs-progs-devel python sqlite
+       libacl-devel libaio-devel libuuid-devel \
+       xfsprogs-devel btrfs-progs-devel python sqlite liburing-devel
        (Older distributions may require xfsprogs-qa-devel as well.)
        (Note that for RHEL and CentOS, you may need the EPEL repo.)
 - run make
@@ -22,6 +22,10 @@ _______________________
 - create fsgqa test user ("sudo useradd -m fsgqa")
 - create fsgqa group ("sudo groupadd fsgqa")
 - create 123456-fsgqa test user ("sudo useradd 123456-fsgqa")
+  this 2nd user creation step can be safely skipped if your system
+  doesn't support names starting with digits, only a handful of tests
+  require it.
+- create fsgqa2 test user ("sudo useradd fsgqa2")
 
 ______________________
 USING THE FSQA SUITE
@@ -102,6 +106,16 @@ Preparing system for tests:
              - set USE_KMEMLEAK=yes to scan for memory leaks in the kernel
                after every test, if the kernel supports kmemleak.
              - set KEEP_DMESG=yes to keep dmesg log after test
+             - Set TEST_FS_MODULE_RELOAD=1 to unload the module and reload
+               it between test invocations.  This assumes that the name of
+               the module is the same as FSTYP.
+             - Set DUMP_CORRUPT_FS=1 to record metadata dumps of XFS
+               filesystems if a filesystem check fails.
+             - Set DUMP_COMPRESSOR to a compression program to compress
+               metadumps of filesystems.  This program must accept '-f' and the
+               name of a file to compress; and it must accept '-d -f -k' and
+               the name of a file to decompress.  In other words, it must
+               emulate gzip.
 
         - or add a case to the switch in common/config assigning
           these variables based on the hostname of your test