check: Allow to recreate TEST_DEV
[xfstests-dev.git] / README.config-sections
1 Configuration file with sections
2 ================================
3
4 Configuration file with sections is useful for running xfstests on multiple
5 file systems, or multiple file system setups in a single run without any
6 help of external scripts.
7
8
9 Syntax
10 ------
11
12 Syntax for defining a section is the following:
13
14         [section_name]
15
16 Section name should consist of alphanumeric characters and '_'. Anything
17 else is forbidden and the section will not be recognised.
18
19 Each section in the configuration file should contain options in the format
20
21         OPTION=value
22
23 'OPTION' must not contain any white space characters. 'value' can contain
24 any character you want with one simple limitation - characters ' and " can
25 only appear at the start and end of the 'value', however it is not required.
26
27 Note that options are carried between sections so the same options does not
28 have to be specified in each and every sections. However caution should be
29 exercised not to leave unwanted options set from previous sections.
30
31
32 Results
33 -------
34
35 For every section xfstests will run with specified options and will produce
36 separate results in the '$RESULT_BASE/$section_name' directory.
37
38
39 Multiple file systems
40 ---------------------
41
42 Having different file systems in different config sections is allowed. When
43 FSTYP differs in the following section the FSTYP file system will be created
44 automatically before running the test.
45
46 Note that if MOUNT_OPTIONS, MKFS_OPTIONS, or FSCK_OPTIONS are not directly
47 specified in the section it will be reset to the default for a given file
48 system.
49
50 You can also force the file system recreation by specifying RECREATE_TEST_DEV.
51
52
53 Example
54 -------
55
56 Here is an example of config file with sections:
57
58 [ext4_4k_block_size]
59 TEST_DEV=/dev/sda
60 TEST_DIR=/mnt/test
61 SCRATCH_DEV=/dev/sdb
62 SCRATCH_MNT=/mnt/test1
63 MKFS_OPTIONS="-q -F -b4096"
64 FSTYP=ext4
65 RESULT_BASE="`pwd`/results/`date +%d%m%y_%H%M%S`"
66
67 [ext4_1k_block_size]
68 MKFS_OPTIONS="-q -F -b1024"
69
70 [ext4_nojournal]
71 MKFS_OPTIONS="-q -F -b4096 -O ^has_journal"
72
73 [xfs_filesystem]
74 MKFS_OPTIONS="-f"
75 FSTYP=xfs
76
77 [ext3_filesystem]
78 FSTYP=ext3
79 MOUNT_OPTIONS="-o noatime"