llvm-mirror

mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-11-23 03:02:36 +01:00

History

Alex Richardson f82a1396d4 [lit] Remove ANSI control characters from xunit output Failing test output sometimes contains control characters like \x1b (e.g. if there was some -fcolor-diagnostics output) which are not allowed inside XML files. This causes problems with CI systems: for example, the Jenkins JUnit XML will throw an exception when ecountering those characters and similar problems also occur with GitLab CI. Reviewed By: yln, jdenny Differential Revision: https://reviews.llvm.org/D84233		2020-08-06 09:16:52 +01:00
..
examples
lit	[lit] Remove ANSI control characters from xunit output	2020-08-06 09:16:52 +01:00
tests	[lit] Remove ANSI control characters from xunit output	2020-08-06 09:16:52 +01:00
utils
CMakeLists.txt
lit.py
MANIFEST.in
README.txt
setup.py	[lit] Avoid global imports in module declaration	2020-03-27 12:07:19 -07: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