xref: /linux/tools/memory-model/scripts/README (revision ee542816ac83ef72ebc52ce11ff8448463ba62eb)
1			============
2			LKMM SCRIPTS
3			============
4
5
6These scripts are run from the tools/memory-model directory.
7
8checkalllitmus.sh
9
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.
13
14checkghlitmus.sh
15
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.
20
21checklitmushist.sh
22
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.
26
27checklitmus.sh
28
29	Check a single litmus test against its "Result:" expected result.
30
31cmplitmushist.sh
32
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.
37
38initlitmushist.sh
39
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.
43
44judgelitmus.sh
45
46	Given a .litmus file and its herd7 output, check the output file
47	against the .litmus file's "Result:" comment to judge whether
48	the test ran correctly.  Not normally run manually, provided
49	instead for use by other scripts.
50
51newlitmushist.sh
52
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.
56
57parseargs.sh
58
59	Parse command-line arguments.  Not normally run manually,
60	provided instead for use by other scripts.
61
62runlitmushist.sh
63
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.
67
68README
69
70	This file
71