[PATCH] D105822: [docs] More CMAKE variable documentation

[Aaron Ballman via Phabricator via llvm-commits]

aaron.ballman added inline comments.


================
Comment at: llvm/docs/CMake.rst:213-214
+
+Frequently Used LLVM-specific variables
+-----------------------
+
----------------



================
Comment at: llvm/docs/CMake.rst:225
+Frequently Used LLVM-specific variables
+-----------------------
+
----------------
urnathan wrote:
> aaron.ballman wrote:
> > Underlines are off here, so sphinx will complain about this.
> I don't know what that means -- I tried to figure out how to sphinx it, but failed.  I (attempted to) match the formatting of other section headers.
The count of underlines needs to match the count of characters on the line. I made a suggested edit to show what I mean.


================
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.
----------------
urnathan wrote:
> aaron.ballman wrote:
> > 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.
> Agreed, there's an unfortunate use of LLVM to mean both 'LLVM library' and 'LLVM project'.  I don't know the best way to disambiguate that -- or how to categorize these variables.
How about using `LLVM-related` instead of `LLVM-specific` in the section title and prose? Alternatively, we could just stick them under frequently used and not call out LLVM at all?


CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D105822/new/

https://reviews.llvm.org/D105822