Skip to content

Commit

Permalink
Documentation/llvm: update CROSS_COMPILE inferencing
Browse files Browse the repository at this point in the history
As noted by Masahiro, document how we can generally infer CROSS_COMPILE
(and the more specific details about --target and --prefix) based on
ARCH.

Change use of env vars to command line parameters.

Suggested-by: Masahiro Yamada <[email protected]>
Reviewed-by: Fangrui Song <[email protected]>
Signed-off-by: Nick Desaulniers <[email protected]>
Reviewed-by: Nathan Chancellor <[email protected]>
Signed-off-by: Masahiro Yamada <[email protected]>
  • Loading branch information
nickdesaulniers authored and masahir0y committed Aug 10, 2021
1 parent 231ad7f commit e08831b
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion Documentation/kbuild/llvm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Cross Compiling
A single Clang compiler binary will typically contain all supported backends,
which can help simplify cross compiling. ::

ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- make CC=clang
make ARCH=arm64 CC=clang CROSS_COMPILE=aarch64-linux-gnu-

``CROSS_COMPILE`` is not used to prefix the Clang compiler binary, instead
``CROSS_COMPILE`` is used to set a command line flag: ``--target=<triple>``. For
Expand All @@ -63,6 +63,23 @@ They can be enabled individually. The full list of the parameters: ::
Currently, the integrated assembler is disabled by default. You can pass
``LLVM_IAS=1`` to enable it.

Omitting CROSS_COMPILE
----------------------

As explained above, ``CROSS_COMPILE`` is used to set ``--target=<triple>``.

Unless ``LLVM_IAS=1`` is specified, ``CROSS_COMPILE`` is also used to derive
``--prefix=<path>`` to search for the GNU assembler and linker.

If ``CROSS_COMPILE`` is not specified, the ``--target=<triple>`` is inferred
from ``ARCH``.

That means if you use only LLVM tools, ``CROSS_COMPILE`` becomes unnecessary.

For example, to cross-compile the arm64 kernel::

make ARCH=arm64 LLVM=1 LLVM_IAS=1

Supported Architectures
-----------------------

Expand Down

0 comments on commit e08831b

Please sign in to comment.