fstests: Replace all __[u]intNN_t types with standard [u]intNN_t
[xfstests-dev.git] / README.overlay
1
2 To run xfstest on overlayfs, configure the variables of TEST and SCRATCH
3 partitions to be used as the "base fs" and run './check -overlay'.
4
5 For example, the following config file can be used to run tests on
6 xfs test/scratch partitions:
7
8  TEST_DEV=/dev/sda5
9  TEST_DIR=/mnt/test
10  SCRATCH_DEV=/dev/sda6
11  SCRATCH_MNT=/mnt/scratch
12  FSTYP=xfs
13
14 Using the same config file, but executing './check -overlay' will
15 use the same partitions as base fs for overlayfs directories
16 and set TEST_DIR/SCRATCH_MNT values to overlay mount points, i.e.:
17 /mnt/test/ovl-mnt and /mnt/scratch/ovl-mnt, for the context of
18 individual tests.
19
20 './check -overlay' does not support mkfs and fsck on the base fs, so
21 the base fs should be pre-formatted before starting the -overlay run.
22 An easy way to accomplish this is by running './check <some test>' once,
23 before running './check -overlay'.
24
25 Because of the lack of mkfs support, multi-section config files are only
26 partly supported with './check -overlay'. Only multi-section files that
27 do not change FSTYP and MKFS_OPTIONS can be safely used with -overlay.
28
29 For example, the following multi-section config file can be used to
30 run overlay tests on the same base fs, but with different mount options:
31
32  [xfs]
33  TEST_DEV=/dev/sda5
34  TEST_DIR=/mnt/test
35  SCRATCH_DEV=/dev/sda6
36  SCRATCH_MNT=/mnt/scratch
37  FSTYP=xfs
38
39  [xfs_pquota]
40  MOUNT_OPTIONS="-o pquota"
41  TEST_FS_MOUNT_OPTS="-o noatime"
42  OVERLAY_MOUNT_OPTIONS="-o redirect_dir=off"
43
44 In the example above, MOUNT_OPTIONS will be used to mount the base scratch fs,
45 TEST_FS_MOUNT_OPTS will be used to mount the base test fs and
46 OVERLAY_MOUNT_OPTIONS will be used to mount both test and scratch overlays.