[clang] [clang][docs] Improve "Obtainig Clang" section (PR #71313)

via cfe-commits cfe-commits at lists.llvm.org
Sun Nov 5 04:36:09 PST 2023


llvmbot wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-clang

Author: Robin Caloudis (robincaloudis)

<details>
<summary>Changes</summary>

The documentation is written relatively to `clang-llvm`, not the root repository directory. Therefore, the `llvm-project` repo needs to be cloned into the existing directory `clang-llvm`. As cloning into an existing directory is only allowed if the directory is empty, I added `mkdir ~/clang-llvm` to make the intent of creating an empty directory explicit.

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


1 Files Affected:

- (modified) clang/docs/LibASTMatchersTutorial.rst (+2-2) 


``````````diff
diff --git a/clang/docs/LibASTMatchersTutorial.rst b/clang/docs/LibASTMatchersTutorial.rst
index 37c9f178fa8df31..2a3f052f2e9ce15 100644
--- a/clang/docs/LibASTMatchersTutorial.rst
+++ b/clang/docs/LibASTMatchersTutorial.rst
@@ -22,8 +22,8 @@ started guide <https://llvm.org/docs/GettingStarted.html>`_.
 
 .. code-block:: console
 
-      cd ~/clang-llvm
-      git clone https://github.com/llvm/llvm-project.git
+      mkdir ~/clang-llvm && cd ~/clang-llvm
+      git clone https://github.com/llvm/llvm-project.git .
 
 Next you need to obtain the CMake build system and Ninja build tool.
 

``````````

</details>


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


More information about the cfe-commits mailing list