[clang] [clang][docs] Improve "Obtaining Clang" section (PR #71313)
Robin Caloudis via cfe-commits
cfe-commits at lists.llvm.org
Tue Jan 16 11:18:24 PST 2024
https://github.com/robincaloudis updated https://github.com/llvm/llvm-project/pull/71313
>From 1f9e58d79dd25a2ddeb1252a53950ae4cee961a2 Mon Sep 17 00:00:00 2001
From: Robin Caloudis <53619127+robincaloudis at users.noreply.github.com>
Date: Sun, 5 Nov 2023 13:34:29 +0100
Subject: [PATCH] [clang][docs] Improve "Obtaining Clang" section
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`.
I added `mkdir ~/clang-llvm` to make the intent
of creating an empty directory explicit.
Furthermore, additional steps have been modified
accordingly.
---
clang/docs/LibASTMatchersTutorial.rst | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/clang/docs/LibASTMatchersTutorial.rst b/clang/docs/LibASTMatchersTutorial.rst
index 37c9f178fa8df3..7947d46e04f86e 100644
--- a/clang/docs/LibASTMatchersTutorial.rst
+++ b/clang/docs/LibASTMatchersTutorial.rst
@@ -22,7 +22,7 @@ started guide <https://llvm.org/docs/GettingStarted.html>`_.
.. code-block:: console
- cd ~/clang-llvm
+ 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.
@@ -33,11 +33,11 @@ Next you need to obtain the CMake build system and Ninja build tool.
git clone https://github.com/martine/ninja.git
cd ninja
git checkout release
- ./bootstrap.py
+ ./configure.py
sudo cp ninja /usr/bin/
cd ~/clang-llvm
- git clone git://cmake.org/stage/cmake.git
+ git clone https://gitlab.kitware.com/cmake/cmake.git
cd cmake
git checkout next
./bootstrap
@@ -50,7 +50,7 @@ Okay. Now we'll build Clang!
cd ~/clang-llvm
mkdir build && cd build
- cmake -G Ninja ../llvm -DLLVM_ENABLE_PROJECTS="clang;clang-tools-extra" -DLLVM_BUILD_TESTS=ON # Enable tests; default is off.
+ cmake -G Ninja ../llvm-project/llvm -DLLVM_ENABLE_PROJECTS="clang;clang-tools-extra" -DCMAKE_BUILD_TYPE=Release -DLLVM_BUILD_TESTS=ON
ninja
ninja check # Test LLVM only.
ninja clang-test # Test Clang only.
@@ -65,7 +65,7 @@ Finally, we want to set Clang as its own compiler.
.. code-block:: console
cd ~/clang-llvm/build
- ccmake ../llvm
+ ccmake ../llvm-project/llvm
The second command will bring up a GUI for configuring Clang. You need
to set the entry for ``CMAKE_CXX_COMPILER``. Press ``'t'`` to turn on
@@ -89,7 +89,7 @@ live in the ``clang-tools-extra`` repository.
.. code-block:: console
- cd ~/clang-llvm
+ cd ~/clang-llvm/llvm-project
mkdir clang-tools-extra/loop-convert
echo 'add_subdirectory(loop-convert)' >> clang-tools-extra/CMakeLists.txt
vim clang-tools-extra/loop-convert/CMakeLists.txt
@@ -314,7 +314,7 @@ handiwork:
.. code-block:: console
- cd ~/clang-llvm/llvm/llvm_build/
+ cd ~/clang-llvm/build/
ninja loop-convert
vim ~/test-files/simple-loops.cc
bin/loop-convert ~/test-files/simple-loops.cc
More information about the cfe-commits
mailing list