diff options
| -rw-r--r-- | documentation/dev-manual/sbom.rst | 39 |
1 files changed, 24 insertions, 15 deletions
diff --git a/documentation/dev-manual/sbom.rst b/documentation/dev-manual/sbom.rst index 448c071c55..6949675c25 100644 --- a/documentation/dev-manual/sbom.rst +++ b/documentation/dev-manual/sbom.rst | |||
| @@ -30,22 +30,29 @@ To make this happen, you must inherit the | |||
| 30 | 30 | ||
| 31 | INHERIT += "create-spdx" | 31 | INHERIT += "create-spdx" |
| 32 | 32 | ||
| 33 | You then get :term:`SPDX` output in JSON format as an | 33 | Upon building an image, you will then get: |
| 34 | ``IMAGE-MACHINE.spdx.json`` file in ``tmp/deploy/images/MACHINE/`` inside the | ||
| 35 | :term:`Build Directory`. | ||
| 36 | 34 | ||
| 37 | This is a toplevel file accompanied by an ``IMAGE-MACHINE.spdx.index.json`` | 35 | - :term:`SPDX` output in JSON format as an ``IMAGE-MACHINE.spdx.json`` file in |
| 38 | containing an index of JSON :term:`SPDX` files for individual recipes, together | 36 | ``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`. |
| 39 | with an ``IMAGE-MACHINE.spdx.tar.zst`` compressed archive containing all such | 37 | |
| 40 | files. | 38 | - This toplevel file is accompanied by an ``IMAGE-MACHINE.spdx.index.json`` |
| 39 | containing an index of JSON :term:`SPDX` files for individual recipes. | ||
| 40 | |||
| 41 | - The compressed archive ``IMAGE-MACHINE.spdx.tar.zst`` contains the index | ||
| 42 | and the files for the single recipes. | ||
| 41 | 43 | ||
| 42 | The :ref:`ref-classes-create-spdx` class offers options to include | 44 | The :ref:`ref-classes-create-spdx` class offers options to include |
| 43 | more information in the output :term:`SPDX` data, such as making the generated | 45 | more information in the output :term:`SPDX` data: |
| 44 | files more human readable (:term:`SPDX_PRETTY`), adding compressed archives of | 46 | |
| 45 | the files in the generated target packages (:term:`SPDX_ARCHIVE_PACKAGED`), | 47 | - Make the json files more human readable by setting (:term:`SPDX_PRETTY`). |
| 46 | adding a description of the source files used to generate host tools and target | 48 | |
| 47 | packages (:term:`SPDX_INCLUDE_SOURCES`) and adding archives of these source | 49 | - Add compressed archives of the files in the generated target packages by |
| 48 | files themselves (:term:`SPDX_ARCHIVE_SOURCES`). | 50 | setting (:term:`SPDX_ARCHIVE_PACKAGED`). |
| 51 | |||
| 52 | - Add a description of the source files used to generate host tools and target | ||
| 53 | packages (:term:`SPDX_INCLUDE_SOURCES`) | ||
| 54 | |||
| 55 | - Add archives of these source files themselves (:term:`SPDX_ARCHIVE_SOURCES`). | ||
| 49 | 56 | ||
| 50 | Though the toplevel :term:`SPDX` output is available in | 57 | Though the toplevel :term:`SPDX` output is available in |
| 51 | ``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`, ancillary | 58 | ``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`, ancillary |
| @@ -67,6 +74,8 @@ See the `tools page <https://spdx.dev/resources/tools/>`__ on the :term:`SPDX` | |||
| 67 | project website for a list of tools to consume and transform the :term:`SPDX` | 74 | project website for a list of tools to consume and transform the :term:`SPDX` |
| 68 | data generated by the OpenEmbedded build system. | 75 | data generated by the OpenEmbedded build system. |
| 69 | 76 | ||
| 70 | See also Joshua Watt's | 77 | See also Joshua Watt's presentations |
| 71 | `Automated SBoM generation with OpenEmbedded and the Yocto Project <https://youtu.be/Q5UQUM6zxVU>`__ | 78 | `Automated SBoM generation with OpenEmbedded and the Yocto Project <https://youtu.be/Q5UQUM6zxVU>`__ |
| 72 | presentation at FOSDEM 2023. | 79 | at FOSDEM 2023 and |
| 80 | `SPDX in the Yocto Project <https://fosdem.org/2024/schedule/event/fosdem-2024-3318-spdx-in-the-yocto-project/>`__ | ||
| 81 | at FOSDEM 2024. | ||