diff --git a/llvm/utils/lit/README.txt b/llvm/utils/lit/README.rst rename from llvm/utils/lit/README.txt rename to llvm/utils/lit/README.rst --- a/llvm/utils/lit/README.txt +++ b/llvm/utils/lit/README.rst @@ -2,16 +2,44 @@ 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. +About +===== -===================== - Contributing to lit -===================== +*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. -Please browse the Test Suite > lit category in LLVM's Bugzilla for ideas on -what to work on. + +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: @@ -20,7 +48,7 @@ --path /path/to/your/llvm/build/bin \ utils/lit/tests -Note that lit's tests depend on 'not' and 'FileCheck', LLVM utilities. +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. diff --git a/llvm/utils/lit/setup.py b/llvm/utils/lit/setup.py --- a/llvm/utils/lit/setup.py +++ b/llvm/utils/lit/setup.py @@ -9,6 +9,9 @@ # to work (for scripts, etc.) os.chdir(os.path.dirname(os.path.abspath(__file__))) +with open("README.rst", "r", encoding="utf-8") as f: + long_description = f.read() + setup( name = "lit", version = lit.__version__, @@ -21,41 +24,7 @@ description = "A Software Testing Tool", keywords = 'test C++ automatic discovery', - long_description = """\ -*lit* -+++++ - -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 -""", + long_description = long_description, classifiers=[ 'Development Status :: 3 - Alpha',