[llvm] d396d09 - Document LLVM_ENABLE_RUNTIMES

[Sylvestre Ledru via llvm-commits]

Author: Sylvestre Ledru
Date: 2021-09-01T08:45:40+02:00
New Revision: d396d09fc2278bfe34b9db2ee27ecfd470149da8

URL: https://github.com/llvm/llvm-project/commit/d396d09fc2278bfe34b9db2ee27ecfd470149da8
DIFF: https://github.com/llvm/llvm-project/commit/d396d09fc2278bfe34b9db2ee27ecfd470149da8.diff

LOG: Document LLVM_ENABLE_RUNTIMES

Reviewed By: phosek, MaskRay

Differential Revision: https://reviews.llvm.org/D108890

Added: 
    

Modified: 
    llvm/docs/CMake.rst

Removed: 
    


################################################################################
diff  --git a/llvm/docs/CMake.rst b/llvm/docs/CMake.rst
index 74630f3e368a5..b906d2330d192 100644
--- a/llvm/docs/CMake.rst
+++ b/llvm/docs/CMake.rst
@@ -477,6 +477,18 @@ enabled sub-projects. Nearly all of these variable names begin with
   The full list is:
   ``clang;clang-tools-extra;compiler-rt;cross-project-tests;libc;libclc;libcxx;libcxxabi;libunwind;lld;lldb;openmp;parallel-libs;polly;pstl``
 
+**LLVM_ENABLE_RUNTIMES**:STRING
+  Build libc++, libc++abi or other projects using that a just-built compiler.
+  This is the correct way to build libc++ when putting together a toolchain.
+  It will build the builtins separately from the other runtimes to preserve
+  correct dependency ordering.
+  Note: the list should not have duplicates with `LLVM_ENABLE_PROJECTS`.
+  The full list is:
+  ``compiler-rt;libc;libcxx;libcxxabi;libunwind;openmp``
+  To enable all of them, use:
+  ``LLVM_ENABLE_RUNTIMES=all``
+
+
 **LLVM_ENABLE_RTTI**:BOOL
   Build LLVM with run-time type information. Defaults to OFF.