diff mbox series

[8/9] migration: Extend migration guide for 5.0

Message ID 72a076d449b48273a557dc3ebe3dde9ea11e70d2.1713127068.git.bluelightning@bluelightning.org
State New
Headers show
Series [1/9] ref-manual: Add virtual-slash QA check | expand

Commit Message

Paul Eggleton April 14, 2024, 8:43 p.m. UTC
Add a few missing entries based upon combing through the release
commits, as well as minor tweaks to existing items.

Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
---
 .../migration-guides/migration-5.0.rst        | 62 ++++++++++++++++---
 1 file changed, 54 insertions(+), 8 deletions(-)

Comments

Michael Opdenacker April 15, 2024, 2:41 p.m. UTC | #1
On 4/14/24 at 22:43, Paul Eggleton wrote:
> +ipk packaging changes
> +~~~~~~~~~~~~~~~~~~~~~
> +
> +ipk packaging (using ``opkg``) now uses ``zstd`` compression instead of ``xz``
> +for better compression and performance. This does mean that .ipk packages
> +built using the 5.0 release requires opkg built with zstd enabled - naturally
> +this is the case in 5.0, but at least by default these packages will not be
> +usable on older systems where opkg does not have zstd enabled at build time.
> +
> +Additionally, the internal dependency solver in opkg is now deprecated - it
> +is still available in this release but will trigger a warning if selected.
> +The default has been the external ``libsolv`` solver for some time, but if you
> +have explicitly removed that from :term:`PACKAGECONFIG` for ``opkg`` to
> +select the internal solver, you should plan to switch to ``libsolv`` in the
> +near future (by including ``libsolv`` your custom :term:`PACKAGECONFIG` value
> +for ``opkg``, or reverting to the default value).
> +

Here I replaced a few instances of "``opkg``" and "opkg" by "Opkg", 
which is the project name.
> +
>   .. _migration-5.0-misc-changes:
>   
>   Miscellaneous changes
>   ~~~~~~~~~~~~~~~~~~~~~
>   
> --  ``bitbake-whatchanged`` script was removed.
> +-  ``bitbake-whatchanged`` script was removed as it was broken and unmaintained.
> +-  ``scripts/sstate-cache-management.sh`` has been replaced by ``scripts/sstate-cache-management.py``, a more performant Python-based version.
> +-  The ``bmap-tools`` recipe has been renamed to ``bmaptool``.
> +-  ``gpgme`` has had Python binding support disabled since upstream does not yet support Python 3.12. (This will be fixed in future once it is fixed upstream.)
> +-  A warning will now be shown if the ``virtual/`` prefix is used in runtime contexts (:term:`RDEPENDS` / :term:`RPROVIDES`) - see :ref:`virtual-slash <qa-check-virtual-slash>` for details.
> +-  ``recipetool`` now prefixes the names of recipes created for Python modules with "python3-".
> +-  The :ref:`ref-classes-cve-check` class no longer produces a warning for remote patches - it only logs a note and does not try to fetch the patch in order to scan it for issues or CVE numbers. However, CVE number references in remote patch file names will now be picked up.
> +-  The values of :term:`PE` and :term:`PR` have been dropped from -f{file,macro,debug}-prefix-map, in order to avoid unnecessary churn in debug symbol paths when the version is bumped. This is unlikely to cause issues, but if you are paying attention to the debug source path (e.g. in recipes that need to manipulate these files during packaging) then you will notice the difference. A new :term:`TARGET_DBGSRC_DIR` variable is provided to make this easier.
>   -  ``ccache`` no longer supports FORTRAN.

I made a few formatting changes to this part, but that's no big deal :)
Thanks
Michael.
diff mbox series

Patch

diff --git a/documentation/migration-guides/migration-5.0.rst b/documentation/migration-guides/migration-5.0.rst
index 888a1c60d4..951d86547b 100644
--- a/documentation/migration-guides/migration-5.0.rst
+++ b/documentation/migration-guides/migration-5.0.rst
@@ -80,7 +80,8 @@  Recipe changes
 Deprecated variables
 ~~~~~~~~~~~~~~~~~~~~
 
-No variables have been deprecated in this release.
+-  ``CVE_CHECK_IGNORE`` should be replaced with :term:`CVE_STATUS`
+
 
 .. _migration-5.0-removed-variables:
 
@@ -89,13 +90,14 @@  Removed variables
 
 The following variables have been removed:
 
--  ``DEPLOY_DIR_TAR``.
--  ``PYTHON_PN``: Python 2 has been removed, leaving Python 3 as the sole
-   major version. Therefore, an abstraction to differentiate both versions is
+-  ``DEPLOY_DIR_TAR``: no longer needed since the package_tar class was removed in 4.2.
+-  ``PYTHON_PN``: Python 2 has previously been removed, leaving Python 3 as the sole
+   major version. Therefore, this abstraction to differentiate both versions is
    no longer needed.
--  ``oldincludedir``.
+-  ``oldincludedir``
 -  ``USE_L10N``: previously deprecated, and now removed.
--  ``CVE_SOCKET_TIMEOUT``.
+-  ``CVE_SOCKET_TIMEOUT``
+-  ``SERIAL_CONSOLES_CHECK`` - use :term:`SERIAL_CONSOLES` instead as all consoles specified in the latter are checked for their existence before a ``getty`` is started.
 
 .. _migration-5.0-removed-recipes:
 
@@ -105,9 +107,10 @@  Removed recipes
 The following recipes have been removed in this release:
 
 -  ``libcroco``: deprecated and archived by the Gnome Project.
+-  ``liberror-perl``: unmaintained and no longer needed - moved to meta-perl.
 -  ``linux-yocto``: version 6.1 (version 6.6 provided instead).
--  ``zvariant``: fails to build with newer Rust.
 -  ``systemtap-uprobes``: obsolete.
+-  ``zvariant``: fails to build with newer Rust.
 
 .. _migration-5.0-removed-classes:
 
@@ -125,10 +128,53 @@  In ``tune-core2``, the cpu models ``n270`` and ``core2duo`` are no longer
 passed to QEMU, since its documentation recommends not using them with ``-cpu``
 option. Therefore, from now on, ``Nehalem`` model is used instead.
 
+
+ipk packaging changes
+~~~~~~~~~~~~~~~~~~~~~
+
+ipk packaging (using ``opkg``) now uses ``zstd`` compression instead of ``xz``
+for better compression and performance. This does mean that .ipk packages
+built using the 5.0 release requires opkg built with zstd enabled - naturally
+this is the case in 5.0, but at least by default these packages will not be
+usable on older systems where opkg does not have zstd enabled at build time.
+
+Additionally, the internal dependency solver in opkg is now deprecated - it
+is still available in this release but will trigger a warning if selected.
+The default has been the external ``libsolv`` solver for some time, but if you
+have explicitly removed that from :term:`PACKAGECONFIG` for ``opkg`` to
+select the internal solver, you should plan to switch to ``libsolv`` in the
+near future (by including ``libsolv`` your custom :term:`PACKAGECONFIG` value
+for ``opkg``, or reverting to the default value).
+
+
+motd message when using ``DISTRO = "poky"``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The default ``poky`` :term:`DISTRO` is explicitly a *reference* distribution
+for testing and development purposes.  It enables most hardware and software
+features so that they can be tested, but this also means that
+from a security point of view the attack surface is very large.
+
+We encourage anyone using the Yocto Project for production use to create
+their own distribution and not use Poky. To encourage this behaviour
+further, in 5.0 a warning has been added to ``/etc/motd`` when Poky is used
+so that the developer will see it when they log in. If you are creating your
+own distribution this message will not show up.
+
+For information on how to create your own distribution, see
+":ref:`dev-manual/custom-distribution:creating your own distribution`".
+
 .. _migration-5.0-misc-changes:
 
 Miscellaneous changes
 ~~~~~~~~~~~~~~~~~~~~~
 
--  ``bitbake-whatchanged`` script was removed.
+-  ``bitbake-whatchanged`` script was removed as it was broken and unmaintained.
+-  ``scripts/sstate-cache-management.sh`` has been replaced by ``scripts/sstate-cache-management.py``, a more performant Python-based version.
+-  The ``bmap-tools`` recipe has been renamed to ``bmaptool``.
+-  ``gpgme`` has had Python binding support disabled since upstream does not yet support Python 3.12. (This will be fixed in future once it is fixed upstream.)
+-  A warning will now be shown if the ``virtual/`` prefix is used in runtime contexts (:term:`RDEPENDS` / :term:`RPROVIDES`) - see :ref:`virtual-slash <qa-check-virtual-slash>` for details.
+-  ``recipetool`` now prefixes the names of recipes created for Python modules with "python3-".
+-  The :ref:`ref-classes-cve-check` class no longer produces a warning for remote patches - it only logs a note and does not try to fetch the patch in order to scan it for issues or CVE numbers. However, CVE number references in remote patch file names will now be picked up.
+-  The values of :term:`PE` and :term:`PR` have been dropped from -f{file,macro,debug}-prefix-map, in order to avoid unnecessary churn in debug symbol paths when the version is bumped. This is unlikely to cause issues, but if you are paying attention to the debug source path (e.g. in recipes that need to manipulate these files during packaging) then you will notice the difference. A new :term:`TARGET_DBGSRC_DIR` variable is provided to make this easier.
 -  ``ccache`` no longer supports FORTRAN.