From: ecordonnier@snap.com
To: docs@lists.yoctoproject.org
Cc: Etienne Cordonnier <ecordonnier@snap.com>
Subject: [docs][PATCH v2] ref-manual/variables.rst: document SSTATE_SKIP_CREATION
Date: Fri, 23 May 2025 13:24:28 +0200 [thread overview]
Message-ID: <20250523112428.278675-1-ecordonnier@snap.com> (raw)
From: Etienne Cordonnier <ecordonnier@snap.com>
Signed-off-by: Etienne Cordonnier <ecordonnier@snap.com>
---
documentation/ref-manual/variables.rst | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 643a3e7ae8f..dc6dd2f1ba4 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -9049,6 +9049,26 @@ system and gives an overview of their function and contents.
For details on the process, see the :ref:`ref-classes-staging` class.
+ :term:`SSTATE_SKIP_CREATION`
+ The :term:`SSTATE_SKIP_CREATION` variable can be used to skip the creation of
+ :ref:`shared state <overview-manual/concepts:shared state cache>` tarball files. It makes sense e.g. for image creation tasks as
+ tarring images and keeping them in sstate would consume a lot of
+ disk space.
+
+ In general it is not recommended to use this variable as missing sstate
+ artefacts adversely impact the build, particularly for entries in the
+ middle of dependency chains. The case it can make sense is where the
+ size and time costs of the artefact are similar to just running the
+ tasks. This generally only applies to end artefact output like images.
+
+ The syntax to disable it for one task is:
+
+ SSTATE_SKIP_CREATION:task-image-complete = "1"
+
+ The syntax to disable it for the whole recipe is:
+
+ SSTATE_SKIP_CREATION = "1"
+
:term:`STAGING_BASE_LIBDIR_NATIVE`
Specifies the path to the ``/lib`` subdirectory of the sysroot
directory for the build host.
--
2.43.0
next reply other threads:[~2025-05-23 11:24 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-05-23 11:24 ecordonnier [this message]
2025-05-23 13:51 ` [docs][PATCH v2] ref-manual/variables.rst: document SSTATE_SKIP_CREATION Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250523112428.278675-1-ecordonnier@snap.com \
--to=ecordonnier@snap.com \
--cc=docs@lists.yoctoproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox