Skip to content

Commit edbe8fa

Browse files
[llvm][Docs] Update guide to include pip install lit (llvm#106526)
Also updates and clarifies which version would be installed. As per https://discourse.llvm.org/t/information-on-lit-is-outdated/76498.
1 parent bf69484 commit edbe8fa

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

llvm/docs/TestSuiteGuide.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,35 @@ Quickstart
99

1010
```bash
1111
% <path to llvm build>/bin/llvm-lit --version
12-
lit 0.8.0dev
12+
lit 20.0.0dev
1313
```
1414

15-
An alternative is installing it as a python package in a python virtual
15+
An alternative is installing it as a Python package in a Python virtual
1616
environment:
1717

1818
```bash
1919
% python3 -m venv .venv
2020
% . .venv/bin/activate
2121
% pip install git+https://github.com/llvm/llvm-project.git#subdirectory=llvm/utils/lit
2222
% lit --version
23-
lit 0.8.0dev
23+
lit 20.0.0dev
2424
```
2525

26+
Installing the official Python release of lit in a Python virtual
27+
environment could also work. This will install the most recent
28+
release of lit:
29+
30+
```bash
31+
% python3 -m venv .venv
32+
% . .venv/bin/activate
33+
% pip install lit
34+
% lit --version
35+
lit 18.1.8
36+
```
37+
38+
Please note that recent tests may rely on features not in the latest released lit.
39+
If in doubt, try one of the previous methods.
40+
2641
2. Check out the `test-suite` module with:
2742

2843
```bash

0 commit comments

Comments
 (0)