diff options
-rw-r--r-- | documentation/dev-manual/sbom.rst | 3 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 22 |
2 files changed, 25 insertions, 0 deletions
diff --git a/documentation/dev-manual/sbom.rst b/documentation/dev-manual/sbom.rst index e6806ce929..ca0fc8b9d6 100644 --- a/documentation/dev-manual/sbom.rst +++ b/documentation/dev-manual/sbom.rst | |||
@@ -60,6 +60,9 @@ more information in the output :term:`SPDX` data: | |||
60 | - Add a description of the source files used to generate host tools and target | 60 | - Add a description of the source files used to generate host tools and target |
61 | packages (:term:`SPDX_INCLUDE_SOURCES`) | 61 | packages (:term:`SPDX_INCLUDE_SOURCES`) |
62 | 62 | ||
63 | - Add a description of the **compiled** source files used to generate host tools | ||
64 | and target packages (:term:`SPDX_INCLUDE_COMPILED_SOURCES`) | ||
65 | |||
63 | - Add archives of these source files themselves (:term:`SPDX_ARCHIVE_SOURCES`). | 66 | - Add archives of these source files themselves (:term:`SPDX_ARCHIVE_SOURCES`). |
64 | 67 | ||
65 | Though the toplevel :term:`SPDX` output is available in | 68 | Though the toplevel :term:`SPDX` output is available in |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 65c54f3861..c6ae3fb8bc 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -8762,6 +8762,28 @@ system and gives an overview of their function and contents. | |||
8762 | image), compared to just using the :ref:`ref-classes-create-spdx` class | 8762 | image), compared to just using the :ref:`ref-classes-create-spdx` class |
8763 | with no option. | 8763 | with no option. |
8764 | 8764 | ||
8765 | :term:`SPDX_INCLUDE_COMPILED_SOURCES` | ||
8766 | This option allows the same as :term:`SPDX_INCLUDE_SOURCES` but including | ||
8767 | only the sources used to compile the host tools and the target packages. | ||
8768 | While :term:`SPDX_INCLUDE_SOURCES` includes all files in the source | ||
8769 | directory as source file descriptions, :term:`SPDX_INCLUDE_COMPILED_SOURCES` | ||
8770 | includes only the sources that are used to produce the binaries delivered | ||
8771 | as packages. The source files that are not used during compilation are not | ||
8772 | included in the SBOM. It uses debugsource information generated during | ||
8773 | ``do_package`` to filter out source files. | ||
8774 | |||
8775 | This enables an external tool to use the SPDX information to disregard | ||
8776 | vulnerabilities that are not compiled in the packages. | ||
8777 | |||
8778 | Enable this option as follows:: | ||
8779 | |||
8780 | SPDX_INCLUDE_COMPILED_SOURCES = "1" | ||
8781 | |||
8782 | According to our tests, building ``core-image-minimal`` for the | ||
8783 | ``qemux86-64`` machine, enabling this option compared with the | ||
8784 | :term:`SPDX_INCLUDE_SOURCES` reduces the size of the ``tmp/deploy/spdx`` | ||
8785 | directory from 2GB to 1.6GB. | ||
8786 | |||
8765 | :term:`SPDX_NAMESPACE_PREFIX` | 8787 | :term:`SPDX_NAMESPACE_PREFIX` |
8766 | This option could be used in order to change the prefix of ``spdxDocument`` | 8788 | This option could be used in order to change the prefix of ``spdxDocument`` |
8767 | and the prefix of ``documentNamespace``. It is set by default to | 8789 | and the prefix of ``documentNamespace``. It is set by default to |