From patchwork Fri Apr 11 07:17:50 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Antonin Godard X-Patchwork-Id: 61169 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 6798AC36010 for ; Fri, 11 Apr 2025 08:01:09 +0000 (UTC) Received: from relay2-d.mail.gandi.net (relay2-d.mail.gandi.net [217.70.183.194]) by mx.groups.io with SMTP id smtpd.web11.20325.1744358466568992391 for ; Fri, 11 Apr 2025 01:01:06 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=YK4pWftf; spf=pass (domain: bootlin.com, ip: 217.70.183.194, mailfrom: antonin.godard@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id DE6E144188; Fri, 11 Apr 2025 08:01:04 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1744358465; 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=qbfdAJ/eqS/GpRuymSj1VeHg+AwUuaGkkZS9xcq1TeI=; b=YK4pWftfjgofI6TwrbnUCKnZZOeC4aJo4smIVxP47flZJ8CgBL2hiK+r7qgz+n76oq8MZX mbQFGrjSdvlnJuNOiNEbT6oF9Y+s2F1i4xibRdpY8uOAQ0PuqGD/LPzd3XuEkahwS/FC0i mSvCgaUEEdkwCt41rxbto172KzjgbUXFm+PJUNGwPotmwqXYL1mfFUrBir+/p0MaD0gCUB hEfGuni2Bh5WgxrExk34ctjAzhTdEJnfc1rQPcUV1K/KUcf2W5PBaPVP6e5zfir45RsGaH LLSL8XsXtbwmWSPV8E5DOemFRml7JQpktFLWBRAj4VNFf7+c66MA2vXCXCzRmw== From: Antonin Godard To: docs@lists.yoctoproject.org Cc: Thomas Petazzoni , Antonin Godard Subject: [scarthgap][PATCH 1/2] dev-manual/sbom.rst: fix wrong build outputs Date: Fri, 11 Apr 2025 09:17:50 +0200 Message-ID: <20250411080006.3071665-4-antonin.godard@bootlin.com> X-Mailer: git-send-email 2.47.0 In-Reply-To: <20250411080006.3071665-3-antonin.godard@bootlin.com> References: <20250411080006.3071665-3-antonin.godard@bootlin.com> MIME-Version: 1.0 X-GND-State: clean X-GND-Score: -100 X-GND-Cause: gggruggvucftvghtrhhoucdtuddrgeefvddrtddtgddvudduvdekucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuifetpfffkfdpucggtfgfnhhsuhgsshgtrhhisggvnecuuegrihhlohhuthemuceftddunecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenucfjughrpefhvfevufffkffojghfggfgsedtkeertdertddtnecuhfhrohhmpeetnhhtohhnihhnucfiohgurghrugcuoegrnhhtohhnihhnrdhgohgurghrugessghoohhtlhhinhdrtghomheqnecuggftrfgrthhtvghrnhepuefhgfetkedvhfegveegkedtfeevffegkeejfefhvdfhhfeuhfevffegvdfghfefnecukfhppedvrgdtudemtggsudegmeehheeimeejrgdttdemiegsleelmegvfhehgeemvddtrgefmeeifhegvdenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepihhnvghtpedvrgdtudemtggsudegmeehheeimeejrgdttdemiegsleelmegvfhehgeemvddtrgefmeeifhegvddphhgvlhhopehtrghhohhmrgdrhhhomhgvpdhmrghilhhfrhhomheprghnthhonhhinhdrghhouggrrhgusegsohhothhlihhnrdgtohhmpdhnsggprhgtphhtthhopeefpdhrtghpthhtohepughotghssehlihhsthhsrdihohgtthhophhrohhjvggtthdrohhrghdprhgtphhtthhopehthhhomhgrshdrphgvthgriiiiohhnihessghoohhtlhhinhdrtghomhdprhgtphhtthhopegrnhhtohhnihhnrdhgohgurghrugessghoo hhtlhhinhdrtghomh X-GND-Sasl: antonin.godard@bootlin.com 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, 11 Apr 2025 08:01:09 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/6730 This document was written with SPDX 3.0 in mind (create-spdx-3.0 class) on OE-Core's master, but Scarthgap only supports SPDX 2.2 (create-spdx-2.2). The create-spdx-2.2 class only generate a tar.zst output, so remove the other outputs listed here. Also, ancillary outputs are not only deployed in tmp/deploy/spdx/MACHINE but tmp/deploy/spdx in general. Signed-off-by: Antonin Godard --- documentation/dev-manual/sbom.rst | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/documentation/dev-manual/sbom.rst b/documentation/dev-manual/sbom.rst index b72bad1554..7c4b5804fb 100644 --- a/documentation/dev-manual/sbom.rst +++ b/documentation/dev-manual/sbom.rst @@ -30,16 +30,9 @@ To make this happen, you must inherit the INHERIT += "create-spdx" -Upon building an image, you will 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`. - -- 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. +Upon building an image, you will then get 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: @@ -56,7 +49,7 @@ more information in the output :term:`SPDX` data: Though the toplevel :term:`SPDX` output is available in ``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`, ancillary -generated files are available in ``tmp/deploy/spdx/MACHINE`` too, such as: +generated files are available in ``tmp/deploy/spdx`` too, such as: - The individual :term:`SPDX` JSON files in the ``IMAGE-MACHINE.spdx.tar.zst`` archive.