Re: [docs] [yocto-docs PATCH] migration-guides: add placeholder files next release

Quentin Schulz
2024-11-12T17:15:19Z

Hi Antonin,

On 11/12/24 5:52 PM, Antonin Godard via lists.yoctoproject.org wrote:
> Placeholder files for release 5.2 (Walnascar): migration guide and
> release notes.
>
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
> documentation/migration-guides/migration-5.2.rst | 72 ++++++++++++++++++++++
> documentation/migration-guides/release-5.2.rst | 9 +++
> .../migration-guides/release-notes-5.2.rst | 62 +++++++++++++++++++
> 3 files changed, 143 insertions(+)
>
> diff --git a/documentation/migration-guides/migration-5.2.rst b/documentation/migration-guides/migration-5.2.rst
> new file mode 100644
> index 0000000000000000000000000000000000000000..8a077b31f87582e0bcff7ca6fbf6f300c0274e6f
> --- /dev/null
> +++ b/documentation/migration-guides/migration-5.2.rst
> @@ -0,0 +1,72 @@
> +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
> +
> +Release 5.2 (walnascar)
> +=======================
> +
> +Migration notes for 5.2 (walnascar)
> +-----------------------------------
> +
> +This section provides migration information for moving to the Yocto
> +Project 5.2 Release (codename "walnascar") from the prior release.
> +

thought: By updating set_versions.py to include a DISTRO_NAME_MINUS_ONE
in poky.yaml, we could replace "from the prior release" with the name of
the release.

Nothing for this patch though :)

> +.. _migration-5.2-supported-kernel-versions:
> +
> +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.
> +
> +.. _migration-5.2-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 <system-requirements-supported-distros>`.
> +
> +.. _migration-5.2-go-changes:
> +
> +Go language changes
> +~~~~~~~~~~~~~~~~~~~
> +
> +.. _migration-5.2-systemd-changes:
> +
> +systemd changes
> +~~~~~~~~~~~~~~~
> +
> +.. _migration-5.2-recipe-changes:
> +
> +Recipe changes
> +~~~~~~~~~~~~~~
> +
> +.. _migration-5.2-removed-variables:
> +
> +Removed variables
> +~~~~~~~~~~~~~~~~~
> +
> +The following variables have been removed:
> +
> +.. _migration-5.2-removed-recipes:
> +
> +Removed recipes
> +~~~~~~~~~~~~~~~
> +
> +The following recipes have been removed in this release:
> +
> +.. _migration-5.2-removed-classes:
> +
> +Removed classes
> +~~~~~~~~~~~~~~~
> +
> +The following classes have been removed in this release:
> +
> +.. _migration-5.2-misc-changes:
> +
> +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

If this file is always the same, we can make set_versions.py or
something similar generate it.

> 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..a6ba1e01a310111cf9483c74718315286b669821
> --- /dev/null
> +++ b/documentation/migration-guides/release-notes-5.2.rst
> @@ -0,0 +1,62 @@
> +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
> +
> +Release notes for 5.2 (walnascar)
> +---------------------------------
> +
> +New Features / Enhancements in 5.2
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +- Linux kernel 6.XXX, gcc 14.XXX, glibc 2.XXX, LLVM 18.1.XXX, and over 300 other

s/300/XXX/ ?

> + 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 5.2
> +~~~~~~~~~~~~~~~~~~~
> +
> +Recipe License changes in 5.2
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +The following corrections have been made to the :term:`LICENSE` values set by recipes:
> +
> +Security Fixes in 5.2
> +~~~~~~~~~~~~~~~~~~~~~
> +
> +Recipe Upgrades in 5.2
> +~~~~~~~~~~~~~~~~~~~~~~
> +
> +Contributors to 5.2
> +~~~~~~~~~~~~~~~~~~~
> +
> +Repositories / Downloads for Yocto-5.2
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>

thought: use rST substitutions to abstract even more out of this file
(easier to reuse for next next release :) ).

Something like

.. |yocto-ver| replace:: 5.2

somewhere in the file and then

Contributors to |yocto-ver|

maybe?

This probably won't work for replacing text in the label though but we
don't seem to be using those in that file so maybe that's fine.

Not tested.

Looks good aside from the "300" I highlighted above, we probably will
forget about it if we let the number be 300 and not XXX :)

Cheers,
Quentin