[PATCH] D123968: docs: Add instructions for stand-alone builds of clang

[Fangrui Song via Phabricator via llvm-commits]

MaskRay accepted this revision.
MaskRay added a comment.
This revision is now accepted and ready to land.
Herald added a subscriber: StephenFan.

LGTM.



================
Comment at: llvm/docs/GettingStarted.rst:110
 
+Stand-alone Builds
+------------------
----------------
I just read https://brians.wsu.edu/2016/05/31/standalone-stand-alone/

When one greps in `llvm-project`, which word do they more likely use, `standalone` or `stand-alone`? I tend to use `standalone`. Then I checked `git shortlog -sn --grep standalone` and `git shortlog -sn --grep stand-alone`. The former is more popular while the latter is not too uncommon...


================
Comment at: llvm/docs/GettingStarted.rst:134
+
+  ninja -C $builddir install
+
----------------
Does `install-distribution` with `LLVM_DISTRIBUTION_COMPONENTS` work? From the name, `LLVM_DISTRIBUTION_COMPONENTS`  is recommended for distributions and standalone builds are preferred by distributions.


================
Comment at: llvm/docs/GettingStarted.rst:144
+
+LLVM_ROOT should point to the prefix of your llvm installation, so for example,
+if llvm is installed into ``/usr/bin`` and ``/usr/lib64``, then you should pass
----------------



================
Comment at: llvm/docs/GettingStarted.rst:146
+if llvm is installed into ``/usr/bin`` and ``/usr/lib64``, then you should pass
+``-DLLVM_ROOT=/usr/``.  Both the LLVM_ROOT and LLVM_EXTERNAL_LIT options
+are required to do stand-alone builds for all sub-projects.  Additional required
----------------
Is the formal CMake term "variable" instead of "option"?


================
Comment at: llvm/docs/GettingStarted.rst:157
+llvm         llvm, cmake, third-party LLVM_INSTALL_UTILS=ON
+clang        clang, cmake             CLANG_INCLUDE_TESTS=ON (Required for check-clang only)
+============ ======================== ======================
----------------
You may check what `flang` requires and make the second column sufficiently long to accommodate its needs.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D123968