mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-01-29 21:08:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

manuals: document SPDX_PRETTY variable

Browse Source 
Now that it has been backported to Kirkstone
https://git.yoctoproject.org/poky/commit/?h=kirkstone&id=99483cff5c358d847ceb077349321eb57d5143e4

(From yocto-docs rev: 5883e897c34f25401b358a597fb6e18d80f7f90b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker
2023-01-09 19:03:34 +01:00
committed by Richard Purdie
parent ebfc6bdba4
commit d3e3783973
3 changed files with 20 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
documentation/dev-manual/common-tasks.rst
View File

@@ -11713,12 +11713,13 @@ containing an index of JSON :term:`SPDX` files for individual recipes, together
with an ``IMAGE-MACHINE.spdx.tar.zst`` compressed archive containing all such
files.
The :ref:`create-spdx <ref-classes-create-spdx>` class offers options to include
more information in the output :term:`SPDX` data, such as adding compressed
archives of the files in the generated target packages
(:term:`SPDX_ARCHIVE_PACKAGED`), adding a description of the source files
handled by the target recipes (:term:`SPDX_INCLUDE_SOURCES`) and adding archives
of these source files themselves (:term:`SPDX_ARCHIVE_SOURCES`).
The :ref:`ref-classes-create-spdx` class offers options to include
more information in the output :term:`SPDX` data, such as making the generated
files more human readable (:term:`SPDX_PRETTY`), adding compressed archives of
the files in the generated target packages (:term:`SPDX_ARCHIVE_PACKAGED`),
adding a description of the source files used to generate host tools and target
packages (:term:`SPDX_INCLUDE_SOURCES`) and adding archives of these source
files themselves (:term:`SPDX_ARCHIVE_SOURCES`).
Though the toplevel :term:`SPDX` output is available in
``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`, ancillary

4
documentation/ref-manual/classes.rst
View File

@@ -380,8 +380,8 @@ The toplevel :term:`SPDX` output file is generated in JSON format as a
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_ARCHIVE_PACKAGED`, :term:`SPDX_ARCHIVE_SOURCES` and
:term:`SPDX_INCLUDE_SOURCES` variables.
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`"

11
documentation/ref-manual/variables.rst
View File

@@ -7165,6 +7165,17 @@ system and gives an overview of their function and contents.
image), compared to just using the
:ref:`create-spdx <ref-classes-create-spdx>` class with no option.
:term:`SPDX_PRETTY`
This option makes the SPDX output more human-readable, using
identation and newlines, instead of the default output in a
single line::
SPDX_PRETTY = "1"
The generated SPDX files are approximately 20% bigger, but
this option is recommended if you want to inspect the SPDX
output files with a text editor.
:term:`SPDXLICENSEMAP`
Maps commonly used license names to their SPDX counterparts found in
``meta/files/common-licenses/``. For the default :term:`SPDXLICENSEMAP`