[llvm] [llvm][Docs] Make it clear where lit test files live (PR #124121)

[via llvm-commits]

llvmbot wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-testing-tools

Author: David Spickett (DavidSpickett)

<details>
<summary>Changes</summary>

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.

---
Full diff: https://github.com/llvm/llvm-project/pull/124121.diff


1 Files Affected:

- (modified) llvm/docs/TestingGuide.rst (+7-3) 


``````````diff
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

``````````

</details>


https://github.com/llvm/llvm-project/pull/124121