diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-04-18 11:05:28 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-04-28 14:46:17 +0100 |
commit | 9b6a25606eae96ed835e2f87c3c85d37a4607f76 (patch) | |
tree | 9fd3fbf0a39f3601c39368ef85377e07fd716bb4 /documentation/ref-manual | |
parent | aa6c2cc60eb23a71ac22148adc7ce93eadf92bb0 (diff) | |
download | poky-9b6a25606eae96ed835e2f87c3c85d37a4607f76.tar.gz |
manuals: document SPDX_CUSTOM_ANNOTATION_VARS
(From yocto-docs rev: 5811f4eb3e73aa5f8ca90e40ec6559a6d4d58fa3)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
CC: Saul Wold <Saul.Wold@windriver.com>
CC: Joshua Watt <JPEWhacker@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/variables.rst | 26 |
1 files changed, 26 insertions, 0 deletions
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. | |||
7578 | (+ 0.07\% with the tested image), compared to just enabling | 7578 | (+ 0.07\% with the tested image), compared to just enabling |
7579 | :term:`SPDX_INCLUDE_SOURCES`. | 7579 | :term:`SPDX_INCLUDE_SOURCES`. |
7580 | 7580 | ||
7581 | :term:`SPDX_CUSTOM_ANNOTATION_VARS` | ||
7582 | This option allows to associate `SPDX annotations | ||
7583 | <https://spdx.github.io/spdx-spec/v2.3/annotations/>`__ to a recipe, | ||
7584 | using the values of variables in the recipe:: | ||
7585 | |||
7586 | ANNOTATION1 = "First annotation for recipe" | ||
7587 | ANNOTATION2 = "Second annotation for recipe" | ||
7588 | SPDX_CUSTOM_ANNOTATION_VARS = "ANNOTATION1 ANNOTATION2" | ||
7589 | |||
7590 | This will add a new block to the recipe ``.sdpx.json`` output:: | ||
7591 | |||
7592 | "annotations": [ | ||
7593 | { | ||
7594 | "annotationDate": "2023-04-18T08:32:12Z", | ||
7595 | "annotationType": "OTHER", | ||
7596 | "annotator": "Tool: oe-spdx-creator - 1.0", | ||
7597 | "comment": "ANNOTATION1=First annotation for recipe" | ||
7598 | }, | ||
7599 | { | ||
7600 | "annotationDate": "2023-04-18T08:32:12Z", | ||
7601 | "annotationType": "OTHER", | ||
7602 | "annotator": "Tool: oe-spdx-creator - 1.0", | ||
7603 | "comment": "ANNOTATION2=Second annotation for recipe" | ||
7604 | } | ||
7605 | ], | ||
7606 | |||
7581 | :term:`SPDX_INCLUDE_SOURCES` | 7607 | :term:`SPDX_INCLUDE_SOURCES` |
7582 | This option allows to add a description of the source files used to build | 7608 | This option allows to add a description of the source files used to build |
7583 | the host tools and the target packages, to the ``spdx.json`` files in | 7609 | the host tools and the target packages, to the ``spdx.json`` files in |