[PATCH] D40734: New users should be using the runtimes dir, not projects

[Jonathan Roelofs via Phabricator via llvm-commits]

jroelofs created this revision.

Somewhat tangentially, is it time to deprecate building them from the projects dir?


https://reviews.llvm.org/D40734

Files:
  docs/GettingStarted.rst


Index: docs/GettingStarted.rst
===================================================================
--- docs/GettingStarted.rst
+++ docs/GettingStarted.rst
@@ -73,19 +73,19 @@
 #. Checkout Compiler-RT (required to build the sanitizers) **[Optional]**:
 
    * ``cd where-you-want-llvm-to-live``
-   * ``cd llvm/projects``
+   * ``cd llvm/runtimes``
    * ``svn co http://llvm.org/svn/llvm-project/compiler-rt/trunk compiler-rt``
 
 #. Checkout Libomp (required for OpenMP support) **[Optional]**:
 
    * ``cd where-you-want-llvm-to-live``
-   * ``cd llvm/projects``
+   * ``cd llvm/runtimes``
    * ``svn co http://llvm.org/svn/llvm-project/openmp/trunk openmp``
 
 #. Checkout libcxx and libcxxabi **[Optional]**:
 
    * ``cd where-you-want-llvm-to-live``
-   * ``cd llvm/projects``
+   * ``cd llvm/runtimes``
    * ``svn co http://llvm.org/svn/llvm-project/libcxx/trunk libcxx``
    * ``svn co http://llvm.org/svn/llvm-project/libcxxabi/trunk libcxxabi``
 
@@ -510,21 +510,21 @@
 
 .. code-block:: console
 
-  % cd llvm/projects
+  % cd llvm/runtimes
   % git clone https://git.llvm.org/git/compiler-rt.git/
 
 If you want to check out libomp (required for OpenMP support), run:
 
 .. code-block:: console
 
-  % cd llvm/projects
+  % cd llvm/runtimes
   % git clone https://git.llvm.org/git/openmp.git/
 
 If you want to check out libcxx and libcxxabi (optional), run:
 
 .. code-block:: console
 
-  % cd llvm/projects
+  % cd llvm/runtimes
   % git clone https://git.llvm.org/git/libcxx.git/
   % git clone https://git.llvm.org/git/libcxxabi.git/
 
@@ -1088,6 +1088,15 @@
 directory for creating your own LLVM-based projects which leverage the LLVM
 build system.
 
+``llvm/runtimes``
+-----------------
+
+Runtime components that are linked against code generated by llvm. Placing the
+source of projects like ``libcxx`` and ``libunwind`` in this directory allows
+them to be built automatically during the llvm build, and they are built by the
+just-built clang, rather than the host compiler.
+
+
 ``llvm/test``
 -------------
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D40734.125156.patch
Type: text/x-patch
Size: 2039 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20171201/18996a23/attachment.bin>