populate: support compressing metadumps

[xfstests-dev.git] / README

diff --git a/README b/README
index 41f6b5b51663e9d1a69953ecce8209bb6f88f436..569b574ad512d97823444e975e05e73d88550a5c 100644 (file)
--- a/README
+++ b/README
@@ -109,6 +109,13 @@ Preparing system for tests:
              - 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