fstests: add fio perf results support

[xfstests-dev.git] / README

diff --git a/README b/README
index a9da4f00789abf798a00486b22922139a2268a88..ed69332e774e3a9ccf44fdd6f79f32723bad40ce 100644 (file)
--- a/README
+++ b/README
@@ -8,13 +8,13 @@ _______________________
        sudo apt-get install xfslibs-dev uuid-dev libtool-bin \
        e2fsprogs automake gcc libuuid1 quota attr libattr1-dev make \
        libacl1-dev libaio-dev xfsprogs libgdbm-dev gawk fio dbench \
-       uuid-runtime
+       uuid-runtime python sqlite3
   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
+       xfsprogs-devel btrfs-progs-devel python sqlite
        (Older distributions may require xfsprogs-qa-devel as well.)
        (Note that for RHEL and CentOS, you may need the EPEL repo.)
 - run make
@@ -93,6 +93,12 @@ Preparing system for tests:
                It is no longer necessary to set TEST_XFS_SCRUB.
              - setenv LOGWRITES_DEV to a block device to use for power fail
                testing.
+             - setenv PERF_CONFIGNAME to a arbitrary string to be used for
+               identifying the test setup for running perf tests.  This should
+               be different for each type of performance test you wish to run so
+               that relevant results are compared.  For example 'spinningrust'
+               for configurations that use spinning disks and 'nvme' for tests
+               using nvme drives.
 
         - or add a case to the switch in common/config assigning
           these variables based on the hostname of your test