[llvm] [llvm][Docs] Update guide to include ``pip install lit`` (PR #106526)
via llvm-commits
llvm-commits at lists.llvm.org
Mon Sep 9 19:51:43 PDT 2024
https://github.com/MichelleCDjunaidi updated https://github.com/llvm/llvm-project/pull/106526
>From b30a63b0b94e8e8d19e3b051336c87421ed8433b Mon Sep 17 00:00:00 2001
From: MichelleCDjunaidi <87893361+MichelleCDjunaidi at users.noreply.github.com>
Date: Thu, 29 Aug 2024 18:38:39 +0800
Subject: [PATCH 1/3] Update guide to include ``pip install lit``
Also updates the versions on the guide.
---
llvm/docs/TestSuiteGuide.md | 16 +++++++++++++---
1 file changed, 13 insertions(+), 3 deletions(-)
diff --git a/llvm/docs/TestSuiteGuide.md b/llvm/docs/TestSuiteGuide.md
index 9552cd89aa1c1b..2171622dee6c0a 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,7 +20,17 @@ 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 would also work.
+ ```bash
+ % python3 -m venv .venv
+ % . .venv/bin/activate
+ % pip install lit
+ % lit --version
+ lit 18.1.8
```
2. Check out the `test-suite` module with:
>From f06da8caebee7435a33393c42086c739d7e4c6ab Mon Sep 17 00:00:00 2001
From: MichelleCDjunaidi <87893361+MichelleCDjunaidi at users.noreply.github.com>
Date: Thu, 29 Aug 2024 18:42:11 +0800
Subject: [PATCH 2/3] Clarify version installed by lit
---
llvm/docs/TestSuiteGuide.md | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/llvm/docs/TestSuiteGuide.md b/llvm/docs/TestSuiteGuide.md
index 2171622dee6c0a..0a02c570328781 100644
--- a/llvm/docs/TestSuiteGuide.md
+++ b/llvm/docs/TestSuiteGuide.md
@@ -24,7 +24,8 @@ Quickstart
```
Installing the official Python release of lit in a Python virtual
- environment would also work.
+ environment would also work. This will install the most recent
+ release of lit:
```bash
% python3 -m venv .venv
% . .venv/bin/activate
>From 38cd2e198e8ae2a455a33da7fabe7decb8c348d2 Mon Sep 17 00:00:00 2001
From: MichelleCDjunaidi <87893361+MichelleCDjunaidi at users.noreply.github.com>
Date: Tue, 10 Sep 2024 10:50:37 +0800
Subject: [PATCH 3/3] Add clarification for newer tests and fix formatting
---
llvm/docs/TestSuiteGuide.md | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/llvm/docs/TestSuiteGuide.md b/llvm/docs/TestSuiteGuide.md
index 0a02c570328781..a2230180c2a840 100644
--- a/llvm/docs/TestSuiteGuide.md
+++ b/llvm/docs/TestSuiteGuide.md
@@ -12,7 +12,7 @@ Quickstart
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
@@ -24,8 +24,9 @@ Quickstart
```
Installing the official Python release of lit in a Python virtual
- environment would also work. This will install the most recent
+ environment could also work. This will install the most recent
release of lit:
+
```bash
% python3 -m venv .venv
% . .venv/bin/activate
@@ -34,6 +35,9 @@ Quickstart
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