[PATCH] D102481: [docs] Collate CMake options

[Nathan Sidwell via Phabricator via llvm-commits]

urnathan created this revision.
Herald added subscribers: mstorsjo, mgorny.
urnathan requested review of this revision.
Herald added a reviewer: jdoerfert.
Herald added subscribers: llvm-commits, sstefan1.
Herald added a project: LLVM.

I found the documentation of the various CMake variables difficult to navigate, because they are unsorted.  I can see they've grown organically with new clusters of somewhat-related options, but the result is hard to use.  This collates them (treating '_' as space).

It might also be a good idea to move LLVM_TARGETS_TO_BUILD, LLVM_ENABLE_PROJECTS and LLVM_PARALLEL_{COMPILE,LINK}_JOBS to either the 'Frequently used' section, or a new section, as it seems not just I need to know about them when getting started, re these questions:
a) why isn't it building clang? -> LLVM_ENABLE_PROJECTS  -- defaults to nothing
b) why is it building all these backends? -> LLVM_TARGETS_TO_BUILD -- defaults to everything, how consistent :)
c) help, I'm OOMing  -> LLVM_PARALLEL_LINK_JOBS

WDYT?


https://reviews.llvm.org/D102481

Files:
  llvm/docs/CMake.rst

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D102481.345397.patch
Type: text/x-patch
Size: 37153 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20210514/2964be0e/attachment-0001.bin>