Skip to content

Commit 97df741

Browse files
[llvm][Docs] Make it clear where lit test files live (#124121)
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.
1 parent eda1699 commit 97df741

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

llvm/docs/TestingGuide.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,13 +167,17 @@ script which is built as part of LLVM. For example, to run the
167167

168168
.. code-block:: bash
169169
170-
% llvm-lit ~/llvm/test/Integer/BitPacked.ll
170+
% llvm-lit <path to llvm-project>/llvm/test/Integer/BitPacked.ll
171171
172-
or to run all of the ARM CodeGen tests:
172+
.. note::
173+
The test files are in the ``llvm-project`` directory, not the directory you
174+
are building LLVM in.
175+
176+
Or you can run a whole folder of tests. To run all of the ARM CodeGen tests:
173177

174178
.. code-block:: bash
175179
176-
% llvm-lit ~/llvm/test/CodeGen/ARM
180+
% llvm-lit <path to llvm-project>/llvm/test/CodeGen/ARM
177181
178182
The regression tests will use the Python psutil module only if installed in a
179183
**non-user** location. Under Linux, install with sudo or within a virtual

0 commit comments

Comments
 (0)