From patchwork Fri Oct 28 15:10:29 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 14532 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id B272BC38A02 for ; Fri, 28 Oct 2022 15:10:56 +0000 (UTC) Received: from relay4-d.mail.gandi.net (relay4-d.mail.gandi.net [217.70.183.196]) by mx.groups.io with SMTP id smtpd.web11.626.1666969848924000196 for ; Fri, 28 Oct 2022 08:10:49 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=DGVq7eq2; spf=pass (domain: bootlin.com, ip: 217.70.183.196, mailfrom: michael.opdenacker@bootlin.com) Received: (Authenticated sender: michael.opdenacker@bootlin.com) by mail.gandi.net (Postfix) with ESMTPSA id E4AB2E0006; Fri, 28 Oct 2022 15:10:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1666969847; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Al+A2cl58LaZHXeKAoMjkOibRO4FhJTolw+UhP3GTMA=; b=DGVq7eq2cf6M1nuIYIjOfbm7v6WGlG4bDXLVy7zLbOXSLpQm6gQVdFdVfguQlOs6ogGBMI ZVOy1hIn6oqx+owGy34Do2BgNoQaVz7TEJAqTY1kB9As7sDMcvaI8SVgTa5TKxacyz6Raa mnnNzL6qdxo0kRKqjQrD/oWae7bsBy9a0fKaQ8RKqAr4hZu/stlN8CgXgWdq1mLa64ixCK gC3P2M8jr9PpV7SmFVNyyrSOA2BacRXc/+E7XsGcNSJQn0kKbt5g7ouL6Ch1jJMhtOvkv/ 4pB0A/yZkOOos56DKVoCX5qUkZxLslroR6K19CFYBjjDAao1r0Ry55GlDh+pdw== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: JPEWhacker@gmail.com, mikko.rapeli@linaro.org, Michael Opdenacker Subject: [PATCH v2 1/5] ref-manual: terms.rst: add SBOM and SPDX terms Date: Fri, 28 Oct 2022 17:10:29 +0200 Message-Id: <20221028151033.383087-2-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20221028151033.383087-1-michael.opdenacker@bootlin.com> References: <17224368BE5A21CF.6604@lists.yoctoproject.org> <20221028151033.383087-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 28 Oct 2022 15:10:56 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/3443 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/ref-manual/terms.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst index 40209528ba..4711d7df7b 100644 --- a/documentation/ref-manual/terms.rst +++ b/documentation/ref-manual/terms.rst @@ -321,6 +321,23 @@ universal, the list includes them just in case: :term:`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 `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 @@ -381,6 +398,15 @@ 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 + `__ and is used by the OpenEmbedded Build System to + provide an :term:`SBOM` associated to each a software image. + + For details, see Wikipedia's `SPDX page `__. + :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