[llvm] edbe8fa - [llvm][Docs] Update guide to include ``pip install lit`` (#106526)
via llvm-commits
llvm-commits at lists.llvm.org
Tue Sep 10 02:13:08 PDT 2024
Author: MichelleCDjunaidi
Date: 2024-09-10T10:13:04+01:00
New Revision: edbe8faba12dd27e48411e3e0b57b19b0dc03929
URL: https://github.com/llvm/llvm-project/commit/edbe8faba12dd27e48411e3e0b57b19b0dc03929
DIFF: https://github.com/llvm/llvm-project/commit/edbe8faba12dd27e48411e3e0b57b19b0dc03929.diff
LOG: [llvm][Docs] Update guide to include ``pip install lit`` (#106526)
Also updates and clarifies which version would be installed.
As per
https://discourse.llvm.org/t/information-on-lit-is-outdated/76498.
Added:
Modified:
llvm/docs/TestSuiteGuide.md
Removed:
################################################################################
diff --git a/llvm/docs/TestSuiteGuide.md b/llvm/docs/TestSuiteGuide.md
index 19db0ee7d01b82..35984bd6f7b3b3 100644
--- a/llvm/docs/TestSuiteGuide.md
+++ b/llvm/docs/TestSuiteGuide.md
@@ -9,10 +9,10 @@ Quickstart
```bash
% <path to llvm build>/bin/llvm-lit --version
- lit 0.8.0dev
+ lit 20.0.0dev
```
- An alternative is installing it as a python package in a python virtual
+ An alternative is installing it as a Python package in a Python virtual
environment:
```bash
@@ -20,9 +20,24 @@ Quickstart
% . .venv/bin/activate
% pip install git+https://github.com/llvm/llvm-project.git#subdirectory=llvm/utils/lit
% lit --version
- lit 0.8.0dev
+ lit 20.0.0dev
```
+ Installing the official Python release of lit in a Python virtual
+ environment could also work. This will install the most recent
+ release of lit:
+
+ ```bash
+ % python3 -m venv .venv
+ % . .venv/bin/activate
+ % pip install lit
+ % lit --version
+ lit 18.1.8
+ ```
+
+ Please note that recent tests may rely on features not in the latest released lit.
+ If in doubt, try one of the previous methods.
+
2. Check out the `test-suite` module with:
```bash
More information about the llvm-commits
mailing list