Skip to content

[llvm][Docs] Update guide to include pip install lit #106526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions llvm/docs/TestSuiteGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,35 @@ 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
% python3 -m venv .venv
% . .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
Expand Down
Loading