diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-01-09 19:03:34 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-01-10 14:21:45 +0000 |
commit | d3e378397395542179a8497fbff4b610f6f7e802 (patch) | |
tree | 7d78b42d3be8be5c3fe512b6d171b0f14d9ea542 /documentation | |
parent | ebfc6bdba43761481676b4c9528463546c35dd33 (diff) | |
download | poky-d3e378397395542179a8497fbff4b610f6f7e802.tar.gz |
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>
Diffstat (limited to 'documentation')
-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 | |||
11713 | with an ``IMAGE-MACHINE.spdx.tar.zst`` compressed archive containing all such | 11713 | with an ``IMAGE-MACHINE.spdx.tar.zst`` compressed archive containing all such |
11714 | files. | 11714 | files. |
11715 | 11715 | ||
11716 | The :ref:`create-spdx <ref-classes-create-spdx>` class offers options to include | 11716 | The :ref:`ref-classes-create-spdx` class offers options to include |
11717 | more information in the output :term:`SPDX` data, such as adding compressed | 11717 | more information in the output :term:`SPDX` data, such as making the generated |
11718 | archives of the files in the generated target packages | 11718 | files more human readable (:term:`SPDX_PRETTY`), adding compressed archives of |
11719 | (:term:`SPDX_ARCHIVE_PACKAGED`), adding a description of the source files | 11719 | the files in the generated target packages (:term:`SPDX_ARCHIVE_PACKAGED`), |
11720 | handled by the target recipes (:term:`SPDX_INCLUDE_SOURCES`) and adding archives | 11720 | adding a description of the source files used to generate host tools and target |
11721 | of these source files themselves (:term:`SPDX_ARCHIVE_SOURCES`). | 11721 | packages (:term:`SPDX_INCLUDE_SOURCES`) and adding archives of these source |
11722 | files themselves (:term:`SPDX_ARCHIVE_SOURCES`). | ||
11722 | 11723 | ||
11723 | Though the toplevel :term:`SPDX` output is available in | 11724 | Though the toplevel :term:`SPDX` output is available in |
11724 | ``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`, ancillary | 11725 | ``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 | |||
380 | as well as in ``tmp/deploy/spdx``. | 380 | as well as in ``tmp/deploy/spdx``. |
381 | 381 | ||
382 | The exact behaviour of this class, and the amount of output can be controlled | 382 | The exact behaviour of this class, and the amount of output can be controlled |
383 | by the :term:`SPDX_ARCHIVE_PACKAGED`, :term:`SPDX_ARCHIVE_SOURCES` and | 383 | by the :term:`SPDX_PRETTY`, :term:`SPDX_ARCHIVE_PACKAGED`, |
384 | :term:`SPDX_INCLUDE_SOURCES` variables. | 384 | :term:`SPDX_ARCHIVE_SOURCES` and :term:`SPDX_INCLUDE_SOURCES` variables. |
385 | 385 | ||
386 | See the description of these variables and the | 386 | See the description of these variables and the |
387 | ":ref:`dev-manual/common-tasks:creating a software bill of materials`" | 387 | ":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. | |||
7165 | image), compared to just using the | 7165 | image), compared to just using the |
7166 | :ref:`create-spdx <ref-classes-create-spdx>` class with no option. | 7166 | :ref:`create-spdx <ref-classes-create-spdx>` class with no option. |
7167 | 7167 | ||
7168 | :term:`SPDX_PRETTY` | ||
7169 | This option makes the SPDX output more human-readable, using | ||
7170 | identation and newlines, instead of the default output in a | ||
7171 | single line:: | ||
7172 | |||
7173 | SPDX_PRETTY = "1" | ||
7174 | |||
7175 | The generated SPDX files are approximately 20% bigger, but | ||
7176 | this option is recommended if you want to inspect the SPDX | ||
7177 | output files with a text editor. | ||
7178 | |||
7168 | :term:`SPDXLICENSEMAP` | 7179 | :term:`SPDXLICENSEMAP` |
7169 | Maps commonly used license names to their SPDX counterparts found in | 7180 | Maps commonly used license names to their SPDX counterparts found in |
7170 | ``meta/files/common-licenses/``. For the default :term:`SPDXLICENSEMAP` | 7181 | ``meta/files/common-licenses/``. For the default :term:`SPDXLICENSEMAP` |