From d3e378397395542179a8497fbff4b610f6f7e802 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Mon, 9 Jan 2023 19:03:34 +0100 Subject: 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 Signed-off-by: Richard Purdie --- documentation/dev-manual/common-tasks.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) (limited to 'documentation/dev-manual') 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 ` 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 -- cgit v1.2.3-54-g00ecf