[PATCH] D105822: [docs] More CMAKE variable documentation
Aaron Ballman via Phabricator via llvm-commits
llvm-commits at lists.llvm.org
Wed Jul 14 12:45:54 PDT 2021
aaron.ballman added inline comments.
================
Comment at: llvm/docs/CMake.rst:187
+or execute ``cmake --help-variable VARIABLE_NAME``. See `Frequently
+Used LLVM-specific variables`_ below for information about commonly
+used LLVM-specific variables.
----------------
================
Comment at: llvm/docs/CMake.rst:224
+
+Frequently Used LLVM-specific variables
+-----------------------
----------------
I'd move this up above the rarely-used section so that the list goes in order of most-used to least-used. WDYT?
================
Comment at: llvm/docs/CMake.rst:225
+Frequently Used LLVM-specific variables
+-----------------------
+
----------------
Underlines are off here, so sphinx will complain about this.
================
Comment at: llvm/docs/CMake.rst:228
+The default configuration may not match your requirements. Here are
+LLVM variables that are frequently used to control that. The full
+description is in `LLVM-specific variables`_ below.
----------------
One thing that's interesting about this is that I don't know that they're LLVM variables or not. `LLVM_ENABLE_PROJECTS` isn't really LLVM-specific, it decides what to build as part of the whole project. Similar logic applies to a lot of these items. The only one that's really LLVM-specific in this list is `LLVM_TARGETS_TO_BUILD`, but even that one impacts Clang.
================
Comment at: llvm/docs/CMake.rst:261
+These variables provide fine control over the build of LLVM and
+enabled sub-projects. Nearly all of these variable namess begin with
+``LLVM_``.
----------------
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D105822/new/
https://reviews.llvm.org/D105822
More information about the llvm-commits
mailing list