From c5ce2c1e13ef9552411ae598840858cf5ab8076b Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Mon, 27 Oct 2025 13:43:37 +0100 Subject: [PATCH] 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 (From yocto-docs rev: b1b4adc8d4d9d23ff6fd91bca632bb0f5277e72b) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/ref-manual/classes.rst | 4 ++++ documentation/ref-manual/variables.rst | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 4d0882401e..4e5083a79c 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -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. diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 1c4689343d..a79d60edcf 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -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.