summaryrefslogtreecommitdiffstats
path: root/clang/docs/LibASTMatchersTutorial.rst
diff options
context:
space:
mode:
authorJames Y Knight <jyknight@google.com>2019-01-29 16:37:27 +0000
committerJames Y Knight <jyknight@google.com>2019-01-29 16:37:27 +0000
commit5d71fc5d7b5ffe2323418a09db6eddaf84d6c662 (patch)
tree3354c257cd3b01f4a1a928017e9258238311b887 /clang/docs/LibASTMatchersTutorial.rst
parent6409d756989033a7410c33e061debe55cfd74133 (diff)
downloadbcm5719-llvm-5d71fc5d7b5ffe2323418a09db6eddaf84d6c662.tar.gz
bcm5719-llvm-5d71fc5d7b5ffe2323418a09db6eddaf84d6c662.zip
Adjust documentation for git migration.
This fixes most references to the paths: llvm.org/svn/ llvm.org/git/ llvm.org/viewvc/ github.com/llvm-mirror/ github.com/llvm-project/ reviews.llvm.org/diffusion/ to instead point to https://github.com/llvm/llvm-project. This is *not* a trivial substitution, because additionally, all the checkout instructions had to be migrated to instruct users on how to use the monorepo layout, setting LLVM_ENABLE_PROJECTS instead of checking out various projects into various subdirectories. I've attempted to not change any scripts here, only documentation. The scripts will have to be addressed separately. Additionally, I've deleted one document which appeared to be outdated and unneeded: lldb/docs/building-with-debug-llvm.txt Differential Revision: https://reviews.llvm.org/D57330 llvm-svn: 352514
Diffstat (limited to 'clang/docs/LibASTMatchersTutorial.rst')
-rw-r--r--clang/docs/LibASTMatchersTutorial.rst25
1 files changed, 8 insertions, 17 deletions
diff --git a/clang/docs/LibASTMatchersTutorial.rst b/clang/docs/LibASTMatchersTutorial.rst
index 8b7ee7f98fa..24659a5209c 100644
--- a/clang/docs/LibASTMatchersTutorial.rst
+++ b/clang/docs/LibASTMatchersTutorial.rst
@@ -16,23 +16,16 @@ Step 0: Obtaining Clang
=======================
As Clang is part of the LLVM project, you'll need to download LLVM's
-source code first. Both Clang and LLVM are maintained as Subversion
-repositories, but we'll be accessing them through the git mirror. For
-further information, see the `getting started
-guide <https://llvm.org/docs/GettingStarted.html>`_.
+source code first. Both Clang and LLVM are in the same git repository,
+under different directories. For further information, see the `getting
+started guide <https://llvm.org/docs/GettingStarted.html>`_.
.. code-block:: console
- mkdir ~/clang-llvm && cd ~/clang-llvm
- git clone https://llvm.org/git/llvm.git
- cd llvm/tools
- git clone https://llvm.org/git/clang.git
- cd clang/tools
- git clone https://llvm.org/git/clang-tools-extra.git extra
+ 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. You
-may already have CMake installed, but current binary versions of CMake
-aren't built with Ninja support.
+Next you need to obtain the CMake build system and Ninja build tool.
.. code-block:: console
@@ -57,7 +50,7 @@ Okay. Now we'll build Clang!
cd ~/clang-llvm
mkdir build && cd build
- cmake -G Ninja ../llvm -DLLVM_BUILD_TESTS=ON # Enable tests; default is off.
+ cmake -G Ninja ../llvm -DLLVM_ENABLE_PROJECTS=clang -DLLVM_BUILD_TESTS=ON # Enable tests; default is off.
ninja
ninja check # Test LLVM only.
ninja clang-test # Test Clang only.
@@ -65,9 +58,7 @@ Okay. Now we'll build Clang!
And we're live.
-All of the tests should pass, though there is a (very) small chance that
-you can catch LLVM and Clang out of sync. Running ``'git svn rebase'``
-in both the llvm and clang directories should fix any problems.
+All of the tests should pass.
Finally, we want to set Clang as its own compiler.
OpenPOWER on IntegriCloud