From: "Antonin Godard" <antonin.godard@bootlin.com>
To: <kamel.bouhara@bootlin.com>, <docs@lists.yoctoproject.org>
Subject: Re: [docs] [PATCH] ref-manual: add SPDX_INCLUDE_KERNEL_CONFIG and SPDX_INCLUDE_PACKAGECONFIG
Date: Wed, 25 Feb 2026 15:10:23 +0100 [thread overview]
Message-ID: <DGO3PZFM5WDO.3C92IW83D5RXA@bootlin.com> (raw)
In-Reply-To: <20260225110800.126491-1-kamel.bouhara@bootlin.com>
Hi,
Thanks! This looks good to me.
I've just fixed the alphabetical order in variables.rst locally:
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 2e812d02d..45073d8a0 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -9096,31 +9096,6 @@ system and gives an overview of their function and contents.
``qemux86-64``, the uncompressed SBOM file can grow from hundreds
of megabytes to several gigabytes.
- :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
- ``tmp/deploy/spdx/MACHINE/recipes/`` under the :term:`Build Directory`.
- As a consequence, the ``spdx.json`` files under the ``by-namespace`` and
- ``packages`` subdirectories in ``tmp/deploy/spdx/MACHINE`` are also
- modified to include references to such source file descriptions.
-
- Enable this option as follows::
-
- SPDX_INCLUDE_SOURCES = "1"
-
- For SPDX 2.2 format (release 4.1 "langdale"), building
- ``core-image-minimal`` for the ``qemux86-64`` machine, enabling
- this option multiplied the total size of the ``tmp/deploy/spdx``
- directory by a factor of 3 (+291 MiB for this image),
- and the size of the ``IMAGE-MACHINE.spdx.tar.zst`` in
- ``tmp/deploy/images/MACHINE`` by a factor of 130 (+15 MiB for this
- image), compared to just using the :ref:`ref-classes-create-spdx` class
- with no option.
-
- With SPDX 3.0.1 JSON format, including source files significantly
- increases the SBOM size (potentially by several gigabytes for typical
- images).
-
:term:`SPDX_INCLUDE_KERNEL_CONFIG`
This option allows exporting the Linux kernel configuration
(the contents of the ``.config`` file) into the recipe's SPDX
@@ -9164,6 +9139,31 @@ system and gives an overview of their function and contents.
the SPDX SBOM to determine which optional features were
enabled or disabled in a given build.
+ :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
+ ``tmp/deploy/spdx/MACHINE/recipes/`` under the :term:`Build Directory`.
+ As a consequence, the ``spdx.json`` files under the ``by-namespace`` and
+ ``packages`` subdirectories in ``tmp/deploy/spdx/MACHINE`` are also
+ modified to include references to such source file descriptions.
+
+ Enable this option as follows::
+
+ SPDX_INCLUDE_SOURCES = "1"
+
+ For SPDX 2.2 format (release 4.1 "langdale"), building
+ ``core-image-minimal`` for the ``qemux86-64`` machine, enabling
+ this option multiplied the total size of the ``tmp/deploy/spdx``
+ directory by a factor of 3 (+291 MiB for this image),
+ and the size of the ``IMAGE-MACHINE.spdx.tar.zst`` in
+ ``tmp/deploy/images/MACHINE`` by a factor of 130 (+15 MiB for this
+ image), compared to just using the :ref:`ref-classes-create-spdx` class
+ with no option.
+
+ With SPDX 3.0.1 JSON format, including source files significantly
+ increases the SBOM size (potentially by several gigabytes for typical
+ images).
+
:term:`SPDX_LICENSES`
Path to the JSON file containing SPDX license identifier mappings.
This file maps common license names to official SPDX license
Antonin
next prev parent reply other threads:[~2026-02-25 14:10 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-02-25 11:08 [PATCH] ref-manual: add SPDX_INCLUDE_KERNEL_CONFIG and SPDX_INCLUDE_PACKAGECONFIG Kamel Bouhara
2026-02-25 14:10 ` Antonin Godard [this message]
2026-02-25 15:54 ` [docs] " Kamel Bouhara
2026-03-02 9:53 ` Antonin Godard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=DGO3PZFM5WDO.3C92IW83D5RXA@bootlin.com \
--to=antonin.godard@bootlin.com \
--cc=docs@lists.yoctoproject.org \
--cc=kamel.bouhara@bootlin.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox