diff mbox series

migration-guides/migration,release-notes-5.3.rst: add poky master branch/bitbake-setup changes

Message ID 20251126-update-release-notes-bitbake-setup-v1-1-8c040f91c438@bootlin.com
State New
Headers show
Series migration-guides/migration,release-notes-5.3.rst: add poky master branch/bitbake-setup changes | expand

Commit Message

Antonin Godard Nov. 26, 2025, 4:16 p.m. UTC
Add a note in the migration guide about the deprecation of the poky
repository master branch, give ways to update. Update the release notes
with bitbake-setup and the new poky-manual-setup document.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/migration-guides/migration-5.3.rst   | 28 ++++++++++++++++++++++
 .../migration-guides/release-notes-5.3.rst         | 14 +++++++++++
 2 files changed, 42 insertions(+)


---
base-commit: dba7940543d7d305eda71af18f6626011a3a8d9c
change-id: 20251126-update-release-notes-bitbake-setup-ee769deceff3
diff mbox series

Patch

diff --git a/documentation/migration-guides/migration-5.3.rst b/documentation/migration-guides/migration-5.3.rst
index d3e583808..b17cffe5a 100644
--- a/documentation/migration-guides/migration-5.3.rst
+++ b/documentation/migration-guides/migration-5.3.rst
@@ -14,6 +14,34 @@  Migration notes for |yocto-ver| (|yocto-codename|)
 This section provides migration information for moving to the Yocto
 Project |yocto-ver| Release (codename "|yocto-codename|") from the prior release.
 
+The Poky repository master branch is no longer updated
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The master branch of the :yocto_git:`Poky </poky>` repository is no longer being
+updated. This does *not* mean that the :term:`Poky` distribution is deprecated,
+but that the way to clone the base layers and setup the environment for building
+:term:`Poky` has changed.
+
+You can either:
+
+-  Switch to individual clones of :oe_git:`bitbake </bitbake>`,
+   :oe_git:`openembedded-core </openembedded-core>`, :yocto_git:`meta-yocto
+   </meta-yocto>` and :yocto_git:`yocto-docs </yocto-docs>` by following the
+   :doc:`/dev-manual/poky-manual-setup` section of the Yocto Project Development
+   Tasks Manual.
+
+-  Use the new ``bitbake-setup`` tool by following the
+   :doc:`/brief-yoctoprojectqs/index` document.
+
+   See the :doc:`bitbake:bitbake-user-manual/bitbake-user-manual-environment-setup`
+   of the BitBake User Manual for reference documentation on ``bitbake-setup``.
+
+Releases older than Whinlatter will still have their branch on the Poky
+repository updated until they reach end-of-life.
+
+Some further information on the background of this change can be found
+in: https://lists.openembedded.org/g/openembedded-architecture/message/2179
+
 :term:`WORKDIR` changes
 ~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/documentation/migration-guides/release-notes-5.3.rst b/documentation/migration-guides/release-notes-5.3.rst
index 5cd875e9b..b3a96c2d9 100644
--- a/documentation/migration-guides/release-notes-5.3.rst
+++ b/documentation/migration-guides/release-notes-5.3.rst
@@ -29,6 +29,14 @@  New Features / Enhancements in |yocto-ver|
 
 -  BitBake changes:
 
+   -  A new ``bitbake-setup`` tool can be used to clone the initial layers and
+      setup the environment. See the :doc:`/brief-yoctoprojectqs/index` section
+      for instructions on how to build an image that uses the :term:`Poky`
+      distribution with this new tool.
+
+      See the reference documentation of ``bitbake-setup`` at
+      :doc:`bitbake:bitbake-user-manual/bitbake-user-manual-environment-setup`.
+
    -  ``codeparser``: Add function decorators for ``vardeps``
 
       Adds ``bb.parse.vardeps`` and ``bb.parse.excludevardeps`` function
@@ -473,6 +481,12 @@  New Features / Enhancements in |yocto-ver|
    -  The QA checks defined in the :term:`OpenEmbedded Build System` were
       gathered in :doc:`/ref-manual/qa-checks`.
 
+   -  A new :doc:`/dev-manual/poky-manual-setup` document was added to instruct
+      how to setup the :term:`Poky` reference distribution manually, after the
+      :ref:`master branch of the Poky repository has stopped being updated
+      <migration-guides/migration-5.3:The Poky repository master branch is no
+      longer updated>`.
+
 -  Core library changes:
 
    -  Add :oe_git:`license_finder.py </openembedded-core/tree/meta/lib/oe/license_finder.py>`,