summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorMikko Rapeli <mikko.rapeli@linaro.org>2025-03-10 17:31:08 +0200
committerSteve Sakoman <steve@sakoman.com>2025-05-19 08:57:20 -0700
commiteed3e6c2c83a9ad71bebb863e80e36c822bdd3e3 (patch)
treef2ff5c2ca23795a0e3111ccd42e351a3deed67a9 /documentation/dev-manual
parent81d9f2c8775b7fd433bae0ec73e9950117229379 (diff)
downloadpoky-eed3e6c2c83a9ad71bebb863e80e36c822bdd3e3.tar.gz
sbom.rst: how to disable SPDX generation
Generating SPDX is enabled by default in poky but it can take a lot of build time resources so document how to disable it. (From yocto-docs rev: d26a3f2ed8f24e1b72f58ecb8b7cdba7007ba77b) Signed-off-by: Mikko Rapeli <mikko.rapeli@linaro.org> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit bcd58b7a9455fbb0ea5944089d663e327f0eb38f) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/sbom.rst14
1 files changed, 11 insertions, 3 deletions
diff --git a/documentation/dev-manual/sbom.rst b/documentation/dev-manual/sbom.rst
index b72bad1554..eba07b7832 100644
--- a/documentation/dev-manual/sbom.rst
+++ b/documentation/dev-manual/sbom.rst
@@ -24,12 +24,20 @@ users can read in standardized format.
24:term:`SBOM` information is also critical to performing vulnerability exposure 24:term:`SBOM` information is also critical to performing vulnerability exposure
25assessments, as all the components used in the Software Supply Chain are listed. 25assessments, as all the components used in the Software Supply Chain are listed.
26 26
27The OpenEmbedded build system doesn't generate such information by default. 27The OpenEmbedded build system doesn't generate such information by default,
28To make this happen, you must inherit the 28though the `:term:`Poky` reference distribution has it enabled out of the box.
29:ref:`ref-classes-create-spdx` class from a configuration file:: 29
30To enable it, inherit the :ref:`ref-classes-create-spdx` class from a
31configuration file::
30 32
31 INHERIT += "create-spdx" 33 INHERIT += "create-spdx"
32 34
35In the `:term:`Poky` reference distribution, :term:`SPDX` generation does
36consume some build time resources and thus if needed it can be disabled from a
37:term:`configuration file`::
38
39 INHERIT:remove = "create-spdx"
40
33Upon building an image, you will then get: 41Upon building an image, you will then get:
34 42
35- :term:`SPDX` output in JSON format as an ``IMAGE-MACHINE.spdx.json`` file in 43- :term:`SPDX` output in JSON format as an ``IMAGE-MACHINE.spdx.json`` file in