diff mbox series

[yocto-docs,v3] migration-guides: add placeholder files for next release

Message ID 20241113-release-note-5-2-placeholders-v3-1-8c7df0ddecd3@bootlin.com
State New
Headers show
Series [yocto-docs,v3] migration-guides: add placeholder files for next release | expand

Commit Message

Antonin Godard Nov. 13, 2024, 2:57 p.m. UTC 
Placeholder files for release 5.2 (Walnascar): migration guide and
release notes.

Define two substitutions |yocto-ver| and |yocto-codename| to avoid
mistakes in the document. Note that anchors cannot contain these so
add a note on that in a comment.

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Changes in v3:
- Remove labels from migration-5.2.rst. We can refer to these with e.g.
  :ref:`migration-guides/migration-X.Y.Z:Supported kernel versions`.
- Link to v2: https://lore.kernel.org/r/20241113-release-note-5-2-placeholders-v2-1-28964033ad77@bootlin.com

Changes in v2:
- Add the missing "release-5.2" document in documentation/migration-guides/index.rst.
- Define |yocto-ver| and |yocto-codename| in
  release-note-5.2/migration-5.2 to re-use in the document (expect
  anchors).
- release-note-5.2: replace "over 300" by "over XXX"
- Link to v1: https://lore.kernel.org/r/20241112-release-note-5-2-placeholders-v1-1-a15b66eae472@bootlin.com
---
 documentation/migration-guides/index.rst           |  1 +
 documentation/migration-guides/migration-5.2.rst   | 59 ++++++++++++++++++++
 documentation/migration-guides/release-5.2.rst     |  9 +++
 .../migration-guides/release-notes-5.2.rst         | 65 ++++++++++++++++++++++
 4 files changed, 134 insertions(+)


---
base-commit: 2849690abf94872e259e712128e90413f3b9a2f2
change-id: 20241112-release-note-5-2-placeholders-1f2bcea5677c

Best regards,
diff mbox series

Patch

diff --git a/documentation/migration-guides/index.rst b/documentation/migration-guides/index.rst
index e9d7f7280931ea6e9b26276ee70a9f9d00004450..14127d56ff397a37e4f36a2e368abcb54eedb8a1 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.2
    release-5.1
    release-5.0
    release-4.3
diff --git a/documentation/migration-guides/migration-5.2.rst b/documentation/migration-guides/migration-5.2.rst
new file mode 100644
index 0000000000000000000000000000000000000000..73d52460fdf2980973da1490f66a274cc5b8494d
--- /dev/null
+++ b/documentation/migration-guides/migration-5.2.rst
@@ -0,0 +1,59 @@ 
+.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
+
+.. |yocto-codename| replace:: walnascar
+.. |yocto-ver| replace:: 5.2
+.. Note: anchors id below cannot contain substitutions so replace them with the
+   value of |yocto-ver| above.
+
+Release |yocto-ver| (|yocto-codename|)
+======================================
+
+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.
+
+Supported kernel versions
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The :term:`OLDEST_KERNEL` setting is XXX in this release, meaning that
+out the box, older kernels are not supported. See :ref:`4.3 migration notes
+<migration-4.3-supported-kernel-versions>` for details.
+
+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 <system-requirements-supported-distros>`.
+
+Go language changes
+~~~~~~~~~~~~~~~~~~~
+
+systemd changes
+~~~~~~~~~~~~~~~
+
+Recipe changes
+~~~~~~~~~~~~~~
+
+Removed variables
+~~~~~~~~~~~~~~~~~
+
+The following variables have been removed:
+
+Removed recipes
+~~~~~~~~~~~~~~~
+
+The following recipes have been removed in this release:
+
+Removed classes
+~~~~~~~~~~~~~~~
+
+The following classes have been removed in this release:
+
+Miscellaneous changes
+~~~~~~~~~~~~~~~~~~~~~
diff --git a/documentation/migration-guides/release-5.2.rst b/documentation/migration-guides/release-5.2.rst
new file mode 100644
index 0000000000000000000000000000000000000000..5c39b99e037e0a84ad6603d22ec4fb4dc2bf96ea
--- /dev/null
+++ b/documentation/migration-guides/release-5.2.rst
@@ -0,0 +1,9 @@ 
+.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
+
+Release 5.2 (walnascar)
+=======================
+
+.. toctree::
+
+   migration-5.2
+   release-notes-5.2
diff --git a/documentation/migration-guides/release-notes-5.2.rst b/documentation/migration-guides/release-notes-5.2.rst
new file mode 100644
index 0000000000000000000000000000000000000000..d03ed7a3b07936fc3c2d15177f350b5507ecb5d4
--- /dev/null
+++ b/documentation/migration-guides/release-notes-5.2.rst
@@ -0,0 +1,65 @@ 
+.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
+
+.. |yocto-codename| replace:: walnascar
+.. |yocto-ver| replace:: 5.2
+
+Release notes for |yocto-ver| (|yocto-codename|)
+------------------------------------------------
+
+New Features / Enhancements in |yocto-ver|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-  Linux kernel 6.XXX, gcc 14.XXX, glibc 2.XXX, LLVM 18.1.XXX, and over XXX other
+   recipe upgrades.
+
+-  New variables:
+
+-  Kernel-related changes:
+
+-  New core recipes:
+
+-  QEMU / ``runqemu`` changes:
+
+-  Go changes:
+
+-  Rust changes:
+
+-  wic Image Creator changes:
+
+-  SDK-related changes:
+
+-  Testing-related changes:
+
+-  Utility script changes:
+
+-  BitBake changes:
+
+-  Packaging changes:
+
+-  Security changes:
+
+-  LLVM related changes:
+
+-  SPDX-related changes:
+
+-  Miscellaneous changes:
+
+Known Issues in |yocto-ver|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Recipe License changes in |yocto-ver|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The following corrections have been made to the :term:`LICENSE` values set by recipes:
+
+Security Fixes in |yocto-ver|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Recipe Upgrades in |yocto-ver|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Contributors to |yocto-ver|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Repositories / Downloads for Yocto-|yocto-ver|
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~