Skip to content

Commit 029b9b6

Browse files
committed
[llvm][docs] Improve formatting of ENABLE_PROJECTS/RUNTIMES description
* Add line breaks so it's clear what should be passed to CMake. * Make the note into an RST note block. * Fix a couple of markdown style plain text markers.
1 parent c30fa3c commit 029b9b6

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

llvm/docs/CMake.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -571,10 +571,12 @@ enabled sub-projects. Nearly all of these variable names begin with
571571
Semicolon-separated list of projects to build, or *all* for building all
572572
(clang, lldb, lld, polly, etc) projects. This flag assumes that projects
573573
are checked out side-by-side and not nested, i.e. clang needs to be in
574-
parallel of llvm instead of nested in `llvm/tools`. This feature allows
574+
parallel of llvm instead of nested in ``llvm/tools``. This feature allows
575575
to have one build for only LLVM and another for clang+llvm using the same
576576
source checkout.
577+
577578
The full list is:
579+
578580
``clang;clang-tools-extra;cross-project-tests;libc;libclc;lld;lldb;openmp;polly;pstl``
579581

580582
**LLVM_ENABLE_RTTI**:BOOL
@@ -586,10 +588,16 @@ enabled sub-projects. Nearly all of these variable names begin with
586588
It will build the builtins separately from the other runtimes to preserve
587589
correct dependency ordering. If you want to build the runtimes using a system
588590
compiler, see the `libc++ documentation <https://libcxx.llvm.org/BuildingLibcxx.html>`_.
589-
Note: the list should not have duplicates with `LLVM_ENABLE_PROJECTS`.
591+
592+
.. note::
593+
The list should not have duplicates with ``LLVM_ENABLE_PROJECTS``.
594+
590595
The full list is:
596+
591597
``compiler-rt;libc;libcxx;libcxxabi;libunwind;openmp``
598+
592599
To enable all of them, use:
600+
593601
``LLVM_ENABLE_RUNTIMES=all``
594602

595603
**LLVM_ENABLE_SPHINX**:BOOL

0 commit comments

Comments
 (0)