ref-manual/classes,variables: document the CCACHE_DISABLE variable

Can be used in recipes that want to explicitly skip Ccache support when
the ccache class is enabled.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
(From yocto-docs rev: b1b4adc8d4d9d23ff6fd91bca632bb0f5277e72b)

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-10-27 13:43:37 +01:00 committed by Richard Purdie
parent 1dd4a9ed98
commit c5ce2c1e13
2 changed files with 9 additions and 0 deletions

View File

@ -399,6 +399,10 @@ statements are provided in a :term:`configuration file`::
ASSUME_PROVIDED += "ccache-native"
HOSTTOOLS += "ccache"
Recipes can also explicitly disable `Ccache` support even when the
:ref:`ref-classes-ccache` class is enabled, by setting the
:term:`CCACHE_DISABLE` variable to "1".
Using the :ref:`ref-classes-ccache` class can lead to unexpected side-effects.
Using this class is not recommended.

View File

@ -1526,6 +1526,11 @@ system and gives an overview of their function and contents.
:term:`CC`
The minimal command and arguments used to run the C compiler.
:term:`CCACHE_DISABLE`
When inheriting the :ref:`ref-classes-ccache` class, the
:term:`CCACHE_DISABLE` variable can be set to "1" in a recipe to disable
`Ccache` support. This is useful when the recipe is known to not support it.
:term:`CCLD`
The minimal command and arguments used to run the linker when the C
compiler is being used as the linker.