diff options
Diffstat (limited to 'documentation/migration-guides/migration-2.1.rst')
| -rw-r--r-- | documentation/migration-guides/migration-2.1.rst | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst index b2d8a0b678..18b05b52cc 100644 --- a/documentation/migration-guides/migration-2.1.rst +++ b/documentation/migration-guides/migration-2.1.rst @@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + Release 2.1 (krogoth) ===================== @@ -64,7 +66,7 @@ Makefile Environment Changes :term:`EXTRA_OEMAKE` now defaults to "" instead of "-e MAKEFLAGS=". Setting :term:`EXTRA_OEMAKE` to "-e MAKEFLAGS=" by default was a historical accident that has required many classes (e.g. -``autotools``, ``module``) and recipes to override this default in order +:ref:`ref-classes-autotools`, ``module``) and recipes to override this default in order to work with sensible build systems. When upgrading to the release, you must edit any recipe that relies upon this old default by either setting :term:`EXTRA_OEMAKE` back to "-e MAKEFLAGS=" or by explicitly setting any @@ -98,7 +100,7 @@ breaking FHS. ``ac_cv_sizeof_off_t`` is No Longer Cached in Site Files -------------------------------------------------------- -For recipes inheriting the :ref:`autotools <ref-classes-autotools>` +For recipes inheriting the :ref:`ref-classes-autotools` class, ``ac_cv_sizeof_off_t`` is no longer cached in the site files for ``autoconf``. The reason for this change is because the ``ac_cv_sizeof_off_t`` value is not necessarily static per architecture @@ -106,14 +108,14 @@ as was previously assumed. Rather, the value changes based on whether large file support is enabled. For most software that uses ``autoconf``, this change should not be a problem. However, if you have a recipe that bypasses the standard :ref:`ref-tasks-configure` task -from the :ref:`autotools <ref-classes-autotools>` class and the software the recipe is building +from the :ref:`ref-classes-autotools` class and the software the recipe is building uses a very old version of ``autoconf``, the recipe might be incapable -of determining the correct size of ``off_t`` during ``do_configure``. +of determining the correct size of ``off_t`` during :ref:`ref-tasks-configure`. The best course of action is to patch the software as necessary to allow -the default implementation from the :ref:`autotools <ref-classes-autotools>` class to work such +the default implementation from the :ref:`ref-classes-autotools` class to work such that ``autoreconf`` succeeds and produces a working configure script, -and to remove the overridden ``do_configure`` task such that the default +and to remove the overridden :ref:`ref-tasks-configure` task such that the default implementation does get used. .. _migration-2.1-image-generation-split-out-from-filesystem-generation: @@ -128,17 +130,16 @@ separate :ref:`ref-tasks-image` tasks for clarity both in operation and in the code. For most cases, this change does not present any problems. However, if -you have made customizations that directly modify the ``do_rootfs`` task -or that mention ``do_rootfs``, you might need to update those changes. -In particular, if you had added any tasks after ``do_rootfs``, you +you have made customizations that directly modify the :ref:`ref-tasks-rootfs` task +or that mention :ref:`ref-tasks-rootfs`, you might need to update those changes. +In particular, if you had added any tasks after :ref:`ref-tasks-rootfs`, you should make edits so that those tasks are after the :ref:`ref-tasks-image-complete` task rather than -after ``do_rootfs`` so that your added tasks run at the correct +after :ref:`ref-tasks-rootfs` so that your added tasks run at the correct time. -A minor part of this restructuring is that the post-processing -definitions and functions have been moved from the -:ref:`image <ref-classes-image>` class to the +A minor part of this restructuring is that the post-processing definitions and +functions have been moved from the :ref:`ref-classes-image` class to the :ref:`rootfs-postcommands <ref-classes-rootfs*>` class. Functionally, however, they remain unchanged. @@ -189,18 +190,17 @@ Class Changes The following classes have changed: - ``autotools_stage``: Removed because the - :ref:`autotools <ref-classes-autotools>` class now provides its + :ref:`ref-classes-autotools` class now provides its functionality. Recipes that inherited from ``autotools_stage`` should - now inherit from ``autotools`` instead. + now inherit from :ref:`ref-classes-autotools` instead. - ``boot-directdisk``: Merged into the ``image-vm`` class. The ``boot-directdisk`` class was rarely directly used. Consequently, this change should not cause any issues. -- ``bootimg``: Merged into the - :ref:`image-live <ref-classes-image-live>` class. The ``bootimg`` - class was rarely directly used. Consequently, this change should not - cause any issues. +- ``bootimg``: Merged into the :ref:`ref-classes-image-live` class. The + ``bootimg`` class was rarely directly used. Consequently, this change should + not cause any issues. - ``packageinfo``: Removed due to its limited use by the Hob UI, which has itself been removed. @@ -255,14 +255,14 @@ The following changes have been made for the Poky distribution: not need to change anything unless you are relying on this naming elsewhere. -- The :ref:`uninative <ref-classes-uninative>` class is now enabled +- The :ref:`ref-classes-uninative` class is now enabled by default in Poky. This class attempts to isolate the build system from the host distribution's C library and makes re-use of native shared state artifacts across different host distributions practical. With this class enabled, a tarball containing a pre-built C library is downloaded at the start of the build. - The :ref:`uninative <ref-classes-uninative>` class is enabled through the + The :ref:`ref-classes-uninative` class is enabled through the ``meta/conf/distro/include/yocto-uninative.inc`` file, which for those not using the Poky distribution, can include to easily enable the same functionality. @@ -343,7 +343,7 @@ This release supports generation of GLib Introspective Repository (GIR) files through GObject introspection, which is the standard mechanism for accessing GObject-based software from runtime environments. You can enable, disable, and test the generation of this data. See the -":ref:`dev-manual/common-tasks:enabling gobject introspection support`" +":ref:`dev-manual/gobject-introspection:enabling gobject introspection support`" section in the Yocto Project Development Tasks Manual for more information. @@ -356,9 +356,9 @@ These additional changes exist: - The minimum Git version has been increased to 1.8.3.1. If your host distribution does not provide a sufficiently recent version, you can - install the buildtools, which will provide it. See the + install the :term:`buildtools`, which will provide it. See the :ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions` - section for more information on the buildtools tarball. + section for more information on the :term:`buildtools` tarball. - The buggy and incomplete support for the RPM version 4 package manager has been removed. The well-tested and maintained support for @@ -401,9 +401,9 @@ These additional changes exist: as these directories are automatically found and added. - Inaccurate disk and CPU percentage data has been dropped from - ``buildstats`` output. This data has been replaced with + :ref:`ref-classes-buildstats` output. This data has been replaced with ``getrusage()`` data and corrected IO statistics. You will probably - need to update any custom code that reads the ``buildstats`` data. + need to update any custom code that reads the :ref:`ref-classes-buildstats` data. - The ``meta/conf/distro/include/package_regex.inc`` is now deprecated. The contents of this file have been moved to individual recipes. |