1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-30 00:20:08 +00:00

manuals: document SPDX_PRETTY variable

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
+2 -2
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
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`