70 lines · plain
1===============================2 lit - A Software Testing Tool3===============================4 5About6=====7 8*lit* is a portable tool for executing LLVM and Clang style test suites,9summarizing their results, and providing indication of failures. *lit* is10designed to be a lightweight testing tool with as simple a user interface as11possible.12 13 14Features15========16 17 * Portable!18 * Flexible test discovery.19 * Parallel test execution.20 * Support for multiple test formats and test suite designs.21 22 23Documentation24=============25 26The official *lit* documentation is in the man page, available online at the LLVM27Command Guide: http://llvm.org/cmds/lit.html.28 29 30Source31======32 33The *lit* source is available as part of LLVM, in the LLVM source repository:34https://github.com/llvm/llvm-project/tree/main/llvm/utils/lit35 36 37Contributing to lit38===================39 40Please browse the issues labeled *tools:llvm-lit* in LLVM's issue tracker for41ideas on what to work on:42https://github.com/llvm/llvm-project/labels/tools%3Allvm-lit43 44Before submitting patches, run the test suite to ensure nothing has regressed::45 46 # From within your LLVM source directory.47 utils/lit/lit.py \48 --path /path/to/your/llvm/build/bin \49 utils/lit/tests50 51Note that lit's tests depend on ``not`` and ``FileCheck``, LLVM utilities.52You will need to have built LLVM tools in order to run lit's test suite53successfully.54 55You'll also want to confirm that lit continues to work when testing LLVM.56Follow the instructions in http://llvm.org/docs/TestingGuide.html to run the57regression test suite:58 59 make check-llvm60 61And be sure to run the llvm-lit wrapper script as well:62 63 /path/to/your/llvm/build/bin/llvm-lit utils/lit/tests64 65Finally, make sure lit works when installed via setuptools:66 67 python utils/lit/setup.py install68 lit --path /path/to/your/llvm/build/bin utils/lit/tests69 70