6d88a6ffa412ad1a024ecd19b7d99f27b059cd1d
[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 Syntax for defining a section is the following:
9
10 [section_name]
11
12 Section name should consist of alphanumeric characters and '_'. Anything
13 else is forbidden and the section will not be recognised.
14
15 Each section in the configuration file should contain options in the format
16
17 OPTION=value
18
19 'OPTION' must not contain any white space characters. 'value' can contain
20 any character you want with one simple limitation - characters ' and " can
21 only appear at the start and end of the 'value', however it is not required.
22
23 Note that options are carried between sections so the same options does not
24 have to be specified in each and every sections. However caution should be
25 exercised not to leave unwanted options set from previous sections.
26
27 For every section xfstests will run with specified options and will produce
28 separate results in the '$RESULT_BASE/$section_name' directory.
29
30 Here is an example of config file with sections:
31
32 [ext4_4k_block_size]
33 TEST_DEV=/dev/sda
34 TEST_DIR=/mnt/test
35 SCRATCH_DEV=/dev/sdb
36 SCRATCH_MNT=/mnt/test1
37 MKFS_OPTIONS="-q -F -b4096"
38 FSTYP=ext4
39
40 [ext4_1k_block_size]
41 MKFS_OPTIONS="-q -F -b1024"
42
43 [ext4_nojournal]
44 MKFS_OPTIONS="-q -F -b4096 -O ^has_journal"
45
46 [ext4_discard_ssd]
47 MKFS_OPTIONS="-q -F -b4096"
48 TEST_DEV=/dev/sdc
49 SCRATCH_DEV=/dev/sdd
50 MOUNT_OPTIONS="-o discard"