diff mbox series

[v2,05/16] ref-manual/classes,variables: document the CCACHE_DISABLE variable

Message ID 20251024-release-note-5-3-second-hunk-v2-5-d15dabc095d0@bootlin.com
State Under Review
Headers show
Series Updates for 5.3 | expand

Commit Message

Antonin Godard Oct. 24, 2025, 8:19 a.m. UTC
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>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/classes.rst   | 4 ++++
 documentation/ref-manual/variables.rst | 5 +++++
 2 files changed, 9 insertions(+)

Comments

Quentin Schulz Oct. 24, 2025, 3:20 p.m. UTC | #1
Hi Antonin,

On 10/24/25 10:19 AM, Antonin Godard wrote:
> 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>
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   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 4372bbf06..34bc7fed8 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -401,6 +401,10 @@ recipes if the following configuration statements are provided from a
>      ASSUME_PROVIDED += "ccache-native"
>      HOSTTOOLS += "ccache"
>   
> +Recipes can also explicitly disable Ccache support even when the

I think we want to tick-quotes any non-English word? So `Ccache`? C.f. 
Project names in documentation/standards.md.

> +: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 3bc666674..63f29575b 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.
> +

Ditto.

Technically CCACHE_DISABLE is a BitBake boolean, so y, yes, 1 and true 
(uppercase characters normalized for all) would work.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

Thanks!
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 4372bbf06..34bc7fed8 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -401,6 +401,10 @@  recipes if the following configuration statements are provided from a
    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 3bc666674..63f29575b 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.