Skip to contentSkip to conversation

: backport SPDX documentation and vulnerability improvements

PATCH New [email protected] 1 participant 1 message Nov 24, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 : backport SPDX documentation and vulnerability improvements

From: Michael Opdenacker <[email protected]>

---
 documentation/conf.py                     |   1 +
 documentation/dev-manual/common-tasks.rst | 289 ++++++++++++++++------
 documentation/ref-manual/terms.rst        |  28 +++
 documentation/ref-manual/variables.rst    |  94 +++++++
 4 files changed, 330 insertions(+), 82 deletions(-)
documentation/conf.py +1 -0
index 07a15ce7de..bd45a73fa6 100644
@@ -106,6 +106,7 @@ extlinks = {
     'oe_wiki': ('https://www.openembedded.org/wiki%s', None),
     'oe_layerindex': ('https://layers.openembedded.org%s', None),
     'oe_layer': ('https://layers.openembedded.org/layerindex/branch/master/layer%s', None),
+    'wikipedia': ('https://en.wikipedia.org/wiki/%s', None),
 }
 
 # Intersphinx config to use cross reference with BitBake user manual
documentation/dev-manual/common-tasks.rst +207 -82

356 lines not on this page · raw message

documentation/ref-manual/terms.rst +28 -0
index 1e3f718a8f..7e5295a646 100644
@@ -323,6 +323,23 @@ universal, the list includes them just in case:
       :term:`build host<Build Host>` and other components, that can
       work on specific hardware.
 
+   :term:`SBOM`
+      This term means *Software Bill of Materials*. When you distribute
+      software, it offers a description of all the components you used,
+      their corresponding licenses, their dependencies, the changes that were
+      applied and the known vulnerabilities that were fixed.
+
+      This can be used by the recipients of the software to assess
+      their exposure to license compliance and security vulnerability issues.
+
+      See the :wikipedia:`Software Supply Chain <Software_supply_chain>`
+      article on Wikipedia for more details.
+
+      The OpenEmbedded Build System can generate such documentation for your
+      project, in :term:`SPDX` format, based on all the metadata it used to
+      build the software images. See the ":ref:`dev-manual/common-tasks:creating
+      a software bill of materials`" section of the Development Tasks manual.
+
    :term:`Source Directory`
      This term refers to the directory structure
      created as a result of creating a local copy of the ``poky`` Git
@@ -383,6 +400,17 @@ universal, the list includes them just in case:
      ":ref:`overview-manual/development-environment:repositories, tags, and branches`"
      section in the Yocto Project Overview and Concepts Manual.
 
+   :term:`SPDX`
+      This term means *Software Package Data Exchange*, and is used as a open
+      standard for providing a *Software Bill of Materials* (:term:`SBOM`).
+      This standard is developed through a `Linux Foundation project
+      <https://spdx.dev/>`__ and is used by the OpenEmbedded Build System to
+      provide an :term:`SBOM` associated to each a software image.
+
+      For details, see Wikipedia's :wikipedia:`SPDX page <Software_Package_Data_Exchange>`
+      and the ":ref:`dev-manual/common-tasks:creating a software bill of materials`"
+      section of the Development Tasks manual.
+
    :term:`Sysroot`
       When cross-compiling, the target file system may be differently laid
       out and contain different things compared to the host system. The concept
documentation/ref-manual/variables.rst +94 -0

106 lines not on this page · raw message

Signature · 1 line
2.34.1