summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2025-03-27 15:22:13 +0100
committerSteve Sakoman <steve@sakoman.com>2025-05-28 08:46:32 -0700
commitce1cefc34704ecf7165479f66f4bc18e3195d127 (patch)
tree62254a1ceada7991186b7a25cccc3e455547ece7
parentc6cd61f1a22d04ba3241e00caf6f35cc2ca76da1 (diff)
downloadpoky-ce1cefc34704ecf7165479f66f4bc18e3195d127.tar.gz
dev-manual/sbom.rst: fix wrong build outputs
This document was written with SPDX 3.0 in mind (create-spdx-3.0 class) on OE-Core's master, but Kirkstone only supports SPDX 2.2 (named simply create-spdx). The create-spdx class only generate a tar.zst output, so remove the other outputs listed here. Also, ancillary outputs are not only deployed in tmp/deploy/spdx/MACHINE but tmp/deploy/spdx in general. (From yocto-docs rev: 25b5ec4c71c97228f8386f5b6c4fbe272c207ed6) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r--documentation/dev-manual/sbom.rst15
1 files changed, 4 insertions, 11 deletions
diff --git a/documentation/dev-manual/sbom.rst b/documentation/dev-manual/sbom.rst
index 6949675c25..3d72a689e9 100644
--- a/documentation/dev-manual/sbom.rst
+++ b/documentation/dev-manual/sbom.rst
@@ -30,16 +30,9 @@ To make this happen, you must inherit the
30 30
31 INHERIT += "create-spdx" 31 INHERIT += "create-spdx"
32 32
33Upon building an image, you will then get: 33Upon building an image, you will then get the compressed archive
34 34``IMAGE-MACHINE.spdx.tar.zst`` contains the index and the files for the single
35- :term:`SPDX` output in JSON format as an ``IMAGE-MACHINE.spdx.json`` file in 35recipes.
36 ``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`.
37
38- This toplevel file is accompanied by an ``IMAGE-MACHINE.spdx.index.json``
39 containing an index of JSON :term:`SPDX` files for individual recipes.
40
41- The compressed archive ``IMAGE-MACHINE.spdx.tar.zst`` contains the index
42 and the files for the single recipes.
43 36
44The :ref:`ref-classes-create-spdx` class offers options to include 37The :ref:`ref-classes-create-spdx` class offers options to include
45more information in the output :term:`SPDX` data: 38more information in the output :term:`SPDX` data:
@@ -56,7 +49,7 @@ more information in the output :term:`SPDX` data:
56 49
57Though the toplevel :term:`SPDX` output is available in 50Though the toplevel :term:`SPDX` output is available in
58``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`, ancillary 51``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`, ancillary
59generated files are available in ``tmp/deploy/spdx/MACHINE`` too, such as: 52generated files are available in ``tmp/deploy/spdx`` too, such as:
60 53
61- The individual :term:`SPDX` JSON files in the ``IMAGE-MACHINE.spdx.tar.zst`` 54- The individual :term:`SPDX` JSON files in the ``IMAGE-MACHINE.spdx.tar.zst``
62 archive. 55 archive.