Document LLVM_ENABLE_RUNTIMES
authorSylvestre Ledru <sylvestre@debian.org>
Wed, 1 Sep 2021 06:45:15 +0000 (08:45 +0200)
committerSylvestre Ledru <sylvestre@debian.org>
Wed, 1 Sep 2021 06:45:40 +0000 (08:45 +0200)
Reviewed By: phosek, MaskRay

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

llvm/docs/CMake.rst

index 74630f3..b906d23 100644 (file)
@@ -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.