[PATCH] ref-manual/system-requirements.rst: add ccache in distros

[PATCH] ref-manual/system-requirements.rst: add ccache in distros

[Jose Quaresma]

Looking at the Yocto docs, ccache is missing on Debian/Ubuntu
and OpenSUSE but is in all the others.

The ccache can improve significantly the builds speeds when we can't
take advantage of the bitbake sstate cache, in such scenario we need
o compile the code. The cache storage needs to be available from the
previous builds so we need to store these ccache artifacts temporary
on our permanent storage.

The ccache is required to build "-native" packages in oe-core
because it requires HOSTTOOLS += "ccache".

Signed-off-by: Jose Quaresma <jose.quaresma@oss.qualcomm.com>
---
 .../tools/host_packages_scripts/opensuse_essential_15.6.sh      | 2 +-
 .../tools/host_packages_scripts/opensuse_essential_16.0.sh      | 2 +-
 documentation/tools/host_packages_scripts/ubuntu_essential.sh   | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/documentation/tools/host_packages_scripts/opensuse_essential_15.6.sh b/documentation/tools/host_packages_scripts/opensuse_essential_15.6.sh
index 0d37e9bd5..9f839d190 100644
--- a/documentation/tools/host_packages_scripts/opensuse_essential_15.6.sh
+++ b/documentation/tools/host_packages_scripts/opensuse_essential_15.6.sh
@@ -1,2 +1,2 @@
-sudo zypper install bzip2 chrpath diffstat gcc gcc-c++ git gzip hostname libacl1 make makeinfo patch python python-curses python-xml python3 python3-Jinja2 python3-curses python3-pexpect python3-pip rpcgen socat tar wget which xz zstd
+sudo zypper install bzip2 ccache chrpath diffstat gcc gcc-c++ git gzip hostname libacl1 make makeinfo patch python python-curses python-xml python3 python3-Jinja2 python3-curses python3-pexpect python3-pip rpcgen socat tar wget which xz zstd
 sudo pip3 install GitPython
diff --git a/documentation/tools/host_packages_scripts/opensuse_essential_16.0.sh b/documentation/tools/host_packages_scripts/opensuse_essential_16.0.sh
index f3ee6ad54..3eae28dd4 100644
--- a/documentation/tools/host_packages_scripts/opensuse_essential_16.0.sh
+++ b/documentation/tools/host_packages_scripts/opensuse_essential_16.0.sh
@@ -1 +1 @@
-sudo zypper install bzip2 chrpath diffstat gcc gcc-c++ git gzip hostname libacl1 make makeinfo patch python3 python3-GitPython python3-Jinja2 python3-curses python3-pexpect python3-pip python3-websockets python3-xml rpcgen socat tar wget which xz zstd
+sudo zypper install bzip2 ccache chrpath diffstat gcc gcc-c++ git gzip hostname libacl1 make makeinfo patch python3 python3-GitPython python3-Jinja2 python3-curses python3-pexpect python3-pip python3-websockets python3-xml rpcgen socat tar wget which xz zstd
diff --git a/documentation/tools/host_packages_scripts/ubuntu_essential.sh b/documentation/tools/host_packages_scripts/ubuntu_essential.sh
index 43f071a09..849d669c9 100644
--- a/documentation/tools/host_packages_scripts/ubuntu_essential.sh
+++ b/documentation/tools/host_packages_scripts/ubuntu_essential.sh
@@ -1 +1 @@
-sudo apt-get install build-essential chrpath cpio debianutils diffstat file gawk gcc git iputils-ping libacl1 libcrypt-dev locales python3 python3-git python3-jinja2 python3-pexpect python3-pip python3-subunit socat texinfo unzip wget xz-utils zstd
+sudo apt-get install build-essential ccache chrpath cpio debianutils diffstat file gawk gcc git iputils-ping libacl1 libcrypt-dev locales python3 python3-git python3-jinja2 python3-pexpect python3-pip python3-subunit socat texinfo unzip wget xz-utils zstd
-- 
2.55.0

Re: [docs] [PATCH] ref-manual/system-requirements.rst: add ccache in distros

[Antonin Godard]

Hi,

On Mon Aug 31, 2026 at 11:58 AM CEST, Jose Quaresma via lists.yoctoproject.org wrote:
> Looking at the Yocto docs, ccache is missing on Debian/Ubuntu
> and OpenSUSE but is in all the others.
>
> The ccache can improve significantly the builds speeds when we can't
> take advantage of the bitbake sstate cache, in such scenario we need
> o compile the code. The cache storage needs to be available from the
> previous builds so we need to store these ccache artifacts temporary
> on our permanent storage.
>
> The ccache is required to build "-native" packages in oe-core
> because it requires HOSTTOOLS += "ccache".

Thanks for the patch. Actually, it makes me wonder if we should rather do the
opposite and remove this for all distros, as this doesn't sound like a host
"requirement" to me.

Antonin

Re: [docs] [PATCH] ref-manual/system-requirements.rst: add ccache in distros

[Jose Quaresma]

[-- Attachment #1: Type: text/plain, Size: 1412 bytes --]

On Mon, Aug 31, 2026 at 11:26 AM Antonin Godard <antonin.godard@bootlin.com>
wrote:

> Hi,
>
> On Mon Aug 31, 2026 at 11:58 AM CEST, Jose Quaresma via
> lists.yoctoproject.org wrote:
> > Looking at the Yocto docs, ccache is missing on Debian/Ubuntu
> > and OpenSUSE but is in all the others.
> >
> > The ccache can improve significantly the builds speeds when we can't
> > take advantage of the bitbake sstate cache, in such scenario we need
> > o compile the code. The cache storage needs to be available from the
> > previous builds so we need to store these ccache artifacts temporary
> > on our permanent storage.
> >
> > The ccache is required to build "-native" packages in oe-core
> > because it requires HOSTTOOLS += "ccache".
>
> Thanks for the patch. Actually, it makes me wonder if we should rather do
> the
> opposite and remove this for all distros, as this doesn't sound like a host
> "requirement" to me.
>

Yeah, This is opcional and not a requirement as you said.

However, this can greatly improve build time. So it fits in the same
category as the
python-websockets, which are not a requirement because upstream hashequiv
server is not enabled by default, but it also appears listed.

To take full advantage of the ccache.bbclass, you need to have the tool in
the host;
otherwise, you can only use it for the ":target" arch.

Jose



>
> Antonin
>

[-- Attachment #2: Type: text/html, Size: 2305 bytes --]

Re: [docs] [PATCH] ref-manual/system-requirements.rst: add ccache in distros

[Antonin Godard]

On Mon Aug 31, 2026 at 12:48 PM CEST, Jose Quaresma wrote:
> On Mon, Aug 31, 2026 at 11:26 AM Antonin Godard <antonin.godard@bootlin.com>
> wrote:
>
>> Hi,
>>
>> On Mon Aug 31, 2026 at 11:58 AM CEST, Jose Quaresma via
>> lists.yoctoproject.org wrote:
>> > Looking at the Yocto docs, ccache is missing on Debian/Ubuntu
>> > and OpenSUSE but is in all the others.
>> >
>> > The ccache can improve significantly the builds speeds when we can't
>> > take advantage of the bitbake sstate cache, in such scenario we need
>> > o compile the code. The cache storage needs to be available from the
>> > previous builds so we need to store these ccache artifacts temporary
>> > on our permanent storage.
>> >
>> > The ccache is required to build "-native" packages in oe-core
>> > because it requires HOSTTOOLS += "ccache".
>>
>> Thanks for the patch. Actually, it makes me wonder if we should rather do
>> the
>> opposite and remove this for all distros, as this doesn't sound like a host
>> "requirement" to me.
>>
>
> Yeah, This is opcional and not a requirement as you said.
>
> However, this can greatly improve build time. So it fits in the same
> category as the
> python-websockets, which are not a requirement because upstream hashequiv
> server is not enabled by default, but it also appears listed.

websockets became a requirement when we made the "poky-with-sstate"
bitbake-setup configuration proposed as part of the choices when running
"bitbake-setup init". It would have made no sense to suggest a configuration
with a missing package otherwise.

> To take full advantage of the ccache.bbclass, you need to have the tool in
> the host;
> otherwise, you can only use it for the ":target" arch.

I think this should then be stated in the ccache class documentation, in
documentation/ref-manual/classes.rst. The host requirements should be kept
minimal, IMO.

Antonin

Re: [docs] [PATCH] ref-manual/system-requirements.rst: add ccache in distros

[Jose Quaresma]

[-- Attachment #1: Type: text/plain, Size: 2532 bytes --]

On Mon, Aug 31, 2026 at 1:26 PM Antonin Godard <antonin.godard@bootlin.com>
wrote:

> On Mon Aug 31, 2026 at 12:48 PM CEST, Jose Quaresma wrote:
> > On Mon, Aug 31, 2026 at 11:26 AM Antonin Godard <
> antonin.godard@bootlin.com>
> > wrote:
> >
> >> Hi,
> >>
> >> On Mon Aug 31, 2026 at 11:58 AM CEST, Jose Quaresma via
> >> lists.yoctoproject.org wrote:
> >> > Looking at the Yocto docs, ccache is missing on Debian/Ubuntu
> >> > and OpenSUSE but is in all the others.
> >> >
> >> > The ccache can improve significantly the builds speeds when we can't
> >> > take advantage of the bitbake sstate cache, in such scenario we need
> >> > o compile the code. The cache storage needs to be available from the
> >> > previous builds so we need to store these ccache artifacts temporary
> >> > on our permanent storage.
> >> >
> >> > The ccache is required to build "-native" packages in oe-core
> >> > because it requires HOSTTOOLS += "ccache".
> >>
> >> Thanks for the patch. Actually, it makes me wonder if we should rather
> do
> >> the
> >> opposite and remove this for all distros, as this doesn't sound like a
> host
> >> "requirement" to me.
> >>
> >
> > Yeah, This is opcional and not a requirement as you said.
> >
> > However, this can greatly improve build time. So it fits in the same
> > category as the
> > python-websockets, which are not a requirement because upstream hashequiv
> > server is not enabled by default, but it also appears listed.
>
> websockets became a requirement when we made the "poky-with-sstate"
> bitbake-setup configuration proposed as part of the choices when running
> "bitbake-setup init". It would have made no sense to suggest a
> configuration
> with a missing package otherwise.
>

I completely agree with what you say.


>
> > To take full advantage of the ccache.bbclass, you need to have the tool
> in
> > the host;
> > otherwise, you can only use it for the ":target" arch.
>
> I think this should then be stated in the ccache class documentation, in
> documentation/ref-manual/classes.rst. The host requirements should be kept
> minimal, IMO.
>

The documentation [1] already mention the requirements for "-native"
targets:

ASSUME_PROVIDED += "ccache-native"
HOSTTOOLS += "ccache"

[1] https://docs.yoctoproject.org/ref-manual/classes.html#ccache

This requirement was added last year
https://github.com/openembedded/openembedded-core/commit/cc91a0f6500e88dd96a56307226fcfd16c60c342

Jose


>
> Antonin
>

[-- Attachment #2: Type: text/html, Size: 4285 bytes --]

Re: [docs] [PATCH] ref-manual/system-requirements.rst: add ccache in distros

[Antonin Godard]

On 2026-08-31 14:06:28+01:00, Jose Quaresma wrote:
> On Mon, Aug 31, 2026 at 1:26 PM Antonin Godard <antonin.godard@bootlin.com>
> wrote:
> 
> > On Mon Aug 31, 2026 at 12:48 PM CEST, Jose Quaresma wrote:
> > antonin.godard@bootlin.com>
> > do
> > host
> >
> > websockets became a requirement when we made the "poky-with-sstate"
> > bitbake-setup configuration proposed as part of the choices when running
> > "bitbake-setup init". It would have made no sense to suggest a
> > configuration
> > with a missing package otherwise.
> 
> I completely agree with what you say.
> 
> > in
> >
> > I think this should then be stated in the ccache class documentation, in
> > documentation/ref-manual/classes.rst. The host requirements should be kept
> > minimal, IMO.
> 
> The documentation [1] already mention the requirements for "-native"
> targets:
> 
> ASSUME_PROVIDED += "ccache-native"
> HOSTTOOLS += "ccache"
> 
> [1] https://docs.yoctoproject.org/ref-manual/classes.html#ccache
> 
> This requirement was added last year
> https://github.com/openembedded/openembedded-core/commit/cc91a0f6500e88dd96a56307226fcfd16c60c342

Still, I don't think it really is a requirement, and I think the way forward is
to actually remove this from ubuntu_essential.sh, fedora_essential.sh,
opensuse_essential_15.6.sh, and opensuse_essential_16.0.sh so that all distros
are aligned.

If you agree, can you send a follow-up patch?

Thanks,
Antonin

Re: [docs] [PATCH] ref-manual/system-requirements.rst: add ccache in distros

[Richard Purdie]

On Tue, 2026-09-01 at 14:20 +0200, Antonin Godard via lists.yoctoproject.org wrote:
> On 2026-08-31 14:06:28+01:00, Jose Quaresma wrote:
> > > in
> > > 
> > > I think this should then be stated in the ccache class documentation, in
> > > documentation/ref-manual/classes.rst. The host requirements should be kept
> > > minimal, IMO.
> > 
> > The documentation [1] already mention the requirements for "-native"
> > targets:
> > 
> > ASSUME_PROVIDED += "ccache-native"
> > HOSTTOOLS += "ccache"
> > 
> > [1] https://docs.yoctoproject.org/ref-manual/classes.html#ccache
> > 
> > This requirement was added last year
> > https://github.com/openembedded/openembedded-core/commit/cc91a0f6500e88dd96a56307226fcfd16c60c342
> 
> Still, I don't think it really is a requirement, and I think the way forward is
> to actually remove this from ubuntu_essential.sh, fedora_essential.sh,
> opensuse_essential_15.6.sh, and opensuse_essential_16.0.sh so that all distros
> are aligned.
> 
> If you agree, can you send a follow-up patch?

I agree with this FWIW!

Cheers,

Richard

Re: [docs] [PATCH] ref-manual/system-requirements.rst: add ccache in distros

[Jose Quaresma]

[-- Attachment #1: Type: text/plain, Size: 1343 bytes --]

On Tue, Sep 1, 2026 at 1:40 PM Richard Purdie <
richard.purdie@linuxfoundation.org> wrote:

> On Tue, 2026-09-01 at 14:20 +0200, Antonin Godard via
> lists.yoctoproject.org wrote:
> > On 2026-08-31 14:06:28+01:00, Jose Quaresma wrote:
> > > > in
> > > >
> > > > I think this should then be stated in the ccache class
> documentation, in
> > > > documentation/ref-manual/classes.rst. The host requirements should
> be kept
> > > > minimal, IMO.
> > >
> > > The documentation [1] already mention the requirements for "-native"
> > > targets:
> > >
> > > ASSUME_PROVIDED += "ccache-native"
> > > HOSTTOOLS += "ccache"
> > >
> > > [1] https://docs.yoctoproject.org/ref-manual/classes.html#ccache
> > >
> > > This requirement was added last year
> > >
> https://github.com/openembedded/openembedded-core/commit/cc91a0f6500e88dd96a56307226fcfd16c60c342
> >
> > Still, I don't think it really is a requirement, and I think the way
> forward is
> > to actually remove this from ubuntu_essential.sh, fedora_essential.sh,
> > opensuse_essential_15.6.sh, and opensuse_essential_16.0.sh so that all
> distros
> > are aligned.
> >
> > If you agree, can you send a follow-up patch?
>
> I agree with this FWIW!
>

v2 sent https://lists.yoctoproject.org/g/docs/message/10431

Jose


>
> Cheers,
>
> Richard
>

[-- Attachment #2: Type: text/html, Size: 2619 bytes --]