[llvm] Clarify llvm/CMakeLists.txt LLVM_ENABLE_RUNTIMES documentation (PR #82191)
Rodrigo Salazar via llvm-commits
llvm-commits at lists.llvm.org
Sun Feb 18 14:57:17 PST 2024
https://github.com/4-rodrigo-salazar updated https://github.com/llvm/llvm-project/pull/82191
>From f5964ee443b13e2f2ce436c04e74bbee7bfb4e35 Mon Sep 17 00:00:00 2001
From: Rodrigo Salazar <4rodrigosalazar at gmail.com>
Date: Sun, 18 Feb 2024 14:20:02 -0800
Subject: [PATCH 1/2] Clarify llvm/CMakeLists.txt LLVM_ENABLE_RUNTIMES
documentation
---
llvm/docs/CMake.rst | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/llvm/docs/CMake.rst b/llvm/docs/CMake.rst
index abef4f8103140f..3d032ada791773 100644
--- a/llvm/docs/CMake.rst
+++ b/llvm/docs/CMake.rst
@@ -582,16 +582,17 @@ enabled sub-projects. Nearly all of these variable names begin with
``clang;clang-tools-extra;cross-project-tests;libc;libclc;lld;lldb;openmp;polly;pstl``
**LLVM_ENABLE_RUNTIMES**:STRING
- Build libc++, libc++abi, libunwind or compiler-rt using the just-built compiler.
+ Build llvm runtime sub-projects using the just-built compiler.
This is the correct way to build runtimes when putting together a toolchain.
It will build the builtins separately from the other runtimes to preserve
correct dependency ordering. If you want to build the runtimes using a system
compiler, see the `libc++ documentation <https://libcxx.llvm.org/BuildingLibcxx.html>`_.
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``
+ ``compiler-rt;libc;libcxx;libcxxabi;libunwind;openmp;pstl;llvm-libgcc``
+ To enable the default recommended set of runtimes for usage
+ with ``LLVM_ENABLE_PROJECTS=all`` of them, use: ``LLVM_ENABLE_RUNTIMES=all``.
+ Note: ``all`` does not enable all runtimes from the full list.
**LLVM_ENABLE_RTTI**:BOOL
>From 182ab497b12b4723acf48c330970dc27516ac1ec Mon Sep 17 00:00:00 2001
From: Rodrigo Salazar <4rodrigosalazar at gmail.com>
Date: Sun, 18 Feb 2024 14:56:54 -0800
Subject: [PATCH 2/2] typo
---
llvm/docs/CMake.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/llvm/docs/CMake.rst b/llvm/docs/CMake.rst
index 3d032ada791773..bcffc386440654 100644
--- a/llvm/docs/CMake.rst
+++ b/llvm/docs/CMake.rst
@@ -591,7 +591,7 @@ enabled sub-projects. Nearly all of these variable names begin with
The full list is:
``compiler-rt;libc;libcxx;libcxxabi;libunwind;openmp;pstl;llvm-libgcc``
To enable the default recommended set of runtimes for usage
- with ``LLVM_ENABLE_PROJECTS=all`` of them, use: ``LLVM_ENABLE_RUNTIMES=all``.
+ with ``LLVM_ENABLE_PROJECTS=all``, use: ``LLVM_ENABLE_RUNTIMES=all``.
Note: ``all`` does not enable all runtimes from the full list.
More information about the llvm-commits
mailing list