diff mbox series

[v2,04/16] ref-manual/classes.rst: ccache: mention that the host's ccache can be used

Message ID 20251024-release-note-5-3-second-hunk-v2-4-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
This feature was added by commit cc91a0f6500e ("ccache: enable ccache
for all recipes if it is in HOSTTOOLS") in OE-Core.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/classes.rst | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

Comments

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

On 10/24/25 10:19 AM, Antonin Godard via lists.yoctoproject.org wrote:
> This feature was added by commit cc91a0f6500e ("ccache: enable ccache
> for all recipes if it is in HOSTTOOLS") in OE-Core.
> 
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
>   documentation/ref-manual/classes.rst | 13 +++++++++++--
>   1 file changed, 11 insertions(+), 2 deletions(-)
> 
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index f93897be1..4372bbf06 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -392,8 +392,17 @@ file for details about how to enable this mechanism in your configuration
>   file, how to disable it for specific recipes, and how to share ``ccache``
>   files between builds.
>   
> -However, using the class can lead to unexpected side-effects. Thus, using
> -this class is not recommended.
> +By default, :ref:`ref-classes-native` recipes are not supported by the
> +:ref:`ref-classes-ccache` class. It is possible to add Ccache support for these
> +recipes if the following configuration statements are provided from a
> +:term:`configuration file`, which uses the host's ``ccache`` binary via
> +:term:`HOSTTOOLS` instead of building ``ccache-native``::"""
Recipes (including :ref:`ref-classes-native` ones) can make use of the 
host's ``ccache`` binary (via :term:`HOSTTOOLS`) if the following 
configuration statements are provided in a :term:`configuration file`::
"""

Cheers,
Quentin
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index f93897be1..4372bbf06 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -392,8 +392,17 @@  file for details about how to enable this mechanism in your configuration
 file, how to disable it for specific recipes, and how to share ``ccache``
 files between builds.
 
-However, using the class can lead to unexpected side-effects. Thus, using
-this class is not recommended.
+By default, :ref:`ref-classes-native` recipes are not supported by the
+:ref:`ref-classes-ccache` class. It is possible to add Ccache support for these
+recipes if the following configuration statements are provided from a
+:term:`configuration file`, which uses the host's ``ccache`` binary via
+:term:`HOSTTOOLS` instead of building ``ccache-native``::
+
+   ASSUME_PROVIDED += "ccache-native"
+   HOSTTOOLS += "ccache"
+
+Using the :ref:`ref-classes-ccache` class can lead to unexpected side-effects.
+Using this class is not recommended.
 
 .. _ref-classes-chrpath: