mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-09-16 00:49:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: document new toolchain classes and variables

Browse Source 
Document the new classes under classes/toolchain as well as
PREFERRED_TOOLCHAIN* and TOOLCHAIN variables, which allow selecting the
toolchain. For now there's "gcc" and "clang" as available toolchain.

(From yocto-docs rev: 69a9568f8bd7ed57efddab507a4294ad3408f4dd)

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Antonin Godard
2025-07-22 15:33:37 +02:00
committed by Richard Purdie
parent e9a49660a5
commit 649c93080f
2 changed files with 158 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
documentation/ref-manual/classes.rst
View File

@@ -3443,6 +3443,86 @@ This class is not intended to be used directly.
The :ref:`ref-classes-toolchain-scripts` class provides the scripts used for setting up
the environment for installed SDKs.
.. _ref-classes-toolchain-clang:
``toolchain/clang``
===================
The :ref:`ref-classes-toolchain-clang` class defines commands for building
recipes with Clang/LLVM compiler and utilities.
This class is not meant to be inherited directly. Instead, you should either:
- set the :term:`PREFERRED_TOOLCHAIN_TARGET`, :term:`PREFERRED_TOOLCHAIN_NATIVE`
or :term:`PREFERRED_TOOLCHAIN_SDK` variables to "clang" from a
:term:`Configuration File`. This will make the :ref:`ref-classes-base` class
use the :ref:`ref-classes-toolchain-clang` accordingly. All recipes will
be built with the Clang/LLVM toolchain, exception be made for recipes that
override the value of :term:`TOOLCHAIN` or :term:`TOOLCHAIN_NATIVE` to
another value.
- set :term:`TOOLCHAIN` or :term:`TOOLCHAIN_NATIVE` to "clang" from a recipe
when the recipe needs to override the default toolchain set by
:term:`PREFERRED_TOOLCHAIN_TARGET`, :term:`PREFERRED_TOOLCHAIN_NATIVE` or
:term:`PREFERRED_TOOLCHAIN_SDK`.
.. _ref-classes-toolchain-clang-native:
``toolchain/clang-native``
==========================
The :ref:`ref-classes-toolchain-clang-native` class defines commands for
building :ref:`ref-classes-native` recipes with Clang/LLVM compiler and
utilities independently of the build context.
The :ref:`ref-classes-toolchain-gcc-native` class defines :term:`BUILD_CC`,
:term:`BUILD_CXX` and other such variables which are rarely used in recipes.
Exception be made for target recipes that need to use the compiler from the
build host at some point during the build.
This class should not be inherited directly. It is inherited by the
:ref:`ref-classes-base` class if :term:`TOOLCHAIN_NATIVE` is set to "clang".
.. _ref-classes-toolchain-gcc:
``toolchain/gcc``
=================
The :ref:`ref-classes-toolchain-gcc` class defines commands for building
recipes with GCC/Binutils compiler and utilities.
This class is not meant to be inherited directly. Instead, you should either:
- set the :term:`PREFERRED_TOOLCHAIN_TARGET`, :term:`PREFERRED_TOOLCHAIN_NATIVE`
or :term:`PREFERRED_TOOLCHAIN_SDK` variables to "gcc" from a
:term:`Configuration File`. This will make the :ref:`ref-classes-base` class
use the :ref:`ref-classes-toolchain-gcc` accordingly. All recipes will
be built with the GCC/Binutils toolchain, exception be made for recipes that
override the value of :term:`TOOLCHAIN` or :term:`TOOLCHAIN_NATIVE` to
another value.
- set :term:`TOOLCHAIN` or :term:`TOOLCHAIN_NATIVE` to "gcc" from a recipe
when the recipe needs to override the default toolchain set by
:term:`PREFERRED_TOOLCHAIN_TARGET`, :term:`PREFERRED_TOOLCHAIN_NATIVE` or
:term:`PREFERRED_TOOLCHAIN_SDK`.
.. _ref-classes-toolchain-gcc-native:
``toolchain/gcc-native``
========================
The :ref:`ref-classes-toolchain-gcc-native` class defines commands for building
:ref:`ref-classes-native` recipes with GCC/Binutils compiler and utilities
independently of the build context.
The :ref:`ref-classes-toolchain-gcc-native` class defines :term:`BUILD_CC`,
:term:`BUILD_CXX` and other such variables which are rarely used in recipes.
Exception be made for target recipes that need to use the compiler from the build
host at some point during the build.
This class should not be inherited directly. It is inherited by the
:ref:`ref-classes-base` class if :term:`TOOLCHAIN_NATIVE` is set to "gcc".
.. _ref-classes-typecheck:
``typecheck``