[llvm] r260003 - [docs] Clarify a couple of getting started issues identified during Sprint

[Philip Reames via llvm-commits]

Author: reames
Date: Sat Feb  6 13:20:26 2016
New Revision: 260003

URL: http://llvm.org/viewvc/llvm-project?rev=260003&view=rev
Log:
[docs] Clarify a couple of getting started issues identified during Sprint


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=260003&r1=260002&r2=260003&view=diff
==============================================================================
--- llvm/trunk/docs/GettingStarted.rst (original)
+++ llvm/trunk/docs/GettingStarted.rst Sat Feb  6 13:20:26 2016
@@ -38,6 +38,9 @@ Here's the short story for getting up an
 #. Read the documentation.
 #. Read the documentation.
 #. Remember that you were warned twice about reading the documentation.
+
+   * In particular, the *relative paths specified are important*.
+
 #. Checkout LLVM:
 
    * ``cd where-you-want-llvm-to-live``
@@ -49,13 +52,13 @@ 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 (required to build the sanitizers):
+#. Checkout Compiler-RT (required to build the sanitizers) **[Optional]**:
 
    * ``cd where-you-want-llvm-to-live``
    * ``cd llvm/projects``
    * ``svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk compiler-rt``
 
-#. Checkout Libomp (required for OpenMP support):
+#. Checkout Libomp (required for OpenMP support) **[Optional]**:
 
    * ``cd where-you-want-llvm-to-live``
    * ``cd llvm/projects``
@@ -76,6 +79,10 @@ Here's the short story for getting up an
 
 #. Configure and build LLVM and Clang:
 
+   *Warning:* Make sure you've checked out *all of* the source code 
+   before trying to configure with cmake.  cmake does not pickup newly
+   added source directories in incremental builds. 
+
    The build uses `CMake <CMake.html>`_.
    Although the build is known to work with CMake >= 2.8.8, we recommend CMake
    >= v3.2, especially if you're generating Ninja build files.