[PATCH] D142960: [docs] Rewrite/improve the docs for LLVM_NATIVE_TOOL_DIR

[Martin Storsjö via Phabricator via llvm-commits]

mstorsjo created this revision.
mstorsjo added reviewers: phosek, beanz, peter.smith.
Herald added a project: All.
mstorsjo requested review of this revision.
Herald added a project: LLVM.

Don't include it among the mandatory options; the automatically built
tools via a nested cmake build work fine these days
(in particular, since 93010544a813dfbfa64dd7cee68785f572f974d1 <https://reviews.llvm.org/rG93010544a813dfbfa64dd7cee68785f572f974d1> /
https://reviews.llvm.org/D126313).

Clarify the directory path-to-host-bin into something more verbose,
to avoid ambiguity with LLVM_HOST_TRIPLE.

This goes on top of D142404 <https://reviews.llvm.org/D142404>.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D142960

Files:
  llvm/docs/HowToCrossCompileLLVM.rst


Index: llvm/docs/HowToCrossCompileLLVM.rst
===================================================================
--- llvm/docs/HowToCrossCompileLLVM.rst
+++ llvm/docs/HowToCrossCompileLLVM.rst
@@ -42,7 +42,6 @@
 
  * ``-DCMAKE_SYSTEM_NAME=<target-system>``
  * ``-DCMAKE_INSTALL_PREFIX=<install-dir>``
- * ``-DLLVM_NATIVE_TOOL_DIR=<path-to-host-bin>``
  * ``-DLLVM_HOST_TRIPLE=arm-linux-gnueabihf``
  * ``-DLLVM_TARGETS_TO_BUILD=ARM``
 
@@ -69,10 +68,13 @@
  * Appropriate use of ``-I`` and ``-L``, depending on how the cross GCC is installed,
    and where are the libraries and headers.
 
-The ``LLVM_NATIVE_TOOL_DIR`` option allows you to reuse prebuilt binaries
-(``llvm-tblgen``, ``clang-tblgen`` etc) for the build host, if such are
-available. If that's not available, the LLVM cross build will automatically
-launch a nested build to build the tools that are required.
+You may also want to set the ``LLVM_NATIVE_TOOL_DIR`` option - pointing
+at a directory with prebuilt LLVM tools (``llvm-tblgen``, ``clang-tblgen``
+etc) for the build host, allowing you to them reuse them if available.
+E.g. ``-DLLVM_NATIVE_TOOL_DIR=<path-to-native-llvm-build>/bin``.
+If the option isn't set (or the directory doesn't contain all needed tools),
+the LLVM cross build will automatically launch a nested build to build the
+tools that are required.
 
 The CXX flags define the target, cpu (which in this case
 defaults to ``fpu=VFP3`` with NEON), and forcing the hard-float ABI. If you're


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D142960.493514.patch
Type: text/x-patch
Size: 1482 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20230131/55023e3f/attachment.bin>