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