[llvm-commits] [lld] r155678 - /lld/trunk/docs/getting_started.rst

[Nick Kledzik]

Author: kledzik
Date: Thu Apr 26 18:41:01 2012
New Revision: 155678

URL: http://llvm.org/viewvc/llvm-project?rev=155678&view=rev
Log:
show how to specify alternate path to clang compiler

Modified:
    lld/trunk/docs/getting_started.rst

Modified: lld/trunk/docs/getting_started.rst
URL: http://llvm.org/viewvc/llvm-project/lld/trunk/docs/getting_started.rst?rev=155678&r1=155677&r2=155678&view=diff
==============================================================================
--- lld/trunk/docs/getting_started.rst (original)
+++ lld/trunk/docs/getting_started.rst Thu Apr 26 18:41:01 2012
@@ -14,7 +14,7 @@
 On Unix-like Systems
 ~~~~~~~~~~~~~~~~~~~~
 
-#. Get the required tools.
+1. Get the required tools.
 
   * `CMake 2.8`_\+.
   * make (or any build system CMake supports).
@@ -28,12 +28,12 @@
 .. _libc++: http://libcxx.llvm.org/
 .. _Python 2.4: http://python.org/download/
 
-#. Check out LLVM::
+2. Check out LLVM::
 
      $ cd path/to/llvm-project
      $ svn co http://llvm.org/svn/llvm-project/llvm/trunk llvm
 
-#. Check out lld::
+3. Check out lld::
 
      $ cd llvm/tools
      $ svn co http://llvm.org/svn/llvm-project/lld/trunk lld
@@ -41,13 +41,19 @@
   * lld can also be checked out to ``path/to/llvm-project`` and built as an external
     project.
 
-#. Build LLVM and lld::
+4. Build LLVM and lld::
 
      $ cd path/to/llvm-build/llvm (out of source build required)
      $ cmake -G "Unix Makefiles" path/to/llvm-project/llvm
      $ make
 
-#. Test::
+  * If you want to build with clang and it is not the default compiler or
+    it is installed in an alternate location, you'll need to tell the cmake tool
+    the location of the C and C++ compiler via CMAKE_C_COMPILER and
+    CMAKE_CXX_COMPILER. For example::
+        $ cmake -DCMAKE_CXX_COMPILER=/path/to/clang++ -DCMAKE_C_COMPILER=/path/to/clang ...
+
+5. Test::
 
      $ make lld-test