mirror of
https://git.yoctoproject.org/poky
synced 2026-05-09 17:39:31 +00:00
ref-manual: classes.rst: expand documentation of create-spdx class
(From yocto-docs rev: 4c6a4121d7f63e56f2743216e8219f92ed5eb94e) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
committed by
Richard Purdie
parent
a4dee23387
commit
eb5ea073a8
@@ -373,8 +373,26 @@ support.
|
|||||||
``create-spdx.bbclass``
|
``create-spdx.bbclass``
|
||||||
=======================
|
=======================
|
||||||
|
|
||||||
The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for automatically creating
|
The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for
|
||||||
SPDX SBoM documents based upon image and SDK contents.
|
automatically creating :term:`SPDX` :term:`SBOM` documents based upon image
|
||||||
|
and SDK contents.
|
||||||
|
|
||||||
|
This class is meant to be inherited globally from a configuration file::
|
||||||
|
|
||||||
|
INHERIT += "create-spdx"
|
||||||
|
|
||||||
|
The toplevel :term:`SPDX` output file is generated in JSON format as a
|
||||||
|
``IMAGE-MACHINE.spdx.json`` file in ``tmp/deploy/images/MACHINE/`` inside the
|
||||||
|
:term:`Build Directory`. There are other related files in the same directory,
|
||||||
|
as well as in ``tmp/deploy/spdx``.
|
||||||
|
|
||||||
|
The exact behaviour of this class, and the amount of output can be controlled
|
||||||
|
by the :term:`SPDX_PRETTY`, :term:`SPDX_ARCHIVE_PACKAGED`,
|
||||||
|
:term:`SPDX_ARCHIVE_SOURCES` and :term:`SPDX_INCLUDE_SOURCES` variables.
|
||||||
|
|
||||||
|
See the description of these variables and the
|
||||||
|
":ref:`dev-manual/common-tasks:creating a software bill of materials`"
|
||||||
|
section in the Yocto Project Development Manual for more details.
|
||||||
|
|
||||||
.. _ref-classes-cross:
|
.. _ref-classes-cross:
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user