[PATCH] manuals: prepare 4.2 migration notes

[PATCH] manuals: prepare 4.2 migration notes

[michael.opdenacker]

From: Michael Opdenacker <michael.opdenacker@bootlin.com>

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 documentation/migration-guides/index.rst      |  1 +
 .../migration-guides/migration-4.2.rst        | 48 +++++++++++++++++++
 .../migration-guides/release-4.2.rst          |  9 ++++
 .../migration-guides/release-notes-4.2.rst    | 28 +++++++++++
 4 files changed, 86 insertions(+)
 create mode 100644 documentation/migration-guides/migration-4.2.rst
 create mode 100644 documentation/migration-guides/release-4.2.rst
 create mode 100644 documentation/migration-guides/release-notes-4.2.rst

diff --git a/documentation/migration-guides/index.rst b/documentation/migration-guides/index.rst
index ce0ca8c659..6f7bcbef29 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-4.2
    release-4.1
    release-4.0
    release-3.4
diff --git a/documentation/migration-guides/migration-4.2.rst b/documentation/migration-guides/migration-4.2.rst
new file mode 100644
index 0000000000..944ad31a4c
--- /dev/null
+++ b/documentation/migration-guides/migration-4.2.rst
@@ -0,0 +1,48 @@
+.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
+
+Release 4.2 (mickledore)
+========================
+
+Migration notes for 4.2 (mickledore)
+------------------------------------
+
+This section provides migration information for moving to the Yocto
+Project 4.2 Release (codename "mickledore") from the prior release.
+
+.. _migration-4.2-python-3.8:
+
+Python 3.8 is now the minimum required Python version version
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~------------
+
+BitBake and OpenEmbedded-Core are now relying on Python 3.8,
+making it a requirement to use a distribution providing at least this
+version, or to use :term:`buildtools`.
+
+.. _migration-4.2-qa-checks:
+
+QA check changes
+~~~~~~~~~~~~~~~~
+
+.. _migration-4.2-misc-changes:
+
+Miscellaneous changes
+~~~~~~~~~~~~~~~~~~~~~
+
+- The ``OEBasic`` signature handler (see :term:`BB_SIGNATURE_HANDLER`) has been
+  removed.
+
+.. _migration-4.2-removed-variables:
+
+Removed variables
+~~~~~~~~~~~~~~~~~
+
+The following variables have been removed:
+- ``SERIAL_CONSOLE``, deprecated since version 2.6, replaced by :term:``SERIAL_CONSOLES``.
+
+.. _migration-4.2-removed-recipes:
+
+Removed recipes
+~~~~~~~~~~~~~~~
+
+The following recipes have been removed in this release:
+
diff --git a/documentation/migration-guides/release-4.2.rst b/documentation/migration-guides/release-4.2.rst
new file mode 100644
index 0000000000..ae52d939c8
--- /dev/null
+++ b/documentation/migration-guides/release-4.2.rst
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
+
+Release 4.2 (mickledore)
+========================
+
+.. toctree::
+
+   migration-4.2
+   release-notes-4.2
diff --git a/documentation/migration-guides/release-notes-4.2.rst b/documentation/migration-guides/release-notes-4.2.rst
new file mode 100644
index 0000000000..f3d69d98cc
--- /dev/null
+++ b/documentation/migration-guides/release-notes-4.2.rst
@@ -0,0 +1,28 @@
+.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
+
+Release notes for 4.2 (mickledore)
+---------------------------------
+
+New Features / Enhancements in 4.2
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Python 3.8 s the minimum Python version required on the build host.
+  For host distros that do not provide it, this is included as part of the
+  :term:`buildtools` tarball.
+
+- This release now supports a new ``addpylib`` directive to enable
+  Python libraries within layers.
+
+  This directive should be added to your layer configuration,
+  as in the below example from ``meta/conf/layer.conf``::
+
+     addpylib ${LAYERDIR}/lib oe
+
+-  Architecture-specific enhancements:
+
+-  Kernel-related enhancements:
+
+-  QEMU/runqemu enhancements:
+
+-  Image-related enhancements:
+
-- 
2.37.2

Re: [docs] [PATCH] manuals: prepare 4.2 migration notes

[Quentin Schulz]

Hi Michael,

On 12/16/22 11:12, Michael Opdenacker via lists.yoctoproject.org wrote:
> From: Michael Opdenacker <michael.opdenacker@bootlin.com>
> 
> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>   documentation/migration-guides/index.rst      |  1 +
>   .../migration-guides/migration-4.2.rst        | 48 +++++++++++++++++++
>   .../migration-guides/release-4.2.rst          |  9 ++++
>   .../migration-guides/release-notes-4.2.rst    | 28 +++++++++++
>   4 files changed, 86 insertions(+)
>   create mode 100644 documentation/migration-guides/migration-4.2.rst
>   create mode 100644 documentation/migration-guides/release-4.2.rst
>   create mode 100644 documentation/migration-guides/release-notes-4.2.rst
> 
> diff --git a/documentation/migration-guides/index.rst b/documentation/migration-guides/index.rst
> index ce0ca8c659..6f7bcbef29 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-4.2
>      release-4.1
>      release-4.0
>      release-3.4
> diff --git a/documentation/migration-guides/migration-4.2.rst b/documentation/migration-guides/migration-4.2.rst
> new file mode 100644
> index 0000000000..944ad31a4c
> --- /dev/null
> +++ b/documentation/migration-guides/migration-4.2.rst
> @@ -0,0 +1,48 @@
> +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
> +
> +Release 4.2 (mickledore)
> +========================
> +
> +Migration notes for 4.2 (mickledore)
> +------------------------------------
> +
> +This section provides migration information for moving to the Yocto
> +Project 4.2 Release (codename "mickledore") from the prior release.
> +
> +.. _migration-4.2-python-3.8:
> +
> +Python 3.8 is now the minimum required Python version version
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~------------
> +
> +BitBake and OpenEmbedded-Core are now relying on Python 3.8,
> +making it a requirement to use a distribution providing at least this
> +version, or to use :term:`buildtools`.
> +
> +.. _migration-4.2-qa-checks:
> +
> +QA check changes
> +~~~~~~~~~~~~~~~~
> +
> +.. _migration-4.2-misc-changes:
> +
> +Miscellaneous changes
> +~~~~~~~~~~~~~~~~~~~~~
> +
> +- The ``OEBasic`` signature handler (see :term:`BB_SIGNATURE_HANDLER`) has been
> +  removed.
> +
> +.. _migration-4.2-removed-variables:
> +
> +Removed variables
> +~~~~~~~~~~~~~~~~~
> +
> +The following variables have been removed:
> +- ``SERIAL_CONSOLE``, deprecated since version 2.6, replaced by :term:``SERIAL_CONSOLES``.
> +
> +.. _migration-4.2-removed-recipes:
> +
> +Removed recipes
> +~~~~~~~~~~~~~~~
> +
> +The following recipes have been removed in this release:
> +
> diff --git a/documentation/migration-guides/release-4.2.rst b/documentation/migration-guides/release-4.2.rst
> new file mode 100644
> index 0000000000..ae52d939c8
> --- /dev/null
> +++ b/documentation/migration-guides/release-4.2.rst
> @@ -0,0 +1,9 @@
> +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
> +
> +Release 4.2 (mickledore)
> +========================
> +
> +.. toctree::
> +
> +   migration-4.2
> +   release-notes-4.2
> diff --git a/documentation/migration-guides/release-notes-4.2.rst b/documentation/migration-guides/release-notes-4.2.rst
> new file mode 100644
> index 0000000000..f3d69d98cc
> --- /dev/null
> +++ b/documentation/migration-guides/release-notes-4.2.rst
> @@ -0,0 +1,28 @@
> +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
> +
> +Release notes for 4.2 (mickledore)
> +---------------------------------
> +
> +New Features / Enhancements in 4.2
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +- Python 3.8 s the minimum Python version required on the build host.

s/s/is/

> +  For host distros that do not provide it, this is included as part of the

s/distros/distributions/

> +  :term:`buildtools` tarball.
> +
> +- This release now supports a new ``addpylib`` directive to enable
> +  Python libraries within layers.
> +

I think it's worth saying a few more words here if we don't already have 
some explanations elsewhere in the docs.

When should I use this?

IIRC, it's when you want to use some function in some configuration file 
(where one cannot define functions?) or put things in common in recipes 
without using a class to define this new function. Is there another 
usecase I haven't thought about?

Anyways, this can be improved over time :)

Cheers,
Quentin

Re: [docs] [PATCH] manuals: prepare 4.2 migration notes

[Michael Opdenacker]

Hi Quentin,

Thanks for the review!

Am 16.12.22 um 11:27 schrieb Quentin Schulz via lists.yoctoproject.org:
>
>> +++ b/documentation/migration-guides/release-notes-4.2.rst
>> @@ -0,0 +1,28 @@
>> +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
>> +
>> +Release notes for 4.2 (mickledore)
>> +---------------------------------
>> +
>> +New Features / Enhancements in 4.2
>> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>> +
>> +- Python 3.8 s the minimum Python version required on the build host.
>
> s/s/is/
>
>> +  For host distros that do not provide it, this is included as part 
>> of the
>
> s/distros/distributions/


Fixed.

>
>> +  :term:`buildtools` tarball.
>> +
>> +- This release now supports a new ``addpylib`` directive to enable
>> +  Python libraries within layers.
>> +
>
> I think it's worth saying a few more words here if we don't already 
> have some explanations elsewhere in the docs.
>
> When should I use this?
>
> IIRC, it's when you want to use some function in some configuration 
> file (where one cannot define functions?) or put things in common in 
> recipes without using a class to define this new function. Is there 
> another usecase I haven't thought about?
>
> Anyways, this can be improved over time :)


Sure, this was just a placeholder and I hope people would provide more 
details. Indeed, this should also be added to the documentation.

Thanks again,

Cheers
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com