summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-01-09 19:03:34 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-01-10 14:21:45 +0000
commitd3e378397395542179a8497fbff4b610f6f7e802 (patch)
tree7d78b42d3be8be5c3fe512b6d171b0f14d9ea542 /documentation/dev-manual
parentebfc6bdba43761481676b4c9528463546c35dd33 (diff)
downloadpoky-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/dev-manual')
-rw-r--r--documentation/dev-manual/common-tasks.rst13
1 files changed, 7 insertions, 6 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
11713with an ``IMAGE-MACHINE.spdx.tar.zst`` compressed archive containing all such 11713with an ``IMAGE-MACHINE.spdx.tar.zst`` compressed archive containing all such
11714files. 11714files.
11715 11715
11716The :ref:`create-spdx <ref-classes-create-spdx>` class offers options to include 11716The :ref:`ref-classes-create-spdx` class offers options to include
11717more information in the output :term:`SPDX` data, such as adding compressed 11717more information in the output :term:`SPDX` data, such as making the generated
11718archives of the files in the generated target packages 11718files more human readable (:term:`SPDX_PRETTY`), adding compressed archives of
11719(:term:`SPDX_ARCHIVE_PACKAGED`), adding a description of the source files 11719the files in the generated target packages (:term:`SPDX_ARCHIVE_PACKAGED`),
11720handled by the target recipes (:term:`SPDX_INCLUDE_SOURCES`) and adding archives 11720adding a description of the source files used to generate host tools and target
11721of these source files themselves (:term:`SPDX_ARCHIVE_SOURCES`). 11721packages (:term:`SPDX_INCLUDE_SOURCES`) and adding archives of these source
11722files themselves (:term:`SPDX_ARCHIVE_SOURCES`).
11722 11723
11723Though the toplevel :term:`SPDX` output is available in 11724Though 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