diff options
| -rw-r--r-- | documentation/dev-manual/common-tasks.rst | 13 | ||||
| -rw-r--r-- | documentation/ref-manual/classes.rst | 4 | ||||
| -rw-r--r-- | documentation/ref-manual/variables.rst | 11 |
3 files changed, 20 insertions, 8 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 1b91ada0a1..ce7eb6c9dd 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -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 diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 6e73c5d4fb..6ee0d33451 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -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`" diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index c182478a31..061b1c28d8 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -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` |