blob: 45cd8db2fbf948ca090e4661072c8ad74dda448b [file] [log] [blame]
Daniel Dunbar91b42982014-03-10 21:58:12 +00001===============================
2 lit - A Software Testing Tool
3===============================
4
5lit is a portable tool for executing LLVM and Clang style test suites,
6summarizing their results, and providing indication of failures. lit is designed
7to be a lightweight testing tool with as simple a user interface as possible.
8
Daniel Dunbar5a751c62016-09-27 18:58:50 +00009=====================
10 Contributing to lit
11=====================
12
13Please read the TODO file in this directory for ideas on what to work on.
14Before submitting patches, run the test suite to ensure nothing has regressed:
15
16 # From within your LLVM source directory.
17 utils/lit/lit.py \
18 --path /path/to/your/llvm/build/bin \
19 utils/lit/tests
20
21Note that lit's tests depend on 'not' and 'FileCheck', LLVM utilities.
22You will need to have built LLVM tools in order to run lit's test suite
23successfully.
24
Brian Gesiakae8c2512016-10-22 17:27:31 +000025You'll also want to confirm that lit continues to work when testing LLVM.
26Follow the instructions in http://llvm.org/docs/TestingGuide.html to run the
27regression test suite:
28
29 make check-llvm
30
31And be sure to run the llvm-lit wrapper script as well:
32
33 /path/to/your/llvm/build/bin/llvm-lit utils/lit/tests
34
35Finally, make sure lit works when installed via setuptools:
36
37 python utils/lit/setup.py install
38 lit --path /path/to/your/llvm/build/bin utils/lit/tests
39