diff options
Diffstat (limited to 'llvm/docs/GettingStarted.rst')
| -rw-r--r-- | llvm/docs/GettingStarted.rst | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/llvm/docs/GettingStarted.rst b/llvm/docs/GettingStarted.rst index c92627a3f35..79a286fa96b 100644 --- a/llvm/docs/GettingStarted.rst +++ b/llvm/docs/GettingStarted.rst @@ -38,6 +38,9 @@ Here's the short story for getting up and running quickly with LLVM: #. 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 and running quickly with LLVM: * ``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 and running quickly with LLVM: #. 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. |
