From patchwork Mon Feb 5 16:13:09 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Simone_Wei=C3=9F?= X-Patchwork-Id: 38857 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 2AC6CC48292 for ; Mon, 5 Feb 2024 16:13:28 +0000 (UTC) Received: from mout02.posteo.de (mout02.posteo.de [185.67.36.66]) by mx.groups.io with SMTP id smtpd.web10.66956.1707149602139889389 for ; Mon, 05 Feb 2024 08:13:22 -0800 Authentication-Results: mx.groups.io; dkim=fail reason="dkim: body hash did not verify" header.i=@posteo.com header.s=2017 header.b=io1BDhRR; spf=pass (domain: posteo.com, ip: 185.67.36.66, mailfrom: simone.p.weiss@posteo.com) Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id 5002B240103 for ; Mon, 5 Feb 2024 17:13:19 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.com; s=2017; t=1707149600; bh=yooOE4pu4KgGd9OKWd0SNUBPTpt13LOwvwXJvNHtTJU=; h=From:To:Cc:Subject:Date:Message-Id:MIME-Version:Content-Type: Content-Transfer-Encoding:From; b=io1BDhRR/K+7k6k2ljgIpblQ8iDBXz9sNkEaat93HeWHzCttZ1mjEmzrzSuVWKmjC 8Zta2GpErzA+Wmoo4j1JwIWwWILlZhinQyrbF44oynnQWepjo0l3ZPwJRrUG5FQfXE 4kS/GjrmuNhNjJ17drklgJInzUKSxhlAlLoUH81uePRJyRrpuyThXHrdZ0b426gn82 gigF6mJfVAPKXd9mzolhXeIE+7fQ8qLE0BWG1AUem64uUmjZ2OyJo8mq6rXpBMC0XF mfLMvsZZUnUaRBD6Gg92ShHUx72PcZX6ZQwvG7PQjVc9eyYBLJUq2sdoiuGDDeQxnn s64iCS+No/ARg== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4TTBHz3RrGz9rxG; Mon, 5 Feb 2024 17:13:18 +0100 (CET) From: simone.p.weiss@posteo.com To: docs@lists.yoctoproject.org Cc: =?utf-8?q?Simone_Wei=C3=9F?= Subject: [PATCH] dev-manual: Rephrase spdx creation Date: Mon, 5 Feb 2024 16:13:09 +0000 Message-Id: <20240205161309.2958827-1-simone.p.weiss@posteo.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 ; Mon, 05 Feb 2024 16:13:28 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4813 From: Simone Weiß Make the options more clewar by providing them in a list instead of plain prosa. Also add a ref for a presentation wrt spdx 3.0 in the Yocto project. Fixes [YOCTO 7476] Signed-off-by: Simone Weiß --- documentation/dev-manual/sbom.rst | 40 ++++++++++++++++++------------- 1 file changed, 24 insertions(+), 16 deletions(-) diff --git a/documentation/dev-manual/sbom.rst b/documentation/dev-manual/sbom.rst index f51d08f84..b72bad155 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 INHERIT += "create-spdx" -You then get :term:`SPDX` output in JSON format as an -``IMAGE-MACHINE.spdx.json`` file in ``tmp/deploy/images/MACHINE/`` inside the -:term:`Build Directory`. +Upon building an image, you will then get: -This is a toplevel file accompanied by an ``IMAGE-MACHINE.spdx.index.json`` -containing an index of JSON :term:`SPDX` files for individual recipes, together -with an ``IMAGE-MACHINE.spdx.tar.zst`` compressed archive containing all such -files. +- :term:`SPDX` output in JSON format as an ``IMAGE-MACHINE.spdx.json`` file in + ``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`. + +- This toplevel file is accompanied by an ``IMAGE-MACHINE.spdx.index.json`` + containing an index of JSON :term:`SPDX` files for individual recipes. + +- The compressed archive ``IMAGE-MACHINE.spdx.tar.zst`` contains the index + and the files for the single recipes. The :ref:`ref-classes-create-spdx` class offers options to include -more information in the output :term:`SPDX` data, such as making the generated -files more human readable (:term:`SPDX_PRETTY`), adding compressed archives of -the files in the generated target packages (:term:`SPDX_ARCHIVE_PACKAGED`), -adding a description of the source files used to generate host tools and target -packages (:term:`SPDX_INCLUDE_SOURCES`) and adding archives of these source -files themselves (:term:`SPDX_ARCHIVE_SOURCES`). +more information in the output :term:`SPDX` data: + +- Make the json files more human readable by setting (:term:`SPDX_PRETTY`). + +- Add compressed archives of the files in the generated target packages by + setting (:term:`SPDX_ARCHIVE_PACKAGED`). + +- Add a description of the source files used to generate host tools and target + packages (:term:`SPDX_INCLUDE_SOURCES`) + +- Add archives of these source files themselves (:term:`SPDX_ARCHIVE_SOURCES`). Though the toplevel :term:`SPDX` output is available in ``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`, ancillary @@ -65,11 +72,12 @@ generated files are available in ``tmp/deploy/spdx/MACHINE`` too, such as: See also the :term:`SPDX_CUSTOM_ANNOTATION_VARS` variable which allows to associate custom notes to a recipe. - See the `tools page `__ on the :term:`SPDX` project website for a list of tools to consume and transform the :term:`SPDX` data generated by the OpenEmbedded build system. -See also Joshua Watt's +See also Joshua Watt's presentations `Automated SBoM generation with OpenEmbedded and the Yocto Project `__ -presentation at FOSDEM 2023. +at FOSDEM 2023 and +`SPDX in the Yocto Project `__ +at FOSDEM 2024.