From patchwork Mon Dec 18 21:44:25 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36589 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 43353C46CCD for ; Mon, 18 Dec 2023 21:45:13 +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.3214.1702935904559216567 for ; Mon, 18 Dec 2023 13:45:04 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=f29cQtz8; spf=pass (domain: bootlin.com, ip: 217.70.183.194, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 9183240004; Mon, 18 Dec 2023 21:45:02 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935903; 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=r2kJvZfNC4ekHelccAa/2EfLxkGfDU8zMW4dwHorr4M=; b=f29cQtz8t5gGVvRb20lbgJABoT2kIEnaaQKwn8ROjrcqZ8TqYnVRvOipJXG2ThuOAIHJNk AKXDALCZNvhzQpRNnGp/84n7QG9koSBUrMq5BszNUkKvh30XTg57kguCg1dPCp+jG1BEFd JtNW2DiCkEmsDTFLr3G+3vtbrKPhnZQNyS9LMNJ9UMb6ZW+x9Xmb/MEcQQRGAaaBhYUsN5 mmao0oec1ddpo33RtohWHegj+6Iiu4Y0iJfqTzSqMG7EnAZ3Qi1ZYywp4qKUYtLhJttxdv PQtgIKmKWsgqp3m0qoePNFz5886OnxgP83wA8gEns4bKWc8jizDv7fsNfEqxbg== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Paul Barker Subject: [kirkstone][PATCH 01/18] ref-manual: Fix reference to MIRRORS/PREMIRRORS defaults Date: Mon, 18 Dec 2023 22:44:25 +0100 Message-Id: <20231218214442.147385-2-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4708 From: Michael Opdenacker From: Paul Barker After the following meta-yocto commits, MIRRORS & PREMIRRORS are no longer set in the poky distro config file: 67b79df4fbff ("poky.conf: remove redundant MIRRORS") 1b71a3b9418f ("poky: Drop PREMIRRORS entries for scms") Signed-off-by: Paul Barker Reviewed-by: Michael Opdenacker --- documentation/ref-manual/variables.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index e8028b328b..0a0b0ad37a 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -5028,9 +5028,8 @@ system and gives an overview of their function and contents. :term:`PREMIRRORS`, the upstream source, and then locations specified by :term:`MIRRORS` in that order. - Assuming your distribution (:term:`DISTRO`) is "poky", - the default value for :term:`MIRRORS` is defined in the - ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. + The default value for :term:`MIRRORS` is defined in the + ``meta/classes-global/mirrors.bbclass`` file in the core metadata layer. :term:`MLPREFIX` Specifies a prefix has been added to :term:`PN` to create a @@ -6248,9 +6247,8 @@ system and gives an overview of their function and contents. source, and then locations specified by :term:`MIRRORS` in that order. - Assuming your distribution (:term:`DISTRO`) is "poky", - the default value for :term:`PREMIRRORS` is defined in the - ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. + The default value for :term:`PREMIRRORS` is defined in the + ``meta/classes-global/mirrors.bbclass`` file in the core metadata layer. Typically, you could add a specific server for the build system to attempt before any others by adding something like the following to From patchwork Mon Dec 18 21:44:26 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36597 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 9E7BEC4706E for ; Mon, 18 Dec 2023 21:45:13 +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.3215.1702935906315090521 for ; Mon, 18 Dec 2023 13:45:06 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=YyqmgKii; spf=pass (domain: bootlin.com, ip: 217.70.183.196, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id B5900E0004; Mon, 18 Dec 2023 21:45:03 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935903; 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=BbU4bxh3vB2FtjtbQuPK+zCe/LmL5vd2YvDh29ATveQ=; b=YyqmgKiihb+EiHoCOpm9UqkZw9lB6IEHVohs716GF9swfybBsyUMKfV3/2DG2U11Zcxz6c skNKCsc/x4NesdUBRWDPd1Pkg3ATls0hWitAEe/WJkWn5idSyad35Fn5Jtna+5GnVdQJK+ HRyPxgQ0ednFkQbb8AtLOf8BF7hsIqK/IbUzWdrglljIoXR4FKhwwjYJG/FKntZ1SKWBzl 8JzeP1udsS955rNWiQQm0kl+iywCB4b3+ik86HZv4RsWz+5AxO/ClvILTvi1bu5m26x/65 vCLpAQF5SYiAj9eUVwOp1nXYdZQv0j+BBVlbI+mV6UqNR1gmPSR/OFnIedyEPA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Steve Landherr Subject: [kirkstone][PATCH 02/18] manuals: fix URL Date: Mon, 18 Dec 2023 22:44:26 +0100 Message-Id: <20231218214442.147385-3-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4710 From: Michael Opdenacker [YOCTO #15279] Signed-off-by: Michael Opdenacker Reported-by: Steve Landherr --- documentation/what-i-wish-id-known.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/documentation/what-i-wish-id-known.rst b/documentation/what-i-wish-id-known.rst index fa5d55ff41..4843f02276 100644 --- a/documentation/what-i-wish-id-known.rst +++ b/documentation/what-i-wish-id-known.rst @@ -29,8 +29,9 @@ contact us with other suggestions. #. **Get to know the layer index:** All layers can be found in the :oe_layerindex:`layer index <>`. Layers which have applied for Yocto Project Compatible status (structure continuity - assurance and testing) can be found in the :yocto_home:`Yocto Project Compatible index - `. Generally check the Compatible layer index first, + assurance and testing) can be found in the :yocto_home:`Yocto Project + Compatible Layers ` page. + Generally check the Compatible layer index first, and if you don't find the necessary layer check the general layer index. The layer index is an original artifact from the Open Embedded Project. As such, that index doesn't have the curating and testing that the Yocto Project From patchwork Mon Dec 18 21:44:27 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36594 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 80979C46CD8 for ; Mon, 18 Dec 2023 21:45:13 +0000 (UTC) Received: from relay8-d.mail.gandi.net (relay8-d.mail.gandi.net [217.70.183.201]) by mx.groups.io with SMTP id smtpd.web10.3159.1702935906131722105 for ; Mon, 18 Dec 2023 13:45:06 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=k1snUuPl; spf=pass (domain: bootlin.com, ip: 217.70.183.201, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 5FC801BF203; Mon, 18 Dec 2023 21:45:04 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935904; 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=i7cIFqgIdJiNcf5y7FAVHqqd+HIY0NaC3TsvTY8dMKQ=; b=k1snUuPl6dtYJYYtAWBrLOWbBa79erqAdY6y9/iElclXdustQSNPxJLJcm9DTMzegJukQL 87Yorj1djk9Wad00+ZVZrn6x5/3uAyVEK1jusYavIYkLldBDNdiTczGMAtKr+JnefphcA6 QdelQ6leYSnZOy9szEabcOEHOxAA8QS1OIc49tGYyTKHfkilsfXoSKiG4rTu5Rama15CQh h5hrlN0mwWS6NfPYXy5FVPiMux4Oth8uRapLTd72EklV+eN9B+Vc1ydhWlYv2oapxoQijT Ytb/quWX3k8O4VB0Gl38i3MgSmVOQtjW2HeXE9Oc+UwYSt/vjuqvywn+2/Tfew== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [kirkstone][PATCH 03/18] ref-manual: releases.svg: update nanbield release status Date: Mon, 18 Dec 2023 22:44:27 +0100 Message-Id: <20231218214442.147385-4-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4709 From: Michael Opdenacker - nanbield is now released - update the start and end dates Signed-off-by: Michael Opdenacker --- documentation/ref-manual/svg/releases.svg | 32 +++++++++++------------ 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/documentation/ref-manual/svg/releases.svg b/documentation/ref-manual/svg/releases.svg index 5333498d1f..198d4632b1 100644 --- a/documentation/ref-manual/svg/releases.svg +++ b/documentation/ref-manual/svg/releases.svg @@ -404,15 +404,15 @@ guidetolerance="10" inkscape:pageopacity="0" inkscape:pageshadow="2" - inkscape:window-width="1846" - inkscape:window-height="1016" + inkscape:window-width="1920" + inkscape:window-height="1043" id="namedview4" showgrid="true" - inkscape:zoom="0.51166405" - inkscape:cx="-43.974166" - inkscape:cy="311.72798" - inkscape:window-x="1994" - inkscape:window-y="27" + inkscape:zoom="1.4472045" + inkscape:cx="736.24703" + inkscape:cy="312.32629" + inkscape:window-x="1728" + inkscape:window-y="0" inkscape:window-maximized="1" inkscape:current-layer="g10" inkscape:document-rotation="0" @@ -669,28 +669,28 @@ style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" id="tspan10317-2-9-1-4">4.2 + id="g1379"> Nanbield4.3 From patchwork Mon Dec 18 21:44:28 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36599 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 A9CA7C47070 for ; Mon, 18 Dec 2023 21:45:13 +0000 (UTC) Received: from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net [217.70.183.195]) by mx.groups.io with SMTP id smtpd.web11.3216.1702935906799924299 for ; Mon, 18 Dec 2023 13:45:07 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=VHXKmEa/; spf=pass (domain: bootlin.com, ip: 217.70.183.195, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id ECB7A60003; Mon, 18 Dec 2023 21:45:04 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935905; 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=hxXiZm/nW9gQ1xhubU7V1+Rl0uJu88zEbrWAIs0CH2M=; b=VHXKmEa/jG+ysxwtlF8Bl7sB1edoB228kI/lMSH759dWmTAws1eoYPIfdUgAtSdKO1j8qC yUnbAyWs+LdxqRDxkh4uWmrwXXM4vYUUAqUvkG7j+Puuy7Tjv8z4cT/CC941ZMfpS/YtDR HysUJIKfPz7ebNwEZY9woZGoseGjwveToJnd69JpBUfF7ojDgu0MAlLOOooYJEisqn6UaI 1MAcsYizMxYeUlo9JGZaXWy5BKMiLQNcMYDdM8auEVr4EQ52e1S+50J1I7NJythaUJWY10 IyJV/eSs9ZPWWAbSFyI88GUwgy46qBKC//AJNNOVg8xUa6f3FD1vHXsqOmdGvA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Megan Knight Subject: [kirkstone][PATCH 04/18] dev-manual: layers: update link to YP Compatible form Date: Mon, 18 Dec 2023 22:44:28 +0100 Message-Id: <20231218214442.147385-5-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4711 From: Michael Opdenacker Signed-off-by: Michael Opdenacker Reported-by: Megan Knight --- documentation/dev-manual/layers.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst index 16f62ee696..2da5d9f93e 100644 --- a/documentation/dev-manual/layers.rst +++ b/documentation/dev-manual/layers.rst @@ -313,7 +313,7 @@ Logo for your layer and application. The process consists of two parts: successful compatibility registration. #. Completion of an application acceptance form, which you can find at - :yocto_home:`/webform/yocto-project-compatible-registration`. + :yocto_home:`/compatible-registration/`. To be granted permission to use the logo, you need to satisfy the following: @@ -337,7 +337,7 @@ application, you can use the Yocto Project Compatibility Logo with your layer and the application that uses your layer. To access the form, use this link: -:yocto_home:`/webform/yocto-project-compatible-registration`. +:yocto_home:`/compatible-registration`. Follow the instructions on the form to complete your application. The application consists of the following sections: From patchwork Mon Dec 18 21:44:29 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36592 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 4FC6EC46CA2 for ; Mon, 18 Dec 2023 21:45:13 +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.web10.3161.1702935907134075747 for ; Mon, 18 Dec 2023 13:45:07 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=QUYKg3Ah; spf=pass (domain: bootlin.com, ip: 217.70.183.194, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 6075940005; Mon, 18 Dec 2023 21:45:05 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935905; 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=3w0FyFnQZJrcecXE3JbqX+SoH5M7BxK1zNxcEy/fOQA=; b=QUYKg3AhoJmNE5FNKMZDjV5U81eXeqschC7voS/8wOkMaiPeXbLAjLCR8piy6IApC8yB8F sWezsjmJDCxmAS29aQjHSRXBXyrZy4F5Gu/jXKk34o3k6Xyx6JYGXCT5W4/Gbj0dB3/2Zu RSnCaPGf5J4eAAyXBWhvPyhQCsNA3V+WSix62pDxWLhABhPkhWW+sIbEcdvUq6pFbbN9d5 /CXrcMIXyRD13+hffASX1LX8sZ8HkmhsaRY4OvwgPJhUhV6cBIjtqB0hlDqAEMuFNtISzb fMylUqdaCfARejdbtQTKjknK8MVUQFbq3zgh0ZCbm70L//2ksp1DP+ElctK+TQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Justin Bronder Subject: [kirkstone][PATCH 05/18] contributor-guide: add License-Update tag Date: Mon, 18 Dec 2023 22:44:29 +0100 Message-Id: <20231218214442.147385-6-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4712 From: Michael Opdenacker From: Justin Bronder Porting from the old wiki https://www.openembedded.org/index.php?title=Commit_Patch_Message_Guidelines&oldid=10935#Describing_license_changes Signed-off-by: Justin Bronder Reviewed-by: Michael Opdenacker --- .../contributor-guide/recipe-style-guide.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/documentation/contributor-guide/recipe-style-guide.rst b/documentation/contributor-guide/recipe-style-guide.rst index a005aa3247..08d8fb4259 100644 --- a/documentation/contributor-guide/recipe-style-guide.rst +++ b/documentation/contributor-guide/recipe-style-guide.rst @@ -250,6 +250,18 @@ Recipes need to define both the :term:`LICENSE` and correct string that you can substitute into the recipe file for a subsequent build. +License Updates +~~~~~~~~~~~~~~~ + +When you change the :term:`LICENSE` or :term:`LIC_FILES_CHKSUM` in the recipe +you need to briefly explain the reason for the change via a ``License-Update:`` +tag. Often it's quite trivial, such as:: + + License-Update: copyright years refreshed + +Less often, the actual licensing terms themselves will have changed. If so, do +try to link to upstream making/justifying that decision. + Tips and Guidelines for Writing Recipes --------------------------------------- From patchwork Mon Dec 18 21:44:30 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36591 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 73B84C46CD4 for ; Mon, 18 Dec 2023 21:45:13 +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.3218.1702935907623961522 for ; Mon, 18 Dec 2023 13:45:07 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=kOIiLczr; spf=pass (domain: bootlin.com, ip: 217.70.183.194, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 2933840003; Mon, 18 Dec 2023 21:45:06 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935906; 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=zMcNYFpPs37N/KhsGu+gUlaPVMI5UmcnxIeM9FYqypM=; b=kOIiLczr4Zms/Sz7cY3nVdd1GTs/NHVV9KA5odiBn2GtA+BgVa0BOU9Y+iwt0/c5VPqAyg 4BGw4aIJ49I0GOjzjp8oO2wFaQ6czziTnb80WVpUpBVTTbCbsJQeZ91UMK4jesRODRlICv xknwH5ztflo9XJb0EDLp750JCqMHrVRqxU+l2cZdv1TrQjnfXcTgDEiqO97Jum6vpTdL2r 5k205md2c7sLrAW7ofMFnHmtYYJq7oyChGtkrio5Hpmx3p6L+rUAkg4selb0e3c7ROufyc hqLrAdc7vvk9T35Nyi8QZuWX/5/WecM2WmN/U/RXejmgWzagS9XzkP0R+xsaFA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [kirkstone][PATCH 06/18] contributor-guide: fix command option Date: Mon, 18 Dec 2023 22:44:30 +0100 Message-Id: <20231218214442.147385-7-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4713 From: Michael Opdenacker "--subject-prefix" applies to "git format-patch", not "git send-email" Signed-off-by: Michael Opdenacker --- documentation/contributor-guide/submit-changes.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/contributor-guide/submit-changes.rst b/documentation/contributor-guide/submit-changes.rst index cda2d12d25..289ec1383c 100644 --- a/documentation/contributor-guide/submit-changes.rst +++ b/documentation/contributor-guide/submit-changes.rst @@ -420,7 +420,7 @@ or any layer other than :oe_git:`openembedded-core `, please add the appropriate prefix so that it is clear which layer the patch is intended to be applied to:: - git send-email --subject-prefix="meta-oe][PATCH" ... + git format-patch --subject-prefix="meta-oe][PATCH" ... .. note:: From patchwork Mon Dec 18 21:44:31 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36596 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 8271AC4706C for ; Mon, 18 Dec 2023 21:45:13 +0000 (UTC) Received: from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net [217.70.183.195]) by mx.groups.io with SMTP id smtpd.web11.3220.1702935908119921849 for ; Mon, 18 Dec 2023 13:45:08 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=kIKYflTz; spf=pass (domain: bootlin.com, ip: 217.70.183.195, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 970AC60005; Mon, 18 Dec 2023 21:45:06 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935906; 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=YlveiCOQ2Muc/74FjhpRn2z3nDG1qKunqzeV54yfKAY=; b=kIKYflTzO+o6wQ+zntwIOlLVJal/meVvXuOv9oIMbh9bu8pNk0DQM53m3MUvmyUz5YVOJg eq4ZoAm5+0fFmg8yQoLf/DCjwxd/0EhbufgCyPXOG6SqQyko2DQmOKChns/0SVf5tDljrs ecvwQdjuBBdVRpHKjXO6HtM/tbTDQvetiWl+SGxXG+nBOKKwwZXc2eBM3bTQJa/v7IbH/G 6mw/I+bQ3gTBOh6wAGp7qjFPWZvc6RJm3a/5TqHsRyic2u47o8koa/rDTp31x+VRSRKJEr FvT9lDCG6QXUfVIIx/OoVU5Ok9lE4UuNkxHzlcC5Ridr0MTKhNbNBZZ5bQHCHA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Aatir Manzur Subject: [kirkstone][PATCH 07/18] docs: add CONVERSION_CMD definition Date: Mon, 18 Dec 2023 22:44:31 +0100 Message-Id: <20231218214442.147385-8-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4714 From: Michael Opdenacker From: Aatir Manzur Signed-off-by: Aatir Manzur Reviewed-by: Michael Opdenacker --- documentation/migration-guides/migration-2.2.rst | 2 +- documentation/migration-guides/migration-2.4.rst | 2 +- documentation/migration-guides/migration-3.4.rst | 2 +- documentation/ref-manual/variables.rst | 13 +++++++++++++ 4 files changed, 16 insertions(+), 3 deletions(-) diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst index 10aa2d0684..3803dea832 100644 --- a/documentation/migration-guides/migration-2.2.rst +++ b/documentation/migration-guides/migration-2.2.rst @@ -442,7 +442,7 @@ The following miscellaneous changes have occurred: - :ref:`ref-classes-image`: Renamed COMPRESS(ION) to CONVERSION. This change means that ``COMPRESSIONTYPES``, ``COMPRESS_DEPENDS`` and ``COMPRESS_CMD`` are deprecated in favor of ``CONVERSIONTYPES``, - ``CONVERSION_DEPENDS`` and ``CONVERSION_CMD``. The ``COMPRESS*`` + ``CONVERSION_DEPENDS`` and :term:`CONVERSION_CMD`. The ``COMPRESS*`` variable names will still work in the 2.2 release but metadata that does not need to be backwards-compatible should be changed to use the new names as the ``COMPRESS*`` ones will be removed in a future diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst index ef5f32e6ef..964ed92937 100644 --- a/documentation/migration-guides/migration-2.4.rst +++ b/documentation/migration-guides/migration-2.4.rst @@ -301,7 +301,7 @@ The following are additional changes: likely be removed in the next Yocto Project release. - The ``vmdk``, ``vdi``, and ``qcow2`` image file types are now used in - conjunction with the "wic" image type through ``CONVERSION_CMD``. + conjunction with the "wic" image type through :term:`CONVERSION_CMD`. Consequently, the equivalent image types are now ``wic.vmdk``, ``wic.vdi``, and ``wic.qcow2``, respectively. diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index d57c955eb4..5fc2ef78fe 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst @@ -252,7 +252,7 @@ Miscellaneous - The previously deprecated ``COMPRESS_CMD`` and ``CVE_CHECK_CVE_WHITELIST`` variables have been removed. Use - ``CONVERSION_CMD`` and ``CVE_CHECK_WHITELIST`` (replaced by + :term:`CONVERSION_CMD` and ``CVE_CHECK_WHITELIST`` (replaced by :term:`CVE_CHECK_IGNORE` in version 3.5) respectively instead. diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 0a0b0ad37a..fe0b993bd8 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -1342,6 +1342,19 @@ system and gives an overview of their function and contents. the recipe will be skipped, and if the build system attempts to build the recipe then an error will be triggered. + :term:`CONVERSION_CMD` + This variable is used for storing image conversion commands. + Image conversion can convert an image into different objects like: + + - Compressed version of the image + + - Checksums for the image + + An example of :term:`CONVERSION_CMD` from :ref:`image-types + ` class is:: + + CONVERSION_CMD:lzo = "lzop -9 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}" + :term:`COPY_LIC_DIRS` If set to "1" along with the :term:`COPY_LIC_MANIFEST` variable, the From patchwork Mon Dec 18 21:44:32 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36593 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 668E1C46CD7 for ; Mon, 18 Dec 2023 21:45:13 +0000 (UTC) Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [217.70.183.197]) by mx.groups.io with SMTP id smtpd.web10.3164.1702935909832891775 for ; Mon, 18 Dec 2023 13:45:10 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=B72E81E/; spf=pass (domain: bootlin.com, ip: 217.70.183.197, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 5EFDA1C0004; Mon, 18 Dec 2023 21:45:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935907; 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=9+Vk0zMq6+bkoD6OVhLpulkEvQ245vV87EPiO2zpAGU=; b=B72E81E/kzysiJEKDROHwRYUKrvjvw8U7v6l3lEc9+011Hj3BmN/Hn3GdKiX4jGtG/9Wkr sxJ2nGVMCfPzqmlkwElFITYM+S7Kkivsrr8+J6HjUgNwpxzWNquQ9dzwpLAW34z/wO2MoA a1xyhZYXL3Z71FueeGTxehjE9D6BLanckQ5uGqv1exfb42MVRGzNigFFk8ljNAUugFC0hb 6zqn2xf9mMFBndib/he46HtrorYEI4e0n4bukBTjQamk9hjxu4NYp2DPBl9A2vqhNBP5U9 WjarIUHcd/A6WpnvCZ1O+6zBFxSbYPPEe8l/MN8xx2ICiFSJllmKjFDgSuwGzw== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [kirkstone][PATCH 08/18] migration-guides: release 3.5 is actually 4.0 Date: Mon, 18 Dec 2023 22:44:32 +0100 Message-Id: <20231218214442.147385-9-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4715 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/migration-guides/migration-2.2.rst | 2 +- documentation/migration-guides/migration-3.0.rst | 2 +- documentation/migration-guides/migration-3.4.rst | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst index 3803dea832..40e3b5cb2b 100644 --- a/documentation/migration-guides/migration-2.2.rst +++ b/documentation/migration-guides/migration-2.2.rst @@ -27,7 +27,7 @@ Staging Directories in Sysroot Has Been Simplified The way directories are staged in sysroot has been simplified and introduces the new :term:`SYSROOT_DIRS`, :term:`SYSROOT_DIRS_NATIVE`, and ``SYSROOT_DIRS_BLACKLIST`` -(replaced by :term:`SYSROOT_DIRS_IGNORE` in version 3.5). See the +(replaced by :term:`SYSROOT_DIRS_IGNORE` in version 4.0). See the :oe_lists:`v2 patch series on the OE-Core Mailing List ` for additional information. diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst index 50d6758e71..7fa6d39b84 100644 --- a/documentation/migration-guides/migration-3.0.rst +++ b/documentation/migration-guides/migration-3.0.rst @@ -148,7 +148,7 @@ XML feeds that ``cve-check-tool`` was using, supports CVSSv3 scoring, and makes other improvements. Additionally, the ``CVE_CHECK_CVE_WHITELIST`` variable has been replaced -by ``CVE_CHECK_WHITELIST`` (replaced by :term:`CVE_CHECK_IGNORE` in version 3.5). +by ``CVE_CHECK_WHITELIST`` (replaced by :term:`CVE_CHECK_IGNORE` in version 4.0). .. _migration-3.0-bitbake-changes: diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index 5fc2ef78fe..b184dde41e 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst @@ -253,7 +253,7 @@ Miscellaneous - The previously deprecated ``COMPRESS_CMD`` and ``CVE_CHECK_CVE_WHITELIST`` variables have been removed. Use :term:`CONVERSION_CMD` and ``CVE_CHECK_WHITELIST`` (replaced by - :term:`CVE_CHECK_IGNORE` in version 3.5) respectively + :term:`CVE_CHECK_IGNORE` in version 4.0) respectively instead. - The obsolete ``oe_machinstall`` function previously provided in the From patchwork Mon Dec 18 21:44:33 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36598 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 9F464C47072 for ; Mon, 18 Dec 2023 21:45:13 +0000 (UTC) Received: from relay8-d.mail.gandi.net (relay8-d.mail.gandi.net [217.70.183.201]) by mx.groups.io with SMTP id smtpd.web11.3221.1702935910206617134 for ; Mon, 18 Dec 2023 13:45:10 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=L1gkorp1; spf=pass (domain: bootlin.com, ip: 217.70.183.201, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id D7D2F1BF203; Mon, 18 Dec 2023 21:45:07 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935908; 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=bCNnB3WODlxYddQDPMi7SxbSrw2DakTLZrNenco51oU=; b=L1gkorp1XyvXXJK9RkiDNgME+jXneuqifLLr15l9hmquG9tt4kAbTB0CN88wGIUHyr5QyC Idq2g04pM275/0vQNfiXeQ+G4j0Ep57/+6BURaiYdZBO1kpDdVXkrbMi/QCkJZChTfK8Uv tKZTT5uGOdGbVZX4MwF/CLE0qR6o6yeM4dWWO0fVQhXKnAjDBhyGuGN5osCd/Rca4nDK/l 1FQianiQ1zSExEOJPt0q7DK2GhLsKkd748MZWvFe4TWRQBFhnhfW23JdYq+/7EWCBJb7Tv UMnT3t/EuFYG+oX+hxEFd94RRuj1g2xNMimf+v1nIy75IxRBuSS2iFxMbVUc4w== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Peter Kjellerstedt Subject: [kirkstone][PATCH 09/18] dev-manual: Discourage the use of SRC_URI[md5sum] Date: Mon, 18 Dec 2023 22:44:33 +0100 Message-Id: <20231218214442.147385-10-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4716 From: Michael Opdenacker From: Peter Kjellerstedt SRC_URI[md5sum] has been deprecated for a long time. Discourage its use by removing it from examples and note that it should be replaced by SRC_URI[sha256sum] when updating recipes. Also mention that bitbake supports other checksums, though they are not commonly used. Signed-off-by: Peter Kjellerstedt Reviewed-by: Michael Opdenacker --- documentation/dev-manual/debugging.rst | 2 +- documentation/dev-manual/new-recipe.rst | 27 +++++++++++++++---------- 2 files changed, 17 insertions(+), 12 deletions(-) diff --git a/documentation/dev-manual/debugging.rst b/documentation/dev-manual/debugging.rst index fea2cb30a1..bd1e716b0b 100644 --- a/documentation/dev-manual/debugging.rst +++ b/documentation/dev-manual/debugging.rst @@ -327,7 +327,7 @@ BitBake has determined by doing the following: the task. This list also includes indirect dependencies from variables depending on other variables, recursively:: - Task dependencies: ['PV', 'SRCREV', 'SRC_URI', 'SRC_URI[md5sum]', 'SRC_URI[sha256sum]', 'base_do_fetch'] + Task dependencies: ['PV', 'SRCREV', 'SRC_URI', 'SRC_URI[sha256sum]', 'base_do_fetch'] .. note:: diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst index a031c59875..ed87f9b2d0 100644 --- a/documentation/dev-manual/new-recipe.rst +++ b/documentation/dev-manual/new-recipe.rst @@ -303,28 +303,33 @@ If your :term:`SRC_URI` statement includes URLs pointing to individual files fetched from a remote server other than a version control system, BitBake attempts to verify the files against checksums defined in your recipe to ensure they have not been tampered with or otherwise modified -since the recipe was written. Two checksums are used: -``SRC_URI[md5sum]`` and ``SRC_URI[sha256sum]``. +since the recipe was written. Multiple checksums are supported: +``SRC_URI[md5sum]``, ``SRC_URI[sha1sum]``, ``SRC_URI[sha256sum]``. +``SRC_URI[sha384sum]`` and ``SRC_URI[sha512sum]``, but only +``SRC_URI[sha256sum]`` is commonly used. + +.. note:: + + ``SRC_URI[md5sum]`` used to also be commonly used, but it is deprecated + and should be replaced by ``SRC_URI[sha256sum]`` when updating existing + recipes. If your :term:`SRC_URI` variable points to more than a single URL (excluding -SCM URLs), you need to provide the ``md5`` and ``sha256`` checksums for -each URL. For these cases, you provide a name for each URL as part of -the :term:`SRC_URI` and then reference that name in the subsequent checksum -statements. Here is an example combining lines from the files -``git.inc`` and ``git_2.24.1.bb``:: +SCM URLs), you need to provide the ``sha256`` checksum for each URL. For these +cases, you provide a name for each URL as part of the :term:`SRC_URI` and then +reference that name in the subsequent checksum statements. Here is an example +combining lines from the files ``git.inc`` and ``git_2.24.1.bb``:: SRC_URI = "${KERNELORG_MIRROR}/software/scm/git/git-${PV}.tar.gz;name=tarball \ ${KERNELORG_MIRROR}/software/scm/git/git-manpages-${PV}.tar.gz;name=manpages" - SRC_URI[tarball.md5sum] = "166bde96adbbc11c8843d4f8f4f9811b" SRC_URI[tarball.sha256sum] = "ad5334956301c86841eb1e5b1bb20884a6bad89a10a6762c958220c7cf64da02" - SRC_URI[manpages.md5sum] = "31c2272a8979022497ba3d4202df145d" SRC_URI[manpages.sha256sum] = "9a7ae3a093bea39770eb96ca3e5b40bff7af0b9f6123f089d7821d0e5b8e1230" -Proper values for ``md5`` and ``sha256`` checksums might be available +The proper value for the ``sha256`` checksum might be available together with other signatures on the download page for the upstream source (e.g. ``md5``, ``sha1``, ``sha256``, ``GPG``, and so forth). Because the -OpenEmbedded build system only deals with ``sha256sum`` and ``md5sum``, +OpenEmbedded build system typically only deals with ``sha256sum``, you should verify all the signatures you find by hand. If no :term:`SRC_URI` checksums are specified when you attempt to build the From patchwork Mon Dec 18 21:44:34 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36601 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 91AFFC4706D for ; Mon, 18 Dec 2023 21:45:13 +0000 (UTC) Received: from relay6-d.mail.gandi.net (relay6-d.mail.gandi.net [217.70.183.198]) by mx.groups.io with SMTP id smtpd.web11.3224.1702935911929080011 for ; Mon, 18 Dec 2023 13:45:12 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=m8W9PC+2; spf=pass (domain: bootlin.com, ip: 217.70.183.198, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 76625C0004; Mon, 18 Dec 2023 21:45:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935909; 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=dsqWviaWBkH1ApSUWSGNKYFplsZO0ZcMEhLvCwbCcfE=; b=m8W9PC+2gYQZHS8RcVzZrQF8TLAMLxLgdrkpKhQWmjr/qmiRBZ1eTdFWmpHWL2UhsrzBiK orklx5iCQQAWEMagJbPcc0ohw5QnBTyB0JY3F5/A32qKMZyiCv0A+5K60A43ANbvyW9Tht /ZMHLOfJ4rs0hJT2m30vhk1VXmcxyCau41bSNH89kFtZiv8Kup9DKtxiP5kY55Ox53HM76 qge9imxAnPpILzMTKn1ZsRb61xHia6jw61RB7yTxJ1PG+IcEpL0k17eoHlxlFfw72ulgfr P0agcjWWefz47U/Sq6dG0y0Vp0He12bIz8dDn9RhmQOP37nfVyYLHVz1yEIv6w== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [kirkstone][PATCH 10/18] test-manual: text and formatting fixes Date: Mon, 18 Dec 2023 22:44:34 +0100 Message-Id: <20231218214442.147385-11-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4718 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/test-manual/intro.rst | 51 ++++++++++--------- documentation/test-manual/test-process.rst | 12 ++--- .../test-manual/understand-autobuilder.rst | 35 +++++++------ 3 files changed, 52 insertions(+), 46 deletions(-) diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 8cfd6be87d..3a3fc2270e 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst @@ -14,7 +14,7 @@ release works as intended. All the project's testing infrastructure and processes are publicly visible and available so that the community can see what testing is being performed, how it's being done and the current status of the tests and the project at any given time. It is intended -that Other organizations can leverage off the process and testing +that other organizations can leverage off the process and testing environment used by the Yocto Project to create their own automated, production test environment, building upon the foundations from the project core. @@ -93,8 +93,8 @@ the following types of tests: - *Build Testing:* Tests whether specific configurations build by varying :term:`MACHINE`, :term:`DISTRO`, other configuration - options, and the specific target images being built (or world). Used - to trigger builds of all the different test configurations on the + options, and the specific target images being built (or ``world``). This is + used to trigger builds of all the different test configurations on the Autobuilder. Builds usually cover many different targets for different architectures, machines, and distributions, as well as different configurations, such as different init systems. The @@ -121,7 +121,8 @@ the following types of tests: $ bitbake image -c testsdkext - The tests utilize the :ref:`testsdkext ` class and the ``do_testsdkext`` task. + The tests use the :ref:`ref-classes-testsdk` class and the + ``do_testsdkext`` task. - *Feature Testing:* Various scenario-based tests are run through the :ref:`OpenEmbedded Self test (oe-selftest) `. We test oe-selftest on each of the main distributions @@ -131,8 +132,8 @@ the following types of tests: $ bitbake image -c testimage - The tests utilize the :ref:`testimage* ` - classes and the :ref:`ref-tasks-testimage` task. + The tests use the :ref:`ref-classes-testimage` + class and the :ref:`ref-tasks-testimage` task. - *Layer Testing:* The Autobuilder has the possibility to test whether specific layers work with the test of the system. The layers tested @@ -151,7 +152,7 @@ the following types of tests: $ bitbake image -c testsdk - The tests utilize the :ref:`testsdk ` class and + The tests use the :ref:`ref-classes-testsdk` class and the ``do_testsdk`` task. - *Unit Testing:* Unit tests on various components of the system run @@ -179,7 +180,7 @@ Tests map into the codebase as follows: $ bitbake-selftest To skip tests that access the Internet, use the ``BB_SKIP_NETTESTS`` - variable when running "bitbake-selftest" as follows:: + variable when running ``bitbake-selftest`` as follows:: $ BB_SKIP_NETTESTS=yes bitbake-selftest @@ -209,7 +210,7 @@ Tests map into the codebase as follows: - These tests use OE to test the workflows, which include testing specific features, behaviors of tasks, and API unit tests. - - The tests can take advantage of parallelism through the "-j" + - The tests can take advantage of parallelism through the ``-j`` option, which can specify a number of threads to spread the tests across. Note that all tests from a given class of tests will run in the same thread. To parallelize large numbers of tests you can @@ -225,18 +226,18 @@ Tests map into the codebase as follows: $ oe-selftest -a - To run a specific test, use the following command form where - testname is the name of the specific test:: + ``testname`` is the name of the specific test:: $ oe-selftest -r - For example, the following command would run the tinfoil - getVar API test:: + For example, the following command would run the ``tinfoil`` + ``getVar`` API test:: $ oe-selftest -r tinfoil.TinfoilTests.test_getvar It is also possible to run a set of tests. For example the following command will run all of the - tinfoil tests:: + ``tinfoil`` tests:: $ oe-selftest -r tinfoil @@ -385,14 +386,14 @@ so tests within a given test class should always run in the same build, while tests in different classes or modules may be split into different builds. There is no data store available for these tests since the tests launch the ``bitbake`` command and exist outside of its context. As a -result, common bitbake library functions (bb.\*) are also unavailable. +result, common BitBake library functions (``bb.\*``) are also unavailable. ``testimage`` ------------- These tests are run once an image is up and running, either on target hardware or under QEMU. As a result, they are assumed to be running in a -target image environment, as opposed to a host build environment. A +target image environment, as opposed to in a host build environment. A simple example from ``meta/lib/oeqa/runtime/cases/python.py`` contains the following:: @@ -407,19 +408,19 @@ the following:: In this example, the ``OERuntimeTestCase`` class wraps ``unittest.TestCase``. Within the test, ``self.target`` represents the -target system, where commands can be run on it using the ``run()`` +target system, where commands can be run using the ``run()`` method. -To ensure certain test or package dependencies are met, you can use the +To ensure certain tests or package dependencies are met, you can use the ``OETestDepends`` and ``OEHasPackage`` decorators. For example, the test -in this example would only make sense if python3-core is installed in +in this example would only make sense if ``python3-core`` is installed in the image. ``testsdk_ext`` --------------- These tests are run against built extensible SDKs (eSDKs). The tests can -assume that the eSDK environment has already been setup. An example from +assume that the eSDK environment has already been set up. An example from ``meta/lib/oeqa/sdk/cases/devtool.py`` contains the following:: class DevtoolTest(OESDKExtTestCase): @@ -466,9 +467,9 @@ following:: output = self._run(cmd) self.assertEqual(output, "Hello, world\n") -In this example, if nativesdk-python3-core has been installed into the SDK, the code runs -the python3 interpreter with a basic command to check it is working -correctly. The test would only run if python3 is installed in the SDK. +In this example, if ``nativesdk-python3-core`` has been installed into the SDK, +the code runs the ``python3`` interpreter with a basic command to check it is +working correctly. The test would only run if Python3 is installed in the SDK. ``oe-build-perf-test`` ---------------------- @@ -512,9 +513,9 @@ an isolated directory. **Running "cleansstate" is not permitted.** -This can delete files from SSTATE_DIR which would potentially break -other builds running in parallel. If this is required, SSTATE_DIR must -be set to an isolated directory. Alternatively, you can use the "-f" +This can delete files from :term:`SSTATE_DIR` which would potentially break +other builds running in parallel. If this is required, :term:`SSTATE_DIR` must +be set to an isolated directory. Alternatively, you can use the ``-f`` option with the ``bitbake`` command to "taint" tasks by changing the sstate checksums to ensure sstate cache items will not be reused. diff --git a/documentation/test-manual/test-process.rst b/documentation/test-manual/test-process.rst index 4c3b32bfea..0c560efe39 100644 --- a/documentation/test-manual/test-process.rst +++ b/documentation/test-manual/test-process.rst @@ -42,16 +42,16 @@ our sstate up to date. On the weekend, there is a master-next build instead to ensure the test results are updated for the less frequently run targets. -Performance builds (buildperf-\* targets in the console) are triggered +Performance builds (``buildperf-\*`` targets in the console) are triggered separately every six hours and automatically push their results to the buildstats repository at: :yocto_git:`/yocto-buildstats/`. -The 'quick' targets have been selected to be the ones which catch the -most failures or give the most valuable data. We run 'fast' ptests in +The "quick" targets have been selected to be the ones which catch the +most failures or give the most valuable data. We run "fast" ptests in this case for example but not the ones which take a long time. The quick -target doesn't include \*-lsb builds for all architectures, some world -builds and doesn't trigger performance tests or ltp testing. The full +target doesn't include ``\*-lsb`` builds for all architectures, some ``world`` +builds and doesn't trigger performance tests or ``ltp`` testing. The full build includes all these things and is slower but more comprehensive. Release Builds @@ -67,7 +67,7 @@ that in :ref:`test-manual/test-process:day to day development`, in that the a-full target of the Autobuilder is used but in addition the form is configured to generate and publish artifacts and the milestone number, version, release candidate number and other information is entered. The -box to "generate an email to QA"is also checked. +box to "generate an email to QA" is also checked. When the build completes, an email is sent out using the send-qa-email script in the ``yocto-autobuilder-helper`` repository to the list of diff --git a/documentation/test-manual/understand-autobuilder.rst b/documentation/test-manual/understand-autobuilder.rst index b6809ce7bd..ef03955954 100644 --- a/documentation/test-manual/understand-autobuilder.rst +++ b/documentation/test-manual/understand-autobuilder.rst @@ -32,8 +32,8 @@ which looks like:: } }, -And to expand that, you need the "arch-qemu" entry from -the "templates" section, which looks like:: +And to expand that, you need the ``arch-qemu`` entry from +the ``templates`` section, which looks like:: "arch-qemu" : { "BUILDINFO" : true, @@ -54,11 +54,11 @@ the "templates" section, which looks like:: } }, -Combining these two entries you can see that "qemux86-64" is a three step build where the -``bitbake BBTARGETS`` would be run, then ``bitbake SANITYTARGETS`` for each step; all for -``MACHINE="qemx86-64"`` but with differing SDKMACHINE settings. In step -1 an extra variable is added to the ``auto.conf`` file to enable wic -image generation. +Combining these two entries you can see that ``qemux86-64`` is a three step +build where ``bitbake BBTARGETS`` would be run, then ``bitbake SANITYTARGETS`` +for each step; all for ``MACHINE="qemux86-64"`` but with differing +:term:`SDKMACHINE` settings. In step 1, an extra variable is added to the +``auto.conf`` file to enable wic image generation. While not every detail of this is covered here, you can see how the template mechanism allows quite complex configurations to be built up @@ -163,8 +163,9 @@ Autobuilder Worker Janitor -------------------------- This is a process running on each Worker that performs two basic -operations, including background file deletion at IO idle (see :ref:`test-manual/understand-autobuilder:Autobuilder Target Execution Overview`: Run clobberdir) and -maintenance of a cache of cloned repositories to improve the speed +operations, including background file deletion at IO idle (see +"Run clobberdir" in :ref:`test-manual/understand-autobuilder:Autobuilder Target Execution Overview`) +and maintenance of a cache of cloned repositories to improve the speed the system can checkout repositories. Shared DL_DIR @@ -172,7 +173,7 @@ Shared DL_DIR The Workers are all connected over NFS which allows DL_DIR to be shared between them. This reduces network accesses from the system and allows -the build to be sped up. Usage of the directory within the build system +the build to be sped up. The usage of the directory within the build system is designed to be able to be shared over NFS. Shared SSTATE_DIR @@ -180,8 +181,8 @@ Shared SSTATE_DIR The Workers are all connected over NFS which allows the ``sstate`` directory to be shared between them. This means once a Worker has built -an artifact, all the others can benefit from it. Usage of the directory -within the directory is designed for sharing over NFS. +an artifact, all the others can benefit from it. The usage of the directory +within the build system is designed for sharing over NFS. Resulttool ---------- @@ -192,7 +193,7 @@ in a given build and their status. Additional information, such as failure logs or the time taken to run the tests, may also be included. Resulttool is part of OpenEmbedded-Core and is used to manipulate these -json results files. It has the ability to merge files together, display +JSON results files. It has the ability to merge files together, display reports of the test results and compare different result files. For details, see :yocto_wiki:`/Resulttool`. @@ -206,7 +207,11 @@ are general setup steps that are run once and include: #. Set up any ``buildtools-tarball`` if configured. +<<<<<<< HEAD #. Call "buildhistory-init" if buildhistory is configured. +======= +#. Call ``buildhistory-init`` if :ref:`ref-classes-buildhistory` is configured. +>>>>>>> 7c4f616f77 (test-manual: text and formatting fixes) For each step that is configured in ``config.json``, it will perform the following: @@ -258,7 +263,7 @@ it is inevitable that users will end up needing to heavily customise the ``yocto-autobuilder-helper`` repository, particularly the ``config.json`` file as they will want to define their own test matrix. -The Autobuilder supports wo customization options: +The Autobuilder supports two customization options: - variable substitution @@ -278,7 +283,7 @@ environment:: $ ABHELPER_JSON="config.json /some/location/local.json" One issue users often run into is validation of the ``config.json`` files. A -tip for minimizing issues from invalid json files is to use a Git +tip for minimizing issues from invalid JSON files is to use a Git ``pre-commit-hook.sh`` script to verify the JSON file before committing it. Create a symbolic link as follows:: From patchwork Mon Dec 18 21:44:35 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36595 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 96F5FC4706F for ; Mon, 18 Dec 2023 21:45:13 +0000 (UTC) Received: from relay8-d.mail.gandi.net (relay8-d.mail.gandi.net [217.70.183.201]) by mx.groups.io with SMTP id smtpd.web11.3223.1702935911298976878 for ; Mon, 18 Dec 2023 13:45:11 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=ZHhtg6ql; spf=pass (domain: bootlin.com, ip: 217.70.183.201, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id DA2591BF204; Mon, 18 Dec 2023 21:45:09 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935910; 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=fsbc3gaG4ZXhwRfDtBb9Ly/RLBUrTLdpvnt3gXB1biM=; b=ZHhtg6qlcfzNBAepthQPDHfq+xXnBNUHvGKc1ILwOhfd/WWClbJ1g2unH+nzHIN/D8x9fj fRiDBd5D/zvvTirfvjM8qxeK8dqAeDiGWg3ZZX/BPR73Dwn6GSxgobThj8NzEyxUOGX78h nkyE9o7cR2CBK+CBUShoAtpO3VX29FDUI28AH+T1wn5ku4SODgV2LxlguZRB4JB/HYurDb ORJhPXSmvIHDRcaAjNzl1TbrnAa7bOY5KiLDuJVAMX0UsdrSoN3LnZHalAmcZiwjd1fmwl xd7nmSVrRDfph2/48AvLj6BsiW9fuccG/PTFtwCOVCEXJNePqOqoS1s+5s6yLg== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [kirkstone][PATCH 11/18] test-manual: resource updates Date: Mon, 18 Dec 2023 22:44:35 +0100 Message-Id: <20231218214442.147385-12-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4717 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/test-manual/intro.rst | 20 +++++++++----------- 1 file changed, 9 insertions(+), 11 deletions(-) diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 3a3fc2270e..51934f4851 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst @@ -19,10 +19,8 @@ environment used by the Yocto Project to create their own automated, production test environment, building upon the foundations from the project core. -Currently, the Yocto Project Test Environment Manual has no projected -release date. This manual is a work-in-progress and is being initially -loaded with information from the README files and notes from key -engineers: +This manual is a work-in-progress and is being initially loaded with +information from the README files and notes from key engineers: - *yocto-autobuilder2:* This :yocto_git:`README.md ` @@ -39,7 +37,7 @@ engineers: As a result, it can be used by any Continuous Improvement (CI) system to run builds, support getting the correct code revisions, configure builds and layers, run builds, and collect results. The code is - independent of any CI system, which means the code can work `Buildbot `__, + independent of any CI system, which means the code can work `Buildbot `__, Jenkins, or others. This repository has a branch per release of the project defining the tests to run on a per release basis. @@ -54,8 +52,8 @@ the Autobuilder tests if things work. The Autobuilder builds all test targets and runs all the tests. The Yocto Project uses now uses standard upstream -`Buildbot `__ (version 9) to -drive its integration and testing. Buildbot Nine has a plug-in interface +Buildbot (`version 3.8 `__) to +drive its integration and testing. Buildbot has a plug-in interface that the Yocto Project customizes using code from the ``yocto-autobuilder2`` repository, adding its own console UI plugin. The resulting UI plug-in allows you to visualize builds in a way suited to @@ -299,11 +297,11 @@ Tests map into the codebase as follows: Git repository. Use the ``oe-build-perf-report`` command to generate text reports - and HTML reports with graphs of the performance data. For - examples, see - :yocto_dl:`/releases/yocto/yocto-2.7/testresults/buildperf-centos7/perf-centos7.yoctoproject.org_warrior_20190414204758_0e39202.html` + and HTML reports with graphs of the performance data. See + :yocto_dl:`html ` and - :yocto_dl:`/releases/yocto/yocto-2.7/testresults/buildperf-centos7/perf-centos7.yoctoproject.org_warrior_20190414204758_0e39202.txt`. + :yocto_dl:`txt ` + examples. - The tests are contained in ``lib/oeqa/buildperf/test_basic.py``. From patchwork Mon Dec 18 21:44:36 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36590 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 3CB7AC35274 for ; Mon, 18 Dec 2023 21:45:13 +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.web10.3166.1702935912386534775 for ; Mon, 18 Dec 2023 13:45:12 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=K2Dyg7KP; spf=pass (domain: bootlin.com, ip: 217.70.183.196, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 4F343E0006; Mon, 18 Dec 2023 21:45:10 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935911; 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=OK5eQehgF3VHHIcfW8x8dgEXNdYV/t2OEqseRG3spZk=; b=K2Dyg7KPPG31y5LDjhj/QUlN3NDjgDi5z47lpJSbmDe7wv46yu26w/dFfa7koSPd9ueqky uoUPxtRlxU+sPiMugHY+KoQ9LVVG2BYtKOCA1IB1yLbcZWXxUmcxD4ux0IRIgDBU+zzdHN rdGzZ+v/AYIn4GJ2DLVVUiJGG0UVtuvgnuxtLTCWRb8az2fO5sv9snjsEXEdtr1tmlVGA0 qjCMjiZjfiTXfgJVPN6JDsd4aOmNfRq5gkj6Ptf8nOq7IrXGzu86ztQ9LvRnfu3at3LjhM Ykl8PFR5AyTRqPbtPu3hwLugZSCj/kWt52M9iq/Bw8QMOO9oIrqIwQiXbkMOAg== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [kirkstone][PATCH 12/18] test-manual: add links to python unittest Date: Mon, 18 Dec 2023 22:44:36 +0100 Message-Id: <20231218214442.147385-13-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4719 From: Michael Opdenacker Better than using "python unittest" without any special formatting. Signed-off-by: Michael Opdenacker --- documentation/test-manual/intro.rst | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 51934f4851..811dfca4be 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst @@ -200,8 +200,8 @@ Tests map into the codebase as follows: $ bitbake-selftest bb.tests.data.TestOverrides.test_one_override - The tests are based on `Python - unittest `__. + The tests are based on + `Python unittest `__. - *oe-selftest:* @@ -214,7 +214,8 @@ Tests map into the codebase as follows: in the same thread. To parallelize large numbers of tests you can split the class into multiple units. - - The tests are based on Python unittest. + - The tests are based on + `Python unittest `__. - The code for the tests resides in ``meta/lib/oeqa/selftest/cases/``. @@ -333,21 +334,24 @@ A simple test example from ``lib/bb/tests/data.py`` is:: val = self.d.expand("${foo}") self.assertEqual(str(val), "value_of_foo") -In this example, a ``DataExpansions`` class of tests is created, -derived from standard python unittest. The class has a common ``setUp`` -function which is shared by all the tests in the class. A simple test is -then added to test that when a variable is expanded, the correct value -is found. +In this example, a ``DataExpansions`` class of tests is created, derived from +standard `Python unittest `__. +The class has a common ``setUp`` function which is shared by all the tests in +the class. A simple test is then added to test that when a variable is +expanded, the correct value is found. -Bitbake selftests are straightforward python unittest. Refer to the -Python unittest documentation for additional information on writing -these tests at: https://docs.python.org/3/library/unittest.html. +BitBake selftests are straightforward +`Python unittest `__. +Refer to the `Python unittest documentation +`__ for additional information +on writing such tests. ``oe-selftest`` --------------- These tests are more complex due to the setup required behind the scenes -for full builds. Rather than directly using Python's unittest, the code +for full builds. Rather than directly using `Python unittest +`__, the code wraps most of the standard objects. The tests can be simple, such as testing a command from within the OE build environment using the following example:: From patchwork Mon Dec 18 21:44:37 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36600 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 ADFC7C47073 for ; Mon, 18 Dec 2023 21:45:13 +0000 (UTC) Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [217.70.183.197]) by mx.groups.io with SMTP id smtpd.web10.3167.1702935913073322923 for ; Mon, 18 Dec 2023 13:45:13 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=Qv94o57D; spf=pass (domain: bootlin.com, ip: 217.70.183.197, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 6B5F51C0004; Mon, 18 Dec 2023 21:45:11 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935911; 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=uWTB7kzUDdmD1xbIMcURTszO4MsdVydSjvfkIExA69o=; b=Qv94o57Djy607JOssdCk7MEisQgOELpbxE+X08DYIObDpbAUFUPjZmeHIPNHpToDeKB+jv TtZXWeWBqCmQTfRIIRxxI18Wl1XeofVqTlgwudbDjn/CLlvhhP58uWVHicLznbJG/l0soD 9amA2EgEM1boDUCx1PFuCYE7/xwCy00EJ+wzyY+b68OQn7l1KzgeV5z+9v6vE6iD8N9nAz 3vBg9nmte/kdqOCg9na+WWBSzbM3Py6tltAVjZXMFB7sT7CXEV87jrlIKMdw5DYgfAgw9C r5KJ/UFPNEFQqabrU8V7BKVrBEgPiG/nA75rUtVreIMObaCGUF5XLoYtyOaO4g== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [kirkstone][PATCH 13/18] test-manual: explicit or fix file paths Date: Mon, 18 Dec 2023 22:44:37 +0100 Message-Id: <20231218214442.147385-14-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:13 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4720 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/test-manual/intro.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 811dfca4be..d58171fb80 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst @@ -271,7 +271,7 @@ Tests map into the codebase as follows: - These tests build an extended SDK (eSDK), install that eSDK, and run tests against the eSDK. - - The code for these tests resides in ``meta/lib/oeqa/esdk``. + - The code for these tests resides in ``meta/lib/oeqa/sdkext/cases/``. - To run the tests, use the following command form:: @@ -304,7 +304,7 @@ Tests map into the codebase as follows: :yocto_dl:`txt ` examples. - - The tests are contained in ``lib/oeqa/buildperf/test_basic.py``. + - The tests are contained in ``meta/lib/oeqa/buildperf/test_basic.py``. Test Examples ============= @@ -312,16 +312,14 @@ Test Examples This section provides example tests for each of the tests listed in the :ref:`test-manual/intro:How Tests Map to Areas of Code` section. -For oeqa tests, testcases for each area reside in the main test -directory at ``meta/lib/oeqa/selftest/cases`` directory. +- ``oe-selftest`` testcases reside in the ``meta/lib/oeqa/selftest/cases`` directory. -For oe-selftest. bitbake testcases reside in the ``lib/bb/tests/`` -directory. +- ``bitbake-selftest`` testcases reside in the ``bitbake/lib/bb/tests/`` directory. ``bitbake-selftest`` -------------------- -A simple test example from ``lib/bb/tests/data.py`` is:: +A simple test example from ``bitbake/lib/bb/tests/data.py`` is:: class DataExpansions(unittest.TestCase): def setUp(self): From patchwork Mon Dec 18 21:44:38 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36606 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 B6C88C46CD4 for ; Mon, 18 Dec 2023 21:45:23 +0000 (UTC) Received: from relay7-d.mail.gandi.net (relay7-d.mail.gandi.net [217.70.183.200]) by mx.groups.io with SMTP id smtpd.web11.3226.1702935914109132936 for ; Mon, 18 Dec 2023 13:45:14 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=iVx5kV3M; spf=pass (domain: bootlin.com, ip: 217.70.183.200, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 4D01620003; Mon, 18 Dec 2023 21:45:11 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935912; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=ud0Cl7H+GPjowcTqXdunB7T4i+sL6rJUT+IoOT2xm9o=; b=iVx5kV3MCe2WHWZfk5kKVYok1Y+XV1JUNNlsmV3QsF4k3tdBXKtLMY117vhfF4CuhBNyYp wq28UYt1aSq3C/5soYpSLfHMOSsuRc/OUG1mK1Zt6AkLf06FBCVYt6PKTEM92v4bcdCywz nlo54E4P4WbLBUeSaQMXY6MU5jtBV4Mj3M57qDQe3o62m7AsKuK7XCAxkKQlSHOp6qc/ke g/p1JiynNcIIUe0rzSaUQZvrThu1/DkzFuFonHrEAvC6Z+3+mrDbYw/a4UB7a1+Ko7huZF etxmZHrW7nmWqbD4HDt8Frb7Mvn/dy4boQw8lBHYZdAfN/r/lR6CxWUvDXLA4g== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [kirkstone][PATCH 14/18] test-manual: add or improve hyperlinks Date: Mon, 18 Dec 2023 22:44:38 +0100 Message-Id: <20231218214442.147385-15-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:23 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4722 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/test-manual/test-process.rst | 32 +++++++++---------- .../test-manual/understand-autobuilder.rst | 31 +++++++++--------- 2 files changed, 31 insertions(+), 32 deletions(-) diff --git a/documentation/test-manual/test-process.rst b/documentation/test-manual/test-process.rst index 0c560efe39..7bec5ba828 100644 --- a/documentation/test-manual/test-process.rst +++ b/documentation/test-manual/test-process.rst @@ -20,8 +20,8 @@ helps review and test patches and this is his testing tree). We have two broad categories of test builds, including "full" and "quick". On the Autobuilder, these can be seen as "a-quick" and "a-full", simply for ease of sorting in the UI. Use our Autobuilder -console view to see where me manage most test-related items, available -at: :yocto_ab:`/typhoon/#/console`. +:yocto_ab:`console view ` to see where we manage most +test-related items. Builds are triggered manually when the test branches are ready. The builds are monitored by the SWAT team. For additional information, see @@ -34,18 +34,15 @@ which the result was required. The Autobuilder does build the ``master`` branch once daily for several reasons, in particular, to ensure the current ``master`` branch does -build, but also to keep ``yocto-testresults`` -(:yocto_git:`/yocto-testresults/`), -buildhistory -(:yocto_git:`/poky-buildhistory/`), and -our sstate up to date. On the weekend, there is a master-next build +build, but also to keep (:yocto_git:`yocto-testresults `), +(:yocto_git:`buildhistory `), and +our sstate up to date. On the weekend, there is a ``master-next`` build instead to ensure the test results are updated for the less frequently run targets. Performance builds (``buildperf-\*`` targets in the console) are triggered separately every six hours and automatically push their results to the -buildstats repository at: -:yocto_git:`/yocto-buildstats/`. +:yocto_git:`buildstats ` repository. The "quick" targets have been selected to be the ones which catch the most failures or give the most valuable data. We run "fast" ptests in @@ -69,10 +66,10 @@ configured to generate and publish artifacts and the milestone number, version, release candidate number and other information is entered. The box to "generate an email to QA" is also checked. -When the build completes, an email is sent out using the send-qa-email -script in the ``yocto-autobuilder-helper`` repository to the list of -people configured for that release. Release builds are placed into a -directory in https://autobuilder.yocto.io/pub/releases on the +When the build completes, an email is sent out using the ``send-qa-email`` +script in the :yocto_git:`yocto-autobuilder-helper ` +repository to the list of people configured for that release. Release builds +are placed into a directory in https://autobuilder.yocto.io/pub/releases on the Autobuilder which is included in the email. The process from here is more manual and control is effectively passed to release engineering. The next steps include: @@ -80,14 +77,15 @@ The next steps include: - QA teams respond to the email saying which tests they plan to run and when the results will be available. -- QA teams run their tests and share their results in the yocto- - testresults-contrib repository, along with a summary of their - findings. +- QA teams run their tests and share their results in the + :yocto_git:`yocto-testresults-contrib ` + repository, along with a summary of their findings. - Release engineering prepare the release as per their process. - Test results from the QA teams are included into the release in - separate directories and also uploaded to the yocto-testresults + separate directories and also uploaded to the + :yocto_git:`yocto-testresults ` repository alongside the other test results for the given revision. - The QA report in the final release is regenerated using resulttool to diff --git a/documentation/test-manual/understand-autobuilder.rst b/documentation/test-manual/understand-autobuilder.rst index ef03955954..11e2ceb12f 100644 --- a/documentation/test-manual/understand-autobuilder.rst +++ b/documentation/test-manual/understand-autobuilder.rst @@ -9,8 +9,8 @@ Execution Flow within the Autobuilder The "a-full" and "a-quick" targets are the usual entry points into the Autobuilder and it makes sense to follow the process through the system -starting there. This is best visualized from the Autobuilder Console -view (:yocto_ab:`/typhoon/#/console`). +starting there. This is best visualized from the :yocto_ab:`Autobuilder +Console view `. Each item along the top of that view represents some "target build" and these targets are all run in parallel. The 'full' build will trigger the @@ -18,9 +18,9 @@ majority of them, the "quick" build will trigger some subset of them. The Autobuilder effectively runs whichever configuration is defined for each of those targets on a separate buildbot worker. To understand the configuration, you need to look at the entry on ``config.json`` file -within the ``yocto-autobuilder-helper`` repository. The targets are -defined in the ‘overrides' section, a quick example could be qemux86-64 -which looks like:: +within the :yocto_git:`yocto-autobuilder-helper ` +repository. The targets are defined in the ``overrides`` section, a quick +example could be ``qemux86-64`` which looks like:: "qemux86-64" : { "MACHINE" : "qemux86-64", @@ -88,9 +88,9 @@ roughly consist of: #. *Obtain yocto-autobuilder-helper* - This step clones the ``yocto-autobuilder-helper`` git repository. - This is necessary to prevent the requirement to maintain all the - release or project-specific code within Buildbot. The branch chosen + This step clones the :yocto_git:`yocto-autobuilder-helper ` + git repository. This is necessary to avoid the requirement to maintain all + the release or project-specific code within Buildbot. The branch chosen matches the release being built so we can support older releases and still make changes in newer ones. @@ -255,13 +255,14 @@ Deploying Yocto Autobuilder =========================== The most up to date information about how to setup and deploy your own -Autobuilder can be found in README.md in the ``yocto-autobuilder2`` -repository. - -We hope that people can use the ``yocto-autobuilder2`` code directly but -it is inevitable that users will end up needing to heavily customise the -``yocto-autobuilder-helper`` repository, particularly the -``config.json`` file as they will want to define their own test matrix. +Autobuilder can be found in :yocto_git:`README.md ` +in the :yocto_git:`yocto-autobuilder2 ` repository. + +We hope that people can use the :yocto_git:`yocto-autobuilder2 ` +code directly but it is inevitable that users will end up needing to heavily +customize the :yocto_git:`yocto-autobuilder-helper ` +repository, particularly the ``config.json`` file as they will want to define +their own test matrix. The Autobuilder supports two customization options: From patchwork Mon Dec 18 21:44:39 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36602 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 A5A16C35274 for ; Mon, 18 Dec 2023 21:45:23 +0000 (UTC) Received: from relay8-d.mail.gandi.net (relay8-d.mail.gandi.net [217.70.183.201]) by mx.groups.io with SMTP id smtpd.web11.3227.1702935914230345729 for ; Mon, 18 Dec 2023 13:45:14 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=i0w7OQ0Z; spf=pass (domain: bootlin.com, ip: 217.70.183.201, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id B0DED1BF203; Mon, 18 Dec 2023 21:45:12 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935912; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=9xtgto+9AUZR1VnmFL162Xw4Ra2higmFbS6/PnFX3yg=; b=i0w7OQ0ZQuzm3D/U0NWhpIxQcqea3ZXrCaIiniJ2QOxnnvSB6Stq9OFpFKsPfDujdmZA9B Yw63RY41PE/vWU/wVUbQCm2mZwAH8N+pTtj3SBBp7fSkIW068hcWuM4B37J+B4huBfP5bi Z7WwKdCrJg+v4K9smrRe4MB+8vwANy1HWZMBGC3piqiPFmJFwuBC3Qqd7rznDFTsNBAD9W r/tIWZAfNxNDFDGgWn9bbb45hwT5KhuskOM/mFK9YIjoTF8esuOvp3EJdWOeuKQHXJ97IC jhEUhHgcZPs5+/7OlpglwGi1l5kmgA5vmkFl3H6HoTojPgK3kGmFH6F+yRNGzQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , =?utf-8?q?Simone_We?= =?utf-8?q?i=C3=9F?= Subject: [kirkstone][PATCH 15/18] manuals: brief-yoctoprojectqs: align variable order with default local.conf Date: Mon, 18 Dec 2023 22:44:39 +0100 Message-Id: <20231218214442.147385-16-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:23 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4721 From: Michael Opdenacker From: Simone Weiß Align the order from `BB_SIGNATURE_HANDLER` to `SSTATE_MIRRORS` in Quick Build with the order in the default local conf. While trivial it is easier to find, if the order matches. Signed-off-by: Simone Weiß Reviewed-by: Michael Opdenacker --- documentation/brief-yoctoprojectqs/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst index 20b2ebab6b..ec4cc8b051 100644 --- a/documentation/brief-yoctoprojectqs/index.rst +++ b/documentation/brief-yoctoprojectqs/index.rst @@ -254,10 +254,10 @@ an entire Linux distribution, including the toolchain, from source. To use such mirrors, uncomment the below lines in your ``conf/local.conf`` file in the :term:`Build Directory`:: - BB_SIGNATURE_HANDLER = "OEEquivHash" - BB_HASHSERVE = "auto" BB_HASHSERVE_UPSTREAM = "hashserv.yocto.io:8687" SSTATE_MIRRORS ?= "file://.* http://cdn.jsdelivr.net/yocto/sstate/all/PATH;downloadfilename=PATH" + BB_HASHSERVE = "auto" + BB_SIGNATURE_HANDLER = "OEEquivHash" #. **Start the Build:** Continue with the following command to build an OS image for the target, which is ``core-image-sato`` in this example: From patchwork Mon Dec 18 21:44:40 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36605 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 BB36CC46CA2 for ; Mon, 18 Dec 2023 21:45:23 +0000 (UTC) Received: from relay9-d.mail.gandi.net (relay9-d.mail.gandi.net [217.70.183.199]) by mx.groups.io with SMTP id smtpd.web10.3170.1702935915315147560 for ; Mon, 18 Dec 2023 13:45:15 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=ckq2f46T; spf=pass (domain: bootlin.com, ip: 217.70.183.199, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 7FD61FF806; Mon, 18 Dec 2023 21:45:13 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935913; 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=eigl9rJT+naEEupvcCHxt08mi7eQMUi2OAusHefOxiM=; b=ckq2f46Tb6AnDljiKjBoP1W0KGPDVhhuCbfB1Uo3Owbv5P1lWpGgVtW0P3yFlQVEljyK0+ o73o2h3Ogev2HZhv4pyGXZtujjbvc1coD226sWHneGwkOznU4eRqsQL72e+ALXS7mpkNHh GA7nt2BeKKM+wI2NAfXixnSYAi7KJfebQcVEYLkKlUNJNb06P91XR+/RxrK8Ak+vZvulb3 O8OYUlSEPxwxKSDBayszcz69/ThBu9I7INHMscyJGGg092Qt+3RQYqinMktcpErZllnIFY EQFNUQg4HwDb99WdtoZtb65hqScAWmAOaYkg7JLfAaQE/Vr1ivMviK4os+tkKw== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [kirkstone][PATCH 16/18] dev-manual: runtime-testing: fix test module name Date: Mon, 18 Dec 2023 22:44:40 +0100 Message-Id: <20231218214442.147385-17-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:23 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4723 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/dev-manual/runtime-testing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/dev-manual/runtime-testing.rst b/documentation/dev-manual/runtime-testing.rst index af3fe2c1dd..b9aa6759d1 100644 --- a/documentation/dev-manual/runtime-testing.rst +++ b/documentation/dev-manual/runtime-testing.rst @@ -459,7 +459,7 @@ layer's ``layer.conf`` file as normal). Just remember the following: directory. To create a new test, start by copying an existing module (e.g. -``syslog.py`` or ``gcc.py`` are good ones to use). Test modules can use +``oe_syslog.py`` or ``gcc.py`` are good ones to use). Test modules can use code from ``meta/lib/oeqa/utils``, which are helper classes. .. note:: From patchwork Mon Dec 18 21:44:41 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36603 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 AB0A4C46CCD for ; Mon, 18 Dec 2023 21:45:23 +0000 (UTC) Received: from relay5-d.mail.gandi.net (relay5-d.mail.gandi.net [217.70.183.197]) by mx.groups.io with SMTP id smtpd.web10.3172.1702935916170872347 for ; Mon, 18 Dec 2023 13:45:16 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=FEnq7Nu+; spf=pass (domain: bootlin.com, ip: 217.70.183.197, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id EFE8C1C0006; Mon, 18 Dec 2023 21:45:13 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935914; 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=4zR2o/eVuTjwm4fdafIDRM+atf4mzpHRbOFrPyhHQ9I=; b=FEnq7Nu+QRtbQsLeIBimJdbTzpou63e1LgJaXCQl1L+FcBSNnC+ei14pBVr4QLqWSZBcLG YCuxCGDiaxO6UoSMkmwnzTcAa28Apzb/T6zHLuGvc5ZcCslFPiUhRFiTte0OxMCF9rGs6D +1ZAxkB4hHlMRnpj9t9ZIjlnOfc+nsEF5gF3tpiS26Jntn5XyXTGRYGzxnYMeWqlmMNEzz VaDWQNfEswgcn19/UPhyZhCVyb/dP3KO9CCYj5ho2KRCN5seRD+UXmUJjZV5ZzYvRdDZ4p iuG6rfAd67YbWJLTYpnIsSRraMRyDOLb57yT3RW+5l6l2NEYOpke5GMa8akmbg== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Lee Chee Yang Subject: [kirkstone][PATCH 17/18] migration-guides: add release notes for 4.0.15 Date: Mon, 18 Dec 2023 22:44:41 +0100 Message-Id: <20231218214442.147385-18-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:23 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4725 From: Michael Opdenacker From: Lee Chee Yang Signed-off-by: Lee Chee Yang Reviewed-by: Michael Opdenacker --- .../migration-guides/release-4.0.rst | 1 + .../migration-guides/release-notes-4.0.15.rst | 189 ++++++++++++++++++ 2 files changed, 190 insertions(+) create mode 100644 documentation/migration-guides/release-notes-4.0.15.rst diff --git a/documentation/migration-guides/release-4.0.rst b/documentation/migration-guides/release-4.0.rst index 748eab3bd0..09fb8ca049 100644 --- a/documentation/migration-guides/release-4.0.rst +++ b/documentation/migration-guides/release-4.0.rst @@ -21,3 +21,4 @@ Release 4.0 (kirkstone) release-notes-4.0.12 release-notes-4.0.13 release-notes-4.0.14 + release-notes-4.0.15 diff --git a/documentation/migration-guides/release-notes-4.0.15.rst b/documentation/migration-guides/release-notes-4.0.15.rst new file mode 100644 index 0000000000..b2731530e8 --- /dev/null +++ b/documentation/migration-guides/release-notes-4.0.15.rst @@ -0,0 +1,189 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.15 (Kirkstone) +------------------------------------------ + +Security Fixes in Yocto-4.0.15 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- avahi: Fix :cve:`2023-1981`, :cve:`2023-38469`, :cve:`2023-38470`, :cve:`2023-38471`, :cve:`2023-38472` and :cve:`2023-38473` +- binutils: Fix :cve:`2022-47007`, :cve:`2022-47010` and :cve:`2022-48064` +- bluez5: Fix :cve:`2023-45866` +- ghostscript: Ignore GhostPCL :cve:`2023-38560` +- gnutls: Fix :cve:`2023-5981` +- go: Ignore :cve:`2023-45283` and :cve:`2023-45284` +- grub: Fix :cve:`2023-4692` and :cve:`2023-4693` +- gstreamer1.0-plugins-bad: Fix :cve_mitre:`2023-44429` +- libsndfile: Fix :cve:`2022-33065` +- libwebp: Fix :cve:`2023-4863` +- openssl: Fix :cve:`2023-5678` +- python3-cryptography: Fix :cve:`2023-49083` +- qemu: Fix :cve:`2023-1544` +- sudo: :cve:`2023-42456` and :cve_mitre:`2023-42465` +- tiff: Fix :cve:`2023-41175` +- vim: Fix :cve:`2023-46246`, :cve:`2023-48231`, :cve:`2023-48232`, :cve:`2023-48233`, :cve:`2023-48234`, :cve:`2023-48235`, :cve:`2023-48236`, :cve:`2023-48237` and :cve:`2023-48706` +- xserver-xorg: Fix :cve:`2023-5367` and :cve:`2023-5380` +- xwayland: Fix :cve:`2023-5367` + + +Fixes in Yocto-4.0.15 +~~~~~~~~~~~~~~~~~~~~~ + +- bash: changes to SIGINT handler while waiting for a child +- bitbake: Fix disk space monitoring on cephfs +- bitbake: bitbake-getvar: Make --quiet work with --recipe +- bitbake: runqueue.py: fix PSI check logic +- bitbake: runqueue: Add pressure change logging +- bitbake: runqueue: convert deferral messages from bb.note to bb.debug +- bitbake: runqueue: fix PSI check calculation +- bitbake: runqueue: show more pressure data +- bitbake: runqueue: show number of currently running bitbake threads when pressure changes +- bitbake: tinfoil: Do not fail when logging is disabled and full config is used +- build-appliance-image: Update to kirkstone head revision +- cve-check: don't warn if a patch is remote +- cve-check: slightly more verbose warning when adding the same package twice +- cve-check: sort the package list in the JSON report +- cve-exclusion_5.10.inc: update for 5.10.202 +- go: Fix issue in DNS resolver +- goarch: Move Go architecture mapping to a library +- gstreamer1.0-plugins-base: enable glx/opengl support +- linux-yocto/5.10: update to v5.10.202 +- manuals: update class references +- migration-guide: add release notes for 4.0.14 +- native: Clear TUNE_FEATURES/ABIEXTENSION +- openssh: drop sudo from ptest dependencies +- overview-manual: concepts: Add Bitbake Tasks Map +- poky.conf: bump version for 4.0.15 +- python3-jinja2: Fixed ptest result output as per the standard +- ref-manual: classes: explain cml1 class name +- ref-manual: update :term:`SDK_NAME` variable documentation +- ref-manual: variables: add :term:`RECIPE_MAINTAINER` +- ref-manual: variables: document OEQA_REPRODUCIBLE_* variables +- ref-manual: variables: mention new CDN for :term:`SSTATE_MIRRORS` +- rust-common: Set llvm-target correctly for cross SDK targets +- rust-cross-canadian: Fix ordering of target json config generation +- rust-cross/rust-common: Merge arm target handling code to fix cross-canadian +- rust-cross: Simplfy the rust_gen_target calls +- rust-llvm: Allow overriding LLVM target archs +- sdk-manual: extensible.rst: remove instructions for using SDK functionality directly in a yocto build +- sudo: upgrade to 1.9.15p2 +- systemtap_git: fix used uninitialized error +- vim: Improve locale handling +- vim: Upgrade to 9.0.2130 +- vim: use upstream generated .po files + + +Known Issues in Yocto-4.0.15 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.15 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alexander Kanavin +- Archana Polampalli +- BELHADJ SALEM Talel +- Bruce Ashfield +- Chaitanya Vadrevu +- Chen Qi +- Deepthi Hemraj +- Denys Dmytriyenko +- Hitendra Prajapati +- Lee Chee Yang +- Li Wang +- Martin Jansa +- Meenali Gupta +- Michael Opdenacker +- Mikko Rapeli +- Narpat Mali +- Niko Mauno +- Ninad Palsule +- Niranjan Pradhan +- Paul Eggleton +- Peter Kjellerstedt +- Peter Marko +- Richard Purdie +- Ross Burton +- Samantha Jalabert +- Sanjana +- Soumya Sambu +- Steve Sakoman +- Tim Orling +- Vijay Anusuri +- Vivek Kumbhar +- Wenlin Kang +- Yogita Urade + + +Repositories / Downloads for Yocto-4.0.15 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone ` +- Tag: :yocto_git:`yocto-4.0.15 ` +- Git Revision: :yocto_git:`755632c2fcab43aa05cdcfa529727064b045073c ` +- Release Artefact: poky-755632c2fcab43aa05cdcfa529727064b045073c +- sha: b40b43bd270d21a420c399981f9cfe0eb999f15e051fc2c89d124f249cdc0bd5 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.15/poky-755632c2fcab43aa05cdcfa529727064b045073c.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.15/poky-755632c2fcab43aa05cdcfa529727064b045073c.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone ` +- Tag: :oe_git:`yocto-4.0.15 ` +- Git Revision: :oe_git:`eea685e1caafd8e8121006d3f8b5d0b8a4f2a933 ` +- Release Artefact: oecore-eea685e1caafd8e8121006d3f8b5d0b8a4f2a933 +- sha: ddc3d4a2c8a097f2aa7132ae716affacc44b119c616a1eeffb7db56caa7fc79e +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.15/oecore-eea685e1caafd8e8121006d3f8b5d0b8a4f2a933.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.15/oecore-eea685e1caafd8e8121006d3f8b5d0b8a4f2a933.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone ` +- Tag: :yocto_git:`yocto-4.0.15 ` +- Git Revision: :yocto_git:`f6b38ce3c90e1600d41c2ebb41e152936a0357d7 ` +- Release Artefact: meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7 +- sha: 7d57167c19077f4ab95623d55a24c2267a3a3fb5ed83688659b4c03586373b25 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.15/meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.15/meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone ` +- Tag: :yocto_git:`yocto-4.0.15 ` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a ` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.15/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.15/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 ` +- Tag: :oe_git:`yocto-4.0.15 ` +- Git Revision: :oe_git:`42a1c9fe698a03feb34c5bba223c6e6e0350925b ` +- Release Artefact: bitbake-42a1c9fe698a03feb34c5bba223c6e6e0350925b +- sha: 64c684ccd661fa13e25c859dfc68d66bec79281da0f4f81b0d6a9995acb659b5 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.15/bitbake-42a1c9fe698a03feb34c5bba223c6e6e0350925b.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.15/bitbake-42a1c9fe698a03feb34c5bba223c6e6e0350925b.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone ` +- Tag: :yocto_git:`yocto-4.0.15 ` +- Git Revision: :yocto_git:`08fda7a5601393617b1ecfe89229459e14a90b1d ` + From patchwork Mon Dec 18 21:44:42 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 36604 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 C4AE1C46CD7 for ; Mon, 18 Dec 2023 21:45:23 +0000 (UTC) Received: from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net [217.70.183.195]) by mx.groups.io with SMTP id smtpd.web10.3171.1702935916135912639 for ; Mon, 18 Dec 2023 13:45:16 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=nvY7Z4AE; spf=pass (domain: bootlin.com, ip: 217.70.183.195, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id A693C60002; Mon, 18 Dec 2023 21:45:14 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1702935914; 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=9pcuTeNVH0EpOZfDAxu5fEWUpljXdJPAwp4Lj6HiLKs=; b=nvY7Z4AEnhd/TSFM+YVZQbxTwo3o6FlfgD61/JhDxfl806fJV8PWh43A+H3QWsGMibIXLY YbbsYu6bZTV6d1Dbfp013sQd18fqeSS4taia1pQqDeCB83p1Pbme4HZ4rgMZ+lbqsjt+WS vmdfPvSqhlbvXRGMdSSSoT28DBhoTLeUq8ry+sr13CJJTLJGuxp1EKZoTf0uFplsuDfkkb pjlJd0rZryLj/U1nX6jwu0GlTJf+TzyjNX5jmGrH59SUftLuBdMS2KJlLj5C9C+EY7eeBS KxINgku4GB8qWyf9Aq4RMNdVINuUC9gCj9MtPkjiD2bWckj1R6L0Q2QpTqxHnw== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [kirkstone][PATCH 18/18] test-manual: use working example Date: Mon, 18 Dec 2023 22:44:42 +0100 Message-Id: <20231218214442.147385-19-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231218214442.147385-1-michael.opdenacker@bootlin.com> References: <20231218214442.147385-1-michael.opdenacker@bootlin.com> MIME-Version: 1.0 X-GND-Sasl: michael.opdenacker@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 ; Mon, 18 Dec 2023 21:45:23 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/4724 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/test-manual/intro.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index d58171fb80..16f73ca468 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst @@ -190,15 +190,15 @@ Tests map into the codebase as follows: Use this option when you wish to skip tests that access the network, which are mostly necessary to test the fetcher modules. To specify individual test modules to run, append the test module name to the - "bitbake-selftest" command. For example, to specify the tests for the - bb.data.module, run:: + ``bitbake-selftest`` command. For example, to specify the tests for + ``bb.tests.data.DataExpansions``, run:: - $ bitbake-selftest bb.test.data.module + $ bitbake-selftest bb.tests.data.DataExpansions You can also specify individual tests by defining the full name and module plus the class path of the test, for example:: - $ bitbake-selftest bb.tests.data.TestOverrides.test_one_override + $ bitbake-selftest bb.tests.data.DataExpansions.test_one_var The tests are based on `Python unittest `__.