[llvm][Docs] Make it clear where lit test files live #124121
Merged
+7
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As someone on Discord was understandably confused because the build directory does contain folder structures that look remarkably like the source directory. I used this page to explain it but realised that this must be from when llvm was a separate repository. So <user home>/llvm probably was a common path. Now it's in llvm-project. So make that obvious in the instructions.
|
@llvm/pr-subscribers-testing-tools Author: David Spickett (DavidSpickett) ChangesAs someone on Discord was understandably confused because the build directory does contain folder structures that look remarkably like the source directory. I used this page to explain it but realised that this must be from when llvm was a separate repository. So <user home>/llvm probably was a common path. Now it's in llvm-project. So make that obvious in the instructions. Full diff: https://github.com/llvm/llvm-project/pull/124121.diff 1 Files Affected:
diff --git a/llvm/docs/TestingGuide.rst b/llvm/docs/TestingGuide.rst
index 08617933519fdb..b6dda6a7324056 100644
--- a/llvm/docs/TestingGuide.rst
+++ b/llvm/docs/TestingGuide.rst
@@ -167,13 +167,17 @@ script which is built as part of LLVM. For example, to run the
.. code-block:: bash
- % llvm-lit ~/llvm/test/Integer/BitPacked.ll
+ % llvm-lit <path to llvm-project>/llvm/test/Integer/BitPacked.ll
-or to run all of the ARM CodeGen tests:
+.. note::
+ The test files are in the ``llvm-project`` directory, not the directory you
+ are building LLVM in.
+
+Or you can run a whole folder of tests. To run all of the ARM CodeGen tests:
.. code-block:: bash
- % llvm-lit ~/llvm/test/CodeGen/ARM
+ % llvm-lit <path to llvm-project>/llvm/test/CodeGen/ARM
The regression tests will use the Python psutil module only if installed in a
**non-user** location. Under Linux, install with sudo or within a virtual
|
junlarsen
approved these changes
Jan 23, 2025
|
LLVM Buildbot has detected a new failure on builder Full details are available at: https://lab.llvm.org/buildbot/#/builders/50/builds/9342 Here is the relevant piece of the build log for the reference |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As someone on Discord was understandably confused because the build directory does contain folder structures that look remarkably like the source directory.
I used this page to explain it but realised that this must be from when llvm was a separate repository. So
<user home>/llvmprobably was a common path.Now it's in llvm-project. So make that obvious in the instructions.