From 9b6a25606eae96ed835e2f87c3c85d37a4607f76 Mon Sep 17 00:00:00 2001 From: Michael Opdenacker Date: Tue, 18 Apr 2023 11:05:28 +0200 Subject: manuals: document SPDX_CUSTOM_ANNOTATION_VARS (From yocto-docs rev: 5811f4eb3e73aa5f8ca90e40ec6559a6d4d58fa3) Signed-off-by: Michael Opdenacker CC: Saul Wold CC: Joshua Watt Signed-off-by: Richard Purdie --- documentation/ref-manual/variables.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) (limited to 'documentation/ref-manual') diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 29143caa3e..01b710199d 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -7578,6 +7578,32 @@ system and gives an overview of their function and contents. (+ 0.07\% with the tested image), compared to just enabling :term:`SPDX_INCLUDE_SOURCES`. + :term:`SPDX_CUSTOM_ANNOTATION_VARS` + This option allows to associate `SPDX annotations + `__ to a recipe, + using the values of variables in the recipe:: + + ANNOTATION1 = "First annotation for recipe" + ANNOTATION2 = "Second annotation for recipe" + SPDX_CUSTOM_ANNOTATION_VARS = "ANNOTATION1 ANNOTATION2" + + This will add a new block to the recipe ``.sdpx.json`` output:: + + "annotations": [ + { + "annotationDate": "2023-04-18T08:32:12Z", + "annotationType": "OTHER", + "annotator": "Tool: oe-spdx-creator - 1.0", + "comment": "ANNOTATION1=First annotation for recipe" + }, + { + "annotationDate": "2023-04-18T08:32:12Z", + "annotationType": "OTHER", + "annotator": "Tool: oe-spdx-creator - 1.0", + "comment": "ANNOTATION2=Second annotation for recipe" + } + ], + :term:`SPDX_INCLUDE_SOURCES` This option allows to add a description of the source files used to build the host tools and the target packages, to the ``spdx.json`` files in -- cgit v1.2.3-54-g00ecf