llvm-project

History

David Tenty 2edc54eded [lit][AIX] Add LIBPATH to pass through env vars AIX uses LIBPATH to specify the library search path in addition to LD_LIBRARY_PATH, and a lot of users / tooling will use it preferentially. In lit we currently pass through LD_LIBRARY_PATH but not LIBPATH in the env on AIX, this patch corrects this inconsistency. Differential Revision: https://reviews.llvm.org/D138510		2022-11-22 17:22:52 -05:00
..
examples	…
lit	[lit][AIX] Add LIBPATH to pass through env vars	2022-11-22 17:22:52 -05:00
tests	[lit] Add `target=<triple>` as a feature keyword	2022-11-16 05:50:45 -08:00
utils	…
CMakeLists.txt	[cmake] Remove unused OUTPUT_MAPPING param to configure_lit_site_cfg(). NFC	2022-03-10 21:26:53 +01:00
LICENSE.TXT	…
MANIFEST.in	…
README.rst	[lit] Deduplicate README and longdescription, and update it	2022-10-29 13:27:00 +02:00
lit.py	…
pyproject.toml	[lit] Add pyproject.toml and fix build w/ modern setuptools backend	2022-11-01 07:30:14 +01:00
setup.py	[lit] Add pyproject.toml and fix build w/ modern setuptools backend	2022-11-01 07:30:14 +01:00

README.rst

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

About
=====

*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.


Features
========

 * Portable!
 * Flexible test discovery.
 * Parallel test execution.
 * Support for multiple test formats and test suite designs.


Documentation
=============

The official *lit* documentation is in the man page, available online at the LLVM
Command Guide: http://llvm.org/cmds/lit.html.


Source
======

The *lit* source is available as part of LLVM, in the LLVM source repository:
https://github.com/llvm/llvm-project/tree/main/llvm/utils/lit


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

Please browse the issues labeled *tools:llvm-lit* in LLVM's issue tracker for
ideas on what to work on:
https://github.com/llvm/llvm-project/labels/tools%3Allvm-lit

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