GettingStarted.rst: Add info about building sanitizers
authorMehdi Amini <mehdi.amini@apple.com>
Mon, 3 Aug 2015 23:17:47 +0000 (23:17 +0000)
committerMehdi Amini <mehdi.amini@apple.com>
Mon, 3 Aug 2015 23:17:47 +0000 (23:17 +0000)
From: Erik de Castro Lopo <erikd@qti.qualcomm.com>

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@243917 91177308-0d34-0410-b5e6-96231b3b80d8

docs/GettingStarted.rst

index 1efad92..3f60ee4 100644 (file)
@@ -49,12 +49,20 @@ Here's the short story for getting up and running quickly with LLVM:
    * ``cd llvm/tools``
    * ``svn co http://llvm.org/svn/llvm-project/cfe/trunk clang``
 
-#. Checkout Compiler-RT:
+#. Checkout Compiler-RT (required to build the sanitisers):
 
    * ``cd where-you-want-llvm-to-live``
    * ``cd llvm/projects``
    * ``svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk compiler-rt``
 
+#. Checkout libcxx and libcxxabi (required if you want to use the sanitisers
+   on C++ code):
+
+   * ``cd where-you-want-llvm-to-live``
+   * ``cd llvm/projects``
+   * ``svn co http://llvm.org/svn/llvm-project/libcxx/trunk libcxx``
+   * ``svn co http://llvm.org/svn/llvm-project/libcxxabi/trunk libcxxabi``
+
 #. Get the Test Suite Source Code **[Optional]**
 
    * ``cd where-you-want-llvm-to-live``
@@ -521,13 +529,22 @@ If you want to check out clang too, run:
   % cd llvm/tools
   % git clone http://llvm.org/git/clang.git
 
-If you want to check out compiler-rt too, run:
+If you want to check out compiler-rt (required to build the sanitisers), run:
 
 .. code-block:: console
 
   % cd llvm/projects
   % git clone http://llvm.org/git/compiler-rt.git
 
+If you want to check out libcxx and libcxxabi (required if you want to use the
+sanitisers on C++ code), run:
+
+.. code-block:: console
+
+  % cd llvm/projects
+  % git clone http://llvm.org/git/libcxx.git
+  % git clone http://llvm.org/git/libcxxabi.git
+
 If you want to check out the Test Suite Source Code (optional), run:
 
 .. code-block:: console