5 lit - LLVM Integrated Tester
9 B<lit> [I<options>] [I<tests>]
13 B<lit> is a portable tool for executing LLVM and Clang style test suites,
14 summarizing their results, and providing indication of failures. B<lit> is
15 designed to be a lightweight testing tool with as simple a user interface as
18 B<lit> should be run with one or more I<tests> to run specified on the command
19 line. Tests can be either individual test files or directories to search for
20 tests (see L<"TEST DISCOVERY">).
22 Each specified test will be executed (potentially in parallel) and once all
23 tests have been run B<lit> will print summary information on the number of tests
24 which passed or failed (see L<"TEST STATUS RESULTS">). The B<lit> program will
25 execute with a non-zero exit code if any tests fail.
27 By default B<lit> will use a succinct progress display and will only print
28 summary information for test failures. See L<"OUTPUT OPTIONS"> for options
29 controlling the B<lit> progress display and output.
31 B<lit> also includes a number of options for controlling how tests are exected
32 (specific features may depend on the particular test format). See L<"EXECUTION
33 OPTIONS"> for more information.
35 Finally, B<lit> also supports additional options for only running a subset of
36 the options specified on the command line, see L<"SELECTION OPTIONS"> for
39 =head1 GENERAL OPTIONS
43 =item B<-h>, B<--help>
45 Show the B<lit> help message.
47 =item B<-j> I<N>, B<--threads>=I<N>
49 Run I<N> tests in parallel. By default, this is automatically chose to match the
50 number of detected available CPUs.
52 =item B<--config-prefix>=I<NAME>
54 Search for I<NAME.cfg> and I<NAME.site.cfg> when searching for test suites,
55 instead I<lit.cfg> and I<lit.site.cfg>.
57 =item B<--param> I<NAME>, B<--param> I<NAME>=I<VALUE>
59 Add a user defined parameter I<NAME> with the given I<VALUE> (or the empty
60 string if not given). The meaning and use of these parameters is test suite
69 =item B<-q>, B<--quiet>
71 Suppress any output except for test failures.
73 =item B<-s>, B<--succinct>
75 Show less output, for example don't show information on tests that pass.
77 =item B<-v>, B<--verbose>
79 Show more information on test failures, for example the entire test output
80 instead of just the test result.
82 =item B<--no-progress-bar>
84 Do not use curses based progress bar.
88 =head1 EXECUTION OPTIONS
92 =item B<--path>=I<PATH>
94 Specify an addition I<PATH> to use when searching for executables in tests.
98 Run individual tests under valgrind (using the memcheck tool). The
99 I<--error-exitcode> argument for valgrind is used so that valgrind failures will
100 cause the program to exit with a non-zero status.
102 =item B<--vg-arg>=I<ARG>
104 When I<--vg> is used, specify an additional argument to pass to valgrind itself.
106 =item B<--time-tests>
108 Track the wall time individual tests take to execute and includes the results in
109 the summary output. This is useful for determining which tests in a test suite
110 take the most time to execute. Note that this option is most useful with I<-j
115 =head1 SELECTION OPTIONS
119 =item B<--max-tests>=I<N>
121 Run at most I<N> tests and then terminate.
123 =item B<--max-time>=I<N>
125 Spend at most I<N> seconds (approximately) running tests and then terminate.
129 Run the tests in a random order.
133 =head1 ADDITIONAL OPTIONS
139 Run B<lit> in debug mode, for debugging configuration issues and B<lit> itself.
141 =item B<--show-suites>
143 List the discovered test suites as part of the standard output.
145 =item B<--no-tcl-as-sh>
147 Run Tcl scripts internally (instead of converting to shell scripts).
153 B<lit> will exit with an exit code of 1 if there are any FAIL or XPASS
154 results. Otherwise, it will exit with the status 0. Other exit codes used for
155 non-test related failures (for example a user error or an internal program
158 =head1 TEST DISCOVERY
160 The inputs passed to B<lit> can be either individual tests, or entire
161 directories or hierarchies of tests to run. When B<lit> starts up, the first
162 thing it does is convert the inputs into a complete list of tests to run as part
163 of I<test discovery>.
165 In the B<lit> model, every test must exist inside some I<test suite>. B<lit>
166 resolves the inputs specified on the command line to test suites by searching
167 upwards from the input path until it finds a I<lit.cfg> or I<lit.site.cfg>
168 file. These files serve as both a marker of test suites and as configuration
169 files which B<lit> loads in order to understand how to find and run the tests
170 inside the test suite.
172 Once B<lit> has mapped the inputs into test suites it traverses the list of
173 inputs adding tests for individual files and recursively searching for tests in
176 This behavior makes it easy to specify a subset of tests to run, while still
177 allowing the test suite configuration to control exactly how tests are
178 interpreted. In addition, B<lit> always identifies tests by the test suite they
179 are in, and their relative path inside the test suite. For appropriately
180 configured projects, this allows B<lit> to provide convenient and flexible
181 support for out-of-tree builds.
183 =head1 TEST STATUS RESULTS
185 Each test ultimately produces one of the following six results:
195 The test failed, but that is expected. This is used for test formats which allow
196 specifying that a test does not currently work, but wish to leave it in the test
201 The test succeeded, but it was expected to fail. This is used for tests which
202 were specified as expected to fail, but are now succeeding (generally because
203 the feautre they test was broken and has been fixed).
211 The test result could not be determined. For example, this occurs when the test
212 could not be run, the test itself is invalid, or the test was interrupted.
216 The test is not supported in this environment. This is used by test formats
217 which can report unsupported tests.
221 Depending on the test format tests may produce additional information about
222 their status (generally only for failures). See the L<Output|"LIT OUTPUT">
223 section for more information.
231 Written by Daniel Dunbar and maintained by the LLVM Team (L<http://llvm.org>).