From patchwork Thu May 23 13:56:26 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 44088 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 4D25AC25B75 for ; Thu, 23 May 2024 13:56:41 +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.17704.1716472598388292370 for ; Thu, 23 May 2024 06:56:38 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=OUrTHuMB; spf=pass (domain: bootlin.com, ip: 217.70.183.201, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 96C391BF208; Thu, 23 May 2024 13:56:36 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1716472596; 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; bh=5Y70d8GkuJBvmfU2h+wbZX5MQebzfD0G70fHoi0kS3o=; b=OUrTHuMBaTXIKl5uLE3PmYDRmDu7rkYup1mTya90RajQgCRWfM8ARLeUj17X6+F2ncsG6u PUazaRDffa3MVYEriQrK9JydcXQKM/DixnTkyX3KVwvxqaZdngebwe+HVKyJjBXjKnhuP1 AJuIM0LqV2IGAcALB91EIoGRrbVV4WvAECIxBcyUW4W6tDxZkWntkWSOOuDQLw6SXfIGDY iCJh/yH32m8abNlb3bGDGvAi7Resqw1JgmvFNs44yYHsj61sHOg+zAvn6ZjomZXT16aly3 Q7sfqEZ14aMnkMdL2UHUNEVGynkoPyRoIfgKR1G2g9XglSWf3pECOg2IN1RARg== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [PATCH 1/3] migration-guides: placeholder files for 5.1 Date: Thu, 23 May 2024 15:56:26 +0200 Message-Id: <20240523135628.3076018-1-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 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 ; Thu, 23 May 2024 13:56:41 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/5243 From: Michael Opdenacker Signed-off-by: Michael Opdenacker --- documentation/migration-guides/index.rst | 1 + .../migration-guides/migration-5.1.rst | 83 +++++++++++++++++++ .../migration-guides/release-5.1.rst | 9 ++ .../migration-guides/release-notes-5.1.rst | 67 +++++++++++++++ 4 files changed, 160 insertions(+) create mode 100644 documentation/migration-guides/migration-5.1.rst create mode 100644 documentation/migration-guides/release-5.1.rst create mode 100644 documentation/migration-guides/release-notes-5.1.rst diff --git a/documentation/migration-guides/index.rst b/documentation/migration-guides/index.rst index d8edd05b89..e9d7f72809 100644 --- a/documentation/migration-guides/index.rst +++ b/documentation/migration-guides/index.rst @@ -12,6 +12,7 @@ to move to one release of the Yocto Project from the previous one. .. toctree:: migration-general + release-5.1 release-5.0 release-4.3 release-4.2 diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst new file mode 100644 index 0000000000..b4db04bcee --- /dev/null +++ b/documentation/migration-guides/migration-5.1.rst @@ -0,0 +1,83 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release 5.1 LTS (styhead) +=========================== + +Migration notes for 5.1 (styhead) +------------------------------------ + +This section provides migration information for moving to the Yocto +Project 5.1 Release (codename "styhead") from the prior release. + +.. _migration-5.1-supported-kernel-versions: + +Supported kernel versions +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The :term:`OLDEST_KERNEL` setting is still "5.15" in this release, meaning that +out the box, older kernels are not supported. See :ref:`4.3 migration notes +` for details. + +.. _migration-5.1-supported-distributions: + +Supported distributions +~~~~~~~~~~~~~~~~~~~~~~~ + +Compared to the previous releases, running BitBake is supported on new +GNU/Linux distributions: + +On the other hand, some earlier distributions are no longer supported: + +See :ref:`all supported distributions `. + +.. _migration-5.1-go-changes: + +Go language changes +~~~~~~~~~~~~~~~~~~~ + +.. _migration-5.1-systemd-changes: + +systemd changes +~~~~~~~~~~~~~~~ + +.. _migration-5.1-recipe-changes: + +Recipe changes +~~~~~~~~~~~~~~ + +.. _migration-5.1-deprecated-variables: + +Deprecated variables +~~~~~~~~~~~~~~~~~~~~ + +.. _migration-5.1-removed-variables: + +Removed variables +~~~~~~~~~~~~~~~~~ + +The following variables have been removed: + +.. _migration-5.1-removed-recipes: + +Removed recipes +~~~~~~~~~~~~~~~ + +The following recipes have been removed in this release: + +.. _migration-5.1-removed-classes: + +Removed classes +~~~~~~~~~~~~~~~ + +No classes have been removed in this release. + +.. _migration-5.1-qemu-changes: + +QEMU changes +~~~~~~~~~~~~ + +.. _migration-5.1-misc-changes: + +Miscellaneous changes +~~~~~~~~~~~~~~~~~~~~~ + diff --git a/documentation/migration-guides/release-5.1.rst b/documentation/migration-guides/release-5.1.rst new file mode 100644 index 0000000000..768edfa2b0 --- /dev/null +++ b/documentation/migration-guides/release-5.1.rst @@ -0,0 +1,9 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release 5.1 (styhead) +======================= + +.. toctree:: + + migration-5.1 + release-notes-5.1 diff --git a/documentation/migration-guides/release-notes-5.1.rst b/documentation/migration-guides/release-notes-5.1.rst new file mode 100644 index 0000000000..32cb2de2b4 --- /dev/null +++ b/documentation/migration-guides/release-notes-5.1.rst @@ -0,0 +1,67 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for 5.1 (styhead) +--------------------------------- + +New Features / Enhancements in 5.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Linux kernel 6.X, gcc 14.X, glibc 2.X, LLVM 18.X, and over XXX other recipe upgrades + +- New variables: + +- Architecture-specific enhancements: + +- Kernel-related enhancements: + +- New core recipes: + +- QEMU / ``runqemu`` enhancements: + +- Rust improvements: + +- wic Image Creator enhancements: + +- SDK-related improvements: + +- Testing: + +- Utility script changes: + +- BitBake improvements: + +- devtool improvements: + +- recipetool improvements: + +- Packaging changes: + +- Security improvements: + +- Toaster Web UI improvements: + +- Prominent documentation updates: + +- Miscellaneous changes: + +Known Issues in 5.1 +~~~~~~~~~~~~~~~~~~~ + +Recipe License changes in 5.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following corrections have been made to the :term:`LICENSE` values set by recipes: + +Security Fixes in 5.1 +~~~~~~~~~~~~~~~~~~~~~ + +Recipe Upgrades in 5.1 +~~~~~~~~~~~~~~~~~~~~~~ + +Contributors to 5.1 +~~~~~~~~~~~~~~~~~~~ + +Thanks to the following people who contributed to this release: + +Repositories / Downloads for Yocto-5.1 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From patchwork Thu May 23 13:56:27 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 44089 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 48EF9C25B79 for ; Thu, 23 May 2024 13:56:51 +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.web10.16180.1716472603059737675 for ; Thu, 23 May 2024 06:56:43 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=cE9GzDg6; spf=pass (domain: bootlin.com, ip: 217.70.183.198, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id 282D6C0005; Thu, 23 May 2024 13:56:40 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1716472601; 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=J5Ceqr4QHYZk7VZCHUZQWzmKla3OrhJCCgI9aKJtiWE=; b=cE9GzDg6cjp2mxrvadqKxFZRiQgI/fWfw6EdMpmsPKziV+c00v9v450YTc8d7W25uB3Ugi 5uZP48TPo8Dp4APjvYzLCG/PhaIoq1DPEz86/pM6P51nuzs/PHO/N2kBHBY1vVavhXSlLC xP7I5/V5qjfkOYqQDgnusoTYfQp1qEvPi2t32xzBxy5dEFC7lshtyJS7ohhLDahswcDXJv LFucf/3MVw9ynKviIUwTPioSjgYhaXI62BP1N1TDSmhTjArz2i7lM3t1JIEn1mhXo8GLo5 an8W+XhiKKEGDti+yHilNjGuoSG0F1Snk2CNywzKu90Bleaf1q3WtyGEl1X0gQ== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker Subject: [PATCH 2/3] ref-manual: introduce UNPACKDIR variable Date: Thu, 23 May 2024 15:56:27 +0200 Message-Id: <20240523135628.3076018-2-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240523135628.3076018-1-michael.opdenacker@bootlin.com> References: <20240523135628.3076018-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 ; Thu, 23 May 2024 13:56:51 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/5244 From: Michael Opdenacker Note that this doesn't touch the "Source Fetching" section in overview-manual/concepts.rst yet, as the unpack implementation may not be finalized yet. Signed-off-by: Michael Opdenacker Reviewed-by: Andrew Murray --- documentation/ref-manual/tasks.rst | 8 ++++---- documentation/ref-manual/variables.rst | 5 +++++ 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index 2e4b23408d..70c0dea3bb 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -412,12 +412,12 @@ them. You can learn more by looking at the ------------- Unpacks the source code into a working directory pointed to by -``${``\ :term:`WORKDIR`\ ``}``. The :term:`S` -variable also plays a role in where unpacked source files ultimately -reside. For more information on how source files are unpacked, see the +``${``\ :term:`UNPACKDIR`\ ``}``. Another, legacy way to specify +this directory is through the :term:`S` and :term:`WORKDIR` variables. +For more information on how source files are unpacked, see the ":ref:`overview-manual/concepts:source fetching`" section in the Yocto Project Overview and Concepts Manual and also see -the :term:`WORKDIR` and :term:`S` variable descriptions. +the :term:`UNPACKDIR`, :term:`WORKDIR` and :term:`S` variable descriptions. Manually Called Tasks ===================== diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 546c674699..07b5b6f95c 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -9698,6 +9698,11 @@ system and gives an overview of their function and contents. :ref:`ref-classes-insane` class and is only enabled if the recipe inherits the :ref:`ref-classes-autotools` class. + :term:`UNPACKDIR` + This variable, used by the :ref:`ref-classes-base` class, + specifies where fetches sources should be unpacked by the + :ref:`ref-tasks-unpack` task. + :term:`UPDATERCPN` For recipes inheriting the :ref:`ref-classes-update-rc.d` class, :term:`UPDATERCPN` From patchwork Thu May 23 13:56:28 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Michael Opdenacker X-Patchwork-Id: 44090 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 4CA57C41513 for ; Thu, 23 May 2024 13:56:51 +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.17708.1716472604659070553 for ; Thu, 23 May 2024 06:56:45 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@bootlin.com header.s=gm1 header.b=P6wX+IYK; spf=pass (domain: bootlin.com, ip: 217.70.183.200, mailfrom: michael.opdenacker@bootlin.com) Received: by mail.gandi.net (Postfix) with ESMTPSA id AF08E20003; Thu, 23 May 2024 13:56:42 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bootlin.com; s=gm1; t=1716472602; 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=PhuIe6E4U6X8zbqGrpeUZXD9fIFdENKzi+gc6O9L+xw=; b=P6wX+IYKJS7TyUSqMVc00HrYc9jBKY13oFEf833Q5zIVx+Dr4Cjmc5Jhdisg1zNGA3xH0V UTZzjnMTeIFkzgb2zIPXEYgVDEpAdMyv9DblINyYUU0rCLnkspL2WVnsfGWoyvz8Wm3EOj RHnZZODUZe+t7m5sKK8UAUDzTBbFl4Xjr6a3NjHX0hLGkhLt6M62zr4c3UncqC11c2rb7u mtUq7wfi5pmPjG1j9191N4rFBSnFgkyviSU9BvO3ZYt/eN7LUp562zYI6sImggnaGq5HS9 M24oH7i+4LzrvdwMSPwPSSykvkTRzxFfv/1EmkHLVi0v7OsC6PvFOGj51/T9PA== From: michael.opdenacker@bootlin.com To: docs@lists.yoctoproject.org Cc: Michael Opdenacker , Richard Purdie Subject: [PATCH 3/3] migration-5.1.rst: preliminary description of UNPACKDIR changes Date: Thu, 23 May 2024 15:56:28 +0200 Message-Id: <20240523135628.3076018-3-michael.opdenacker@bootlin.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20240523135628.3076018-1-michael.opdenacker@bootlin.com> References: <20240523135628.3076018-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 ; Thu, 23 May 2024 13:56:51 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/docs/message/5245 From: Michael Opdenacker Signed-off-by: Michael Opdenacker Signed-off-by: Richard Purdie --- .../migration-guides/migration-5.1.rst | 55 +++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst index b4db04bcee..84ef35e28a 100644 --- a/documentation/migration-guides/migration-5.1.rst +++ b/documentation/migration-guides/migration-5.1.rst @@ -11,6 +11,61 @@ Project 5.1 Release (codename "styhead") from the prior release. .. _migration-5.1-supported-kernel-versions: +:term:`WORKDIR` changes +~~~~~~~~~~~~~~~~~~~~~~~ + +S = ${WORKDIR} no longer supported +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If a recipe has :term:`S` set to be :term:`WORKDIR`, this is no longer +supported, and an error will be issued. The recipe should be changed to:: + + S = "${WORKDIR}/sources" + UNPACKDIR = "${S}" + +Any :term:`WORKDIR` references where files from :term:`SRC_URI` are referenced +should be changed to :term:`S`. These are commonly in :ref:`ref-tasks-compile`, +:ref:`ref-tasks-compile`, :ref:`ref-tasks-install` and :term:`LIC_FILES_CHKSUM`. + +:term:`WORKDIR` references in recipes +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +:term:`WORKDIR` references in other recipes need auditing. If they reference +files from :term:`SRC_URI`, they likely need changing to :term:`UNPACKDIR`. +These are commonly in :ref:`ref-tasks-compile` and :ref:`ref-tasks-install` +for things like service or configuration files. One unusual case is +``${WORKDIR}/${BP}`` which should probably be set to ``${S}``. + +References to ``../`` in :term:`LIC_FILES_CHKSUM` or elsewhere may need changing +to :term:`UNPACKDIR`. References to :term:`WORKDIR` in ``sed`` commands are +usually left as they are. + +General notes +^^^^^^^^^^^^^ + +Files from :ref:`ref-tasks-unpack` now unpack to ``WORKDIR/sources-unpack/`` +rather than ``WORKDIR/``. + +If :term:`S` is set to a subdirectory under :term:`WORKDIR` and that +subdirectory exists in ``sources-unpack`` after :ref:`ref-tasks-unpack` runs, +it is moved to :term:`WORKDIR`. This means that ``S = "${WORKDIR}/${BP}"``, +``S = "${WORKDIR}/git"`` and also deeper paths continue to work as expected +without changes. We cannot use symlinks to do this as it breaks autotools +based recipes. Keeping all sources under ``sources-unpack`` wasn't considered +as it meant more invasive recipes changes. The key objective was separating the +:ref:`ref-tasks-unpack` task output from :term:`WORKDIR`. + +Previously, :term:`S` was always created but after the recent changes it is no +longer the case. This means the check in ``do_unpack_qa`` triggers where +:term:`S` is not created by a recipe while it didn't happen before. This can +require to add an :term:`S` definition to a recipe that only uses +``file://`` :term:`SRC_URI` entries. Building C files from :term:`UNPACKDIR` +without setting :term:`S` to point at it does not work as the debug prefix +mapping doesn't handle that. + +``devtool`` and ``recipetool`` have been updated to handle this and their +support for ``S = WORKDIR`` and ``oe-local-files`` has been removed. + Supported kernel versions ~~~~~~~~~~~~~~~~~~~~~~~~~