diff mbox series

[07/18] dev-manual/sbom.rst: add bullet point on recipe SBOM

Message ID 20260410-second-release-notes-6-0-v1-7-40213436c3ca@bootlin.com
State New
Headers show
Series Updates for upcoming Wrynose release | expand

Commit Message

Antonin Godard April 10, 2026, 2:43 p.m. UTC 
Added by commit d999ac407c86 ("spdx3: Add recipe SPDX data") in OE-Core.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/dev-manual/sbom.rst | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)
diff mbox series

Patch

diff --git a/documentation/dev-manual/sbom.rst b/documentation/dev-manual/sbom.rst
index 819340a74..45b63ed8e 100644
--- a/documentation/dev-manual/sbom.rst
+++ b/documentation/dev-manual/sbom.rst
@@ -31,9 +31,20 @@  If needed, it can be disabled from a :term:`configuration file`::
 
    INHERIT_DISTRO:remove = "create-spdx"
 
-Upon building an image, you will then get the :term:`SPDX` output in JSON format
-as an ``IMAGE-MACHINE.spdx.json`` file in ``tmp/deploy/images/MACHINE/`` inside
-the :term:`Build Directory`.
+There are two ways to generate SBOM metadata:
+
+-  By building an image, you will then get the :term:`SPDX` output in JSON format
+   as an ``IMAGE-MACHINE.spdx.json`` file in ``tmp/deploy/images/MACHINE/`` inside
+   the :term:`Build Directory`.
+
+-  By generating the SBOM document using the recipe metadata only:
+
+   .. code-block:: console
+
+      $ bitbake <recipe> -c create_recipe_sbom
+
+   Note that recipe SBOM is also included in the image SBOM document (for the
+   recipes involved in the build of the image only).
 
 The :ref:`ref-classes-create-spdx` class offers options to include
 more information in the output :term:`SPDX` data: