llvm-project/llvm/utils/lit
Alex Lorenz 32837a60ac [lit] Drop the user-site packages directory from search paths when running tests
Do not add user-site packages directory to the python search path.
This avoids test failures if there's an incompatible lit module installed
inside the user-site packages directory, as it gets prioritized over the lit
from the PYTHONPATH.
2019-10-27 13:31:02 -07:00
..
examples Fix lit/example/many-tests pickling issue 2018-09-14 19:44:09 +00:00
lit [lit] Move sharding logic into separate function 2019-10-25 16:23:52 -07:00
tests [lit] Drop the user-site packages directory from search paths when running tests 2019-10-27 13:31:02 -07:00
utils
CMakeLists.txt [lit] Add a test for the builtin config map. 2017-09-21 16:18:28 +00:00
MANIFEST.in lit: Make sure the builtin_commands directory is packaged by setup.py 2018-09-26 14:56:11 +00:00
README.txt
lit.py [lit] Undo the patch to stop writing pyc files. 2017-09-20 20:31:24 +00:00
setup.py lit: Use a License classifier that pypi will accept 2019-08-08 17:23:33 +00:00

README.txt

===============================
 lit - A Software Testing Tool
===============================

lit is a portable tool for executing LLVM and Clang style test suites,
summarizing their results, and providing indication of failures. lit is designed
to be a lightweight testing tool with as simple a user interface as possible.

=====================
 Contributing to lit
=====================

Please browse the Test Suite > lit category in LLVM's Bugzilla for ideas on
what to work on.

Before submitting patches, run the test suite to ensure nothing has regressed:

    # From within your LLVM source directory.
    utils/lit/lit.py \
        --path /path/to/your/llvm/build/bin \
        utils/lit/tests

Note that lit's tests depend on 'not' and 'FileCheck', LLVM utilities.
You will need to have built LLVM tools in order to run lit's test suite
successfully.

You'll also want to confirm that lit continues to work when testing LLVM.
Follow the instructions in http://llvm.org/docs/TestingGuide.html to run the
regression test suite:

    make check-llvm

And be sure to run the llvm-lit wrapper script as well:

    /path/to/your/llvm/build/bin/llvm-lit utils/lit/tests

Finally, make sure lit works when installed via setuptools:

    python utils/lit/setup.py install
    lit --path /path/to/your/llvm/build/bin utils/lit/tests