Merge tag 'block-5.9-2020-08-14' of git://git.kernel.dk/linux-block
[linux/fpc-iii.git] / tools / memory-model / scripts / README
blob095c7eb36f9f90a38c2acf50a49ec276fa02f097
1                         ============
2                         LKMM SCRIPTS
3                         ============
6 These scripts are run from the tools/memory-model directory.
8 checkalllitmus.sh
10         Run all litmus tests in the litmus-tests directory, checking
11         the results against the expected results recorded in the
12         "Result:" comment lines.
14 checkghlitmus.sh
16         Run all litmus tests in the https://github.com/paulmckrcu/litmus
17         archive that are C-language and that have "Result:" comment lines
18         documenting expected results, comparing the actual results to
19         those expected.
21 checklitmushist.sh
23         Run all litmus tests having .litmus.out files from previous
24         initlitmushist.sh or newlitmushist.sh runs, comparing the
25         herd7 output to that of the original runs.
27 checklitmus.sh
29         Check a single litmus test against its "Result:" expected result.
31 cmplitmushist.sh
33         Compare output from two different runs of the same litmus tests,
34         with the absolute pathnames of the tests to run provided one
35         name per line on standard input.  Not normally run manually,
36         provided instead for use by other scripts.
38 initlitmushist.sh
40         Run all litmus tests having no more than the specified number
41         of processes given a specified timeout, recording the results
42         in .litmus.out files.
44 judgelitmus.sh
46         Given a .litmus file and its .litmus.out herd7 output, check the
47         .litmus.out file against the .litmus file's "Result:" comment to
48         judge whether the test ran correctly.  Not normally run manually,
49         provided instead for use by other scripts.
51 newlitmushist.sh
53         For all new or updated litmus tests having no more than the
54         specified number of processes given a specified timeout, run
55         and record the results in .litmus.out files.
57 parseargs.sh
59         Parse command-line arguments.  Not normally run manually,
60         provided instead for use by other scripts.
62 runlitmushist.sh
64         Run the litmus tests whose absolute pathnames are provided one
65         name per line on standard input.  Not normally run manually,
66         provided instead for use by other scripts.
68 README
70         This file