diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-10-28 11:25:02 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-11-07 21:31:32 +0000 |
commit | eb5ea073a8ce877ee49efdcc60f6b33abae0515d (patch) | |
tree | 984aeab277c4b729b3dd8e0a46ceb5114b3c9817 /documentation | |
parent | a4dee23387839ec5c995f1508851f964a622cf69 (diff) | |
download | poky-eb5ea073a8ce877ee49efdcc60f6b33abae0515d.tar.gz |
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>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/ref-manual/classes.rst | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 3b33783c58..5537eb774a 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -373,8 +373,26 @@ support. | |||
373 | ``create-spdx.bbclass`` | 373 | ``create-spdx.bbclass`` |
374 | ======================= | 374 | ======================= |
375 | 375 | ||
376 | The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for automatically creating | 376 | The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for |
377 | SPDX SBoM documents based upon image and SDK contents. | 377 | automatically creating :term:`SPDX` :term:`SBOM` documents based upon image |
378 | and SDK contents. | ||
379 | |||
380 | This class is meant to be inherited globally from a configuration file:: | ||
381 | |||
382 | INHERIT += "create-spdx" | ||
383 | |||
384 | The toplevel :term:`SPDX` output file is generated in JSON format as a | ||
385 | ``IMAGE-MACHINE.spdx.json`` file in ``tmp/deploy/images/MACHINE/`` inside the | ||
386 | :term:`Build Directory`. There are other related files in the same directory, | ||
387 | as well as in ``tmp/deploy/spdx``. | ||
388 | |||
389 | The exact behaviour of this class, and the amount of output can be controlled | ||
390 | by the :term:`SPDX_PRETTY`, :term:`SPDX_ARCHIVE_PACKAGED`, | ||
391 | :term:`SPDX_ARCHIVE_SOURCES` and :term:`SPDX_INCLUDE_SOURCES` variables. | ||
392 | |||
393 | See the description of these variables and the | ||
394 | ":ref:`dev-manual/common-tasks:creating a software bill of materials`" | ||
395 | section in the Yocto Project Development Manual for more details. | ||
378 | 396 | ||
379 | .. _ref-classes-cross: | 397 | .. _ref-classes-cross: |
380 | 398 | ||