Skip to contentSkip to conversation

Add SPDX_INCLUDE_COMPILED_SOURCES documentation

PATCH Superseded [email protected] 2 participants 3 messages Jun 19, 2025

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Add SPDX_INCLUDE_COMPILED_SOURCES documentation

From: Daniel Turull <[email protected]>

Adding documentation for the new feature to store in SPDX only the compiled sources.

Merged in Oe-core: c6a2f1fca76fae4c3ea471a0c63d0b453beea968
- spdx: add option to include only compiled sources

---
 documentation/dev-manual/sbom.rst      |  3 +++
 documentation/ref-manual/variables.rst | 13 +++++++++++++
 2 files changed, 16 insertions(+)
documentation/dev-manual/sbom.rst +3 -0
index e6806ce92..ca0fc8b9d 100644
@@ -60,6 +60,9 @@ more information in the output :term:`SPDX` data:
 -  Add a description of the source files used to generate host tools and target
    packages (:term:`SPDX_INCLUDE_SOURCES`)
 
+-  Add a description of the **compiled** source files used to generate host tools
+   and target packages (:term:`SPDX_INCLUDE_COMPILED_SOURCES`)
+
 -  Add archives of these source files themselves (:term:`SPDX_ARCHIVE_SOURCES`).
 
 Though the toplevel :term:`SPDX` output is available in
documentation/ref-manual/variables.rst +13 -0
index 5c18b852d..39a134a09 100644
@@ -8764,6 +8764,19 @@ system and gives an overview of their function and contents.
       image), compared to just using the :ref:`ref-classes-create-spdx` class
       with no option.
 
+   :term:`SPDX_INCLUDE_COMPILED_SOURCES`
+      This option allows the same as :term:`SPDX_INCLUDE_SOURCES` but including
+      only the sources used to compiled the host tools and the target packages.
+
+      Enable this option as follows::
+
+         SPDX_INCLUDE_COMPILED_SOURCES = "1"
+
+      According to our tests on release master, building
+      ``core-image-minimal`` for the ``qemux86-64`` machine, enabling
+      this option compated with the :term:`SPDX_INCLUDE_SOURCES` reduces the size
+      of the  ``tmp/deploy/spdx`` directory from 2GB to 1.6GB.
+
    :term:`SPDX_NAMESPACE_PREFIX`
       This option could be used in order to change the prefix of ``spdxDocument``
       and the prefix of ``documentNamespace``. It is set by default to
Signature · 1 line
2.34.1
#1 lore raw
Quoted 33 lines · Daniel Turull via lists.yoctoproject.org

From: Daniel Turull <[email protected]>

Adding documentation for the new feature to store in SPDX only the compiled sources.

Merged in Oe-core: c6a2f1fca76fae4c3ea471a0c63d0b453beea968
- spdx: add option to include only compiled sources

---
 documentation/dev-manual/sbom.rst      |  3 +++
 documentation/ref-manual/variables.rst | 13 +++++++++++++
 2 files changed, 16 insertions(+)
documentation/dev-manual/sbom.rst +3 -0
index e6806ce92..ca0fc8b9d 100644
@@ -60,6 +60,9 @@ more information in the output :term:`SPDX` data:
 -  Add a description of the source files used to generate host tools and target
    packages (:term:`SPDX_INCLUDE_SOURCES`)
 
+-  Add a description of the **compiled** source files used to generate host tools
+   and target packages (:term:`SPDX_INCLUDE_COMPILED_SOURCES`)
+
 -  Add archives of these source files themselves (:term:`SPDX_ARCHIVE_SOURCES`).
 
 Though the toplevel :term:`SPDX` output is available in
documentation/ref-manual/variables.rst +0 -0
index 5c18b852d..39a134a09 100644

documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 8769

Quoted 6 lines
documentation/ref-manual/variables.rst +3 -0
@@ -8764,6 +8764,19 @@ system and gives an overview of their function and contents.
       image), compared to just using the :ref:`ref-classes-create-spdx` class
       with no option.
 
+   :term:`SPDX_INCLUDE_COMPILED_SOURCES`
+      This option allows the same as :term:`SPDX_INCLUDE_SOURCES` but including
+      only the sources used to compiled the host tools and the target packages.

s/compiled/compile/

Reading the description of 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 ...

The only difference seems to be "to build". Your description uses "to compile"... so I don't really get the difference. Maybe bad phrasing in the description of SPDX_INCLUDE_SOURCES? Can you clarify?

documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 8775

Quoted 6 lines
documentation/ref-manual/variables.rst +6 -0
+
+      Enable this option as follows::
+
+         SPDX_INCLUDE_COMPILED_SOURCES = "1"
+
+      According to our tests on release master, building

'master' is not really a release. Can you simplify to "According to our tests, building..."?

documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 8777

Quoted 2 lines
documentation/ref-manual/variables.rst +2 -0
+      ``core-image-minimal`` for the ``qemux86-64`` machine, enabling
+      this option compated with the :term:`SPDX_INCLUDE_SOURCES` reduces the size

s/compated/compared/

documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 8782

Quoted 5 lines
documentation/ref-manual/variables.rst +2 -0
+      of the  ``tmp/deploy/spdx`` directory from 2GB to 1.6GB.
+
    :term:`SPDX_NAMESPACE_PREFIX`
       This option could be used in order to change the prefix of ``spdxDocument``
       and the prefix of ``documentNamespace``. It is set by default to

Thanks,
Antonin

Signature · 3 lines
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#2 lore raw

Thanks for looking into it. I'll fix the typo and I'll clarify the description, explain the difference in a clear way and incorporate your suggestion.

Daniel

Quoted 106 lines

-----Original Message-----
From: Antonin Godard <[email protected]>
Sent: Thursday, 19 June 2025 11:14
To: Daniel Turull <[email protected]>; [email protected]
Subject: Re: [docs] [PATCH] Add SPDX_INCLUDE_COMPILED_SOURCES documentation

[You don't often get email from [email protected]. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]

Quoted 20 lines · Daniel Turull via lists.yoctoproject.org

From: Daniel Turull <[email protected]>

Adding documentation for the new feature to store in SPDX only the compiled sources.

Merged in Oe-core: c6a2f1fca76fae4c3ea471a0c63d0b453beea968
- spdx: add option to include only compiled sources

---
 documentation/dev-manual/sbom.rst      |  3 +++
 documentation/ref-manual/variables.rst | 13 +++++++++++++
 2 files changed, 16 insertions(+)
documentation/dev-manual/sbom.rst +0 -0
index e6806ce92..ca0fc8b9d 100644

documentation/dev-manual/sbom.rst more information in the output :term:`SPDX` data: · line 63

Quoted 4 lines
documentation/dev-manual/sbom.rst +1 -0
@@ -60,6 +60,9 @@ more information in the output :term:`SPDX` data:
 -  Add a description of the source files used to generate host tools and target
    packages (:term:`SPDX_INCLUDE_SOURCES`)
 
+-  Add a description of the **compiled** source files used to generate host

tools

documentation/dev-manual/sbom.rst more information in the output :term:`SPDX` data:

Quoted 3 lines
documentation/dev-manual/sbom.rst +2 -0
+   and target packages (:term:`SPDX_INCLUDE_COMPILED_SOURCES`)
+
 -  Add archives of these source files themselves

(:term:SPDX_ARCHIVE_SOURCES).

documentation/ref-manual/variables.rst system and gives an overview of their function and

Quoted 8 lines
documentation/dev-manual/sbom.rst +0 -0
 Though the toplevel :term:`SPDX` output is available in diff --git

a/documentation/ref-manual/variables.rst
b/documentation/ref-manual/variables.rst
index 5c18b852d..39a134a09 100644

documentation/ref-manual/variables.rst +0 -0
@@ -8764,6 +8764,19 @@ system and gives an overview of their function and

contents.

documentation/ref-manual/variables.rst system and gives an overview of their function and contents.

Quoted 5 lines
documentation/ref-manual/variables.rst +2 -0
       image), compared to just using the :ref:`ref-classes-create-spdx` class
       with no option.
 
+   :term:`SPDX_INCLUDE_COMPILED_SOURCES`
+      This option allows the same as :term:`SPDX_INCLUDE_SOURCES` but

including

documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 8769

Quoted 1 line
documentation/ref-manual/variables.rst +1 -0
+      only the sources used to compiled the host tools and the target packages.

s/compiled/compile/

Reading the description of 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 ...

The only difference seems to be "to build". Your description uses "to compile"... so I don't really get the difference. Maybe bad phrasing in the description of SPDX_INCLUDE_SOURCES? Can you clarify?

documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 8775

Quoted 6 lines
documentation/ref-manual/variables.rst +6 -0
+
+      Enable this option as follows::
+
+         SPDX_INCLUDE_COMPILED_SOURCES = "1"
+
+      According to our tests on release master, building

'master' is not really a release. Can you simplify to "According to our tests, building..."?

documentation/ref-manual/variables.rst system and gives an overview of their function and · line 8778

Quoted 3 lines
documentation/ref-manual/variables.rst +3 -0
+      ``core-image-minimal`` for the ``qemux86-64`` machine, enabling
+      this option compated with the :term:`SPDX_INCLUDE_SOURCES`
+ reduces the size

s/compated/compared/

Quoted 6 lines
documentation/ref-manual/variables.rst +2 -0
+      of the  ``tmp/deploy/spdx`` directory from 2GB to 1.6GB.
+
    :term:`SPDX_NAMESPACE_PREFIX`
       This option could be used in order to change the prefix of ``spdxDocument``
       and the prefix of ``documentNamespace``. It is set by default

to

Thanks,
Antonin

--
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.co/
m%2F&data=05%7C02%7Cdaniel.turull%40ericsson.com%7C213b9d0285b3412f afef08ddaf119232%7C92e84cebfbfd47abbe52080c6b87953f%7C0%7C0%7C638 859212179037319%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydW UsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D %7C0%7C%7C%7C&sdata=g6mZ1giOIaR%2BBoFjr1ryh0S4Ab70k5Q5VGCgyskUSJ w%3D&reserved=0