[llvm] r243917 - GettingStarted.rst: Add info about building sanitizers

Mehdi Amini mehdi.amini at apple.com
Mon Aug 3 16:17:47 PDT 2015


Author: mehdi_amini
Date: Mon Aug  3 18:17:47 2015
New Revision: 243917

URL: http://llvm.org/viewvc/llvm-project?rev=243917&view=rev
Log:
GettingStarted.rst: Add info about building sanitizers

From: Erik de Castro Lopo <erikd at qti.qualcomm.com>

Modified:
    llvm/trunk/docs/GettingStarted.rst

Modified: llvm/trunk/docs/GettingStarted.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/GettingStarted.rst?rev=243917&r1=243916&r2=243917&view=diff
==============================================================================
--- llvm/trunk/docs/GettingStarted.rst (original)
+++ llvm/trunk/docs/GettingStarted.rst Mon Aug  3 18:17:47 2015
@@ -49,12 +49,20 @@ Here's the short story for getting up an
    * ``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





More information about the llvm-commits mailing list