diff options
Diffstat (limited to 'documentation/migration-guides')
| -rw-r--r-- | documentation/migration-guides/migration-1.6.rst | 26 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-3.0.rst | 4 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-3.1.rst | 2 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-3.2.rst | 18 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-3.3.rst | 3 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-3.4.rst | 4 | ||||
| -rw-r--r-- | documentation/migration-guides/release-notes-3.4.rst | 2 |
7 files changed, 29 insertions, 30 deletions
diff --git a/documentation/migration-guides/migration-1.6.rst b/documentation/migration-guides/migration-1.6.rst index 358086560b..f54d4ba729 100644 --- a/documentation/migration-guides/migration-1.6.rst +++ b/documentation/migration-guides/migration-1.6.rst | |||
| @@ -341,39 +341,39 @@ Removed and Renamed Recipes | |||
| 341 | 341 | ||
| 342 | The following recipes have been removed: | 342 | The following recipes have been removed: |
| 343 | 343 | ||
| 344 | - ``packagegroup-toolset-native`` - This recipe is largely unused. | 344 | - ``packagegroup-toolset-native`` --- this recipe is largely unused. |
| 345 | 345 | ||
| 346 | - ``linux-yocto-3.8`` - Support for the Linux yocto 3.8 kernel has been | 346 | - ``linux-yocto-3.8`` --- support for the Linux yocto 3.8 kernel has been |
| 347 | dropped. Support for the 3.10 and 3.14 kernels have been added with | 347 | dropped. Support for the 3.10 and 3.14 kernels have been added with |
| 348 | the ``linux-yocto-3.10`` and ``linux-yocto-3.14`` recipes. | 348 | the ``linux-yocto-3.10`` and ``linux-yocto-3.14`` recipes. |
| 349 | 349 | ||
| 350 | - ``ocf-linux`` - This recipe has been functionally replaced using | 350 | - ``ocf-linux`` --- this recipe has been functionally replaced using |
| 351 | ``cryptodev-linux``. | 351 | ``cryptodev-linux``. |
| 352 | 352 | ||
| 353 | - ``genext2fs`` - ``genext2fs`` is no longer used by the build system | 353 | - ``genext2fs`` --- ``genext2fs`` is no longer used by the build system |
| 354 | and is unmaintained upstream. | 354 | and is unmaintained upstream. |
| 355 | 355 | ||
| 356 | - ``js`` - This provided an ancient version of Mozilla's javascript | 356 | - ``js`` --- this provided an ancient version of Mozilla's javascript |
| 357 | engine that is no longer needed. | 357 | engine that is no longer needed. |
| 358 | 358 | ||
| 359 | - ``zaurusd`` - The recipe has been moved to the ``meta-handheld`` | 359 | - ``zaurusd`` --- the recipe has been moved to the ``meta-handheld`` |
| 360 | layer. | 360 | layer. |
| 361 | 361 | ||
| 362 | - ``eglibc 2.17`` - Replaced by the ``eglibc 2.19`` recipe. | 362 | - ``eglibc 2.17`` --- replaced by the ``eglibc 2.19`` recipe. |
| 363 | 363 | ||
| 364 | - ``gcc 4.7.2`` - Replaced by the now stable ``gcc 4.8.2``. | 364 | - ``gcc 4.7.2`` --- replaced by the now stable ``gcc 4.8.2``. |
| 365 | 365 | ||
| 366 | - ``external-sourcery-toolchain`` - this recipe is now maintained in | 366 | - ``external-sourcery-toolchain`` --- this recipe is now maintained in |
| 367 | the ``meta-sourcery`` layer. | 367 | the ``meta-sourcery`` layer. |
| 368 | 368 | ||
| 369 | - ``linux-libc-headers-yocto 3.4+git`` - Now using version 3.10 of the | 369 | - ``linux-libc-headers-yocto 3.4+git`` --- now using version 3.10 of the |
| 370 | ``linux-libc-headers`` by default. | 370 | ``linux-libc-headers`` by default. |
| 371 | 371 | ||
| 372 | - ``meta-toolchain-gmae`` - This recipe is obsolete. | 372 | - ``meta-toolchain-gmae`` --- this recipe is obsolete. |
| 373 | 373 | ||
| 374 | - ``packagegroup-core-sdk-gmae`` - This recipe is obsolete. | 374 | - ``packagegroup-core-sdk-gmae`` --- this recipe is obsolete. |
| 375 | 375 | ||
| 376 | - ``packagegroup-core-standalone-gmae-sdk-target`` - This recipe is | 376 | - ``packagegroup-core-standalone-gmae-sdk-target`` --- this recipe is |
| 377 | obsolete. | 377 | obsolete. |
| 378 | 378 | ||
| 379 | .. _migration-1.6-removed-classes: | 379 | .. _migration-1.6-removed-classes: |
diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst index 1219edf921..96aea2f332 100644 --- a/documentation/migration-guides/migration-3.0.rst +++ b/documentation/migration-guides/migration-3.0.rst | |||
| @@ -216,11 +216,11 @@ The following sanity check changes occurred. | |||
| 216 | - :term:`SRC_URI` is now checked for usage of two | 216 | - :term:`SRC_URI` is now checked for usage of two |
| 217 | problematic items: | 217 | problematic items: |
| 218 | 218 | ||
| 219 | - "${PN}" prefix/suffix use - Warnings always appear if ${PN} is | 219 | - "${PN}" prefix/suffix use --- warnings always appear if ${PN} is |
| 220 | used. You must fix the issue regardless of whether multiconfig or | 220 | used. You must fix the issue regardless of whether multiconfig or |
| 221 | anything else that would cause prefixing/suffixing to happen. | 221 | anything else that would cause prefixing/suffixing to happen. |
| 222 | 222 | ||
| 223 | - Github archive tarballs - these are not guaranteed to be stable. | 223 | - Github archive tarballs --- these are not guaranteed to be stable. |
| 224 | Consequently, it is likely that the tarballs will be refreshed and | 224 | Consequently, it is likely that the tarballs will be refreshed and |
| 225 | thus the SRC_URI checksums will fail to apply. It is recommended | 225 | thus the SRC_URI checksums will fail to apply. It is recommended |
| 226 | that you fetch either an official release tarball or a specific | 226 | that you fetch either an official release tarball or a specific |
diff --git a/documentation/migration-guides/migration-3.1.rst b/documentation/migration-guides/migration-3.1.rst index e3fdbbe425..cc788efeba 100644 --- a/documentation/migration-guides/migration-3.1.rst +++ b/documentation/migration-guides/migration-3.1.rst | |||
| @@ -200,7 +200,7 @@ Packaging changes | |||
| 200 | ----------------- | 200 | ----------------- |
| 201 | 201 | ||
| 202 | - ``intltool`` has been removed from ``packagegroup-core-sdk`` as it is | 202 | - ``intltool`` has been removed from ``packagegroup-core-sdk`` as it is |
| 203 | rarely needed to build modern software - gettext can do most of the | 203 | rarely needed to build modern software --- gettext can do most of the |
| 204 | things it used to be needed for. ``intltool`` has also been removed | 204 | things it used to be needed for. ``intltool`` has also been removed |
| 205 | from ``packagegroup-core-self-hosted`` as it is not needed to for | 205 | from ``packagegroup-core-self-hosted`` as it is not needed to for |
| 206 | standard builds. | 206 | standard builds. |
diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index a376eced52..92b7f91f2c 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst | |||
| @@ -23,7 +23,7 @@ Removed recipes | |||
| 23 | The following recipes have been removed: | 23 | The following recipes have been removed: |
| 24 | 24 | ||
| 25 | - ``bjam-native``: replaced by ``boost-build-native`` | 25 | - ``bjam-native``: replaced by ``boost-build-native`` |
| 26 | - ``avahi-ui``: folded into the main ``avahi`` recipe - the GTK UI can be disabled using :term:`PACKAGECONFIG` for ``avahi``. | 26 | - ``avahi-ui``: folded into the main ``avahi`` recipe --- the GTK UI can be disabled using :term:`PACKAGECONFIG` for ``avahi``. |
| 27 | - ``build-compare``: no longer needed with the removal of the ``packagefeed-stability`` class | 27 | - ``build-compare``: no longer needed with the removal of the ``packagefeed-stability`` class |
| 28 | - ``dhcp``: obsolete, functionally replaced by ``dhcpcd`` and ``kea`` | 28 | - ``dhcp``: obsolete, functionally replaced by ``dhcpcd`` and ``kea`` |
| 29 | - ``libmodulemd-v1``: replaced by ``libmodulemd`` | 29 | - ``libmodulemd-v1``: replaced by ``libmodulemd`` |
| @@ -37,7 +37,7 @@ Removed classes | |||
| 37 | 37 | ||
| 38 | The following classes (.bbclass files) have been removed: | 38 | The following classes (.bbclass files) have been removed: |
| 39 | 39 | ||
| 40 | - ``spdx``: obsolete - the Yocto Project is a strong supporter of SPDX, but this class was old code using a dated approach and had the potential to be misleading. The ``meta-sdpxscanner`` layer is a much more modern and active approach to handling this and is recommended as a replacement. | 40 | - ``spdx``: obsolete --- the Yocto Project is a strong supporter of SPDX, but this class was old code using a dated approach and had the potential to be misleading. The ``meta-sdpxscanner`` layer is a much more modern and active approach to handling this and is recommended as a replacement. |
| 41 | 41 | ||
| 42 | - ``packagefeed-stability``: this class had become obsolete with the advent of hash equivalence and reproducible builds. | 42 | - ``packagefeed-stability``: this class had become obsolete with the advent of hash equivalence and reproducible builds. |
| 43 | 43 | ||
| @@ -46,7 +46,7 @@ pseudo path filtering and mismatch behaviour | |||
| 46 | -------------------------------------------- | 46 | -------------------------------------------- |
| 47 | 47 | ||
| 48 | pseudo now operates on a filtered subset of files. This is a significant change | 48 | pseudo now operates on a filtered subset of files. This is a significant change |
| 49 | to the way pseudo operates within OpenEmbedded - by default, pseudo monitors and | 49 | to the way pseudo operates within OpenEmbedded --- by default, pseudo monitors and |
| 50 | logs (adds to its database) any file created or modified whilst in a ``fakeroot`` | 50 | logs (adds to its database) any file created or modified whilst in a ``fakeroot`` |
| 51 | environment. However, there are large numbers of files that we simply don't care | 51 | environment. However, there are large numbers of files that we simply don't care |
| 52 | about the permissions of whilst in that ``fakeroot`` context, for example ${:term:`S`}, ${:term:`B`}, ${:term:`T`}, | 52 | about the permissions of whilst in that ``fakeroot`` context, for example ${:term:`S`}, ${:term:`B`}, ${:term:`T`}, |
| @@ -68,7 +68,7 @@ structure above that subdirectory. For these types of cases in your own recipes, | |||
| 68 | extend :term:`PSEUDO_IGNORE_PATHS` to cover additional paths that pseudo should not | 68 | extend :term:`PSEUDO_IGNORE_PATHS` to cover additional paths that pseudo should not |
| 69 | be monitoring. | 69 | be monitoring. |
| 70 | 70 | ||
| 71 | In addition, pseudo's behaviour on mismatches has now been changed - rather | 71 | In addition, pseudo's behaviour on mismatches has now been changed --- rather |
| 72 | than doing what turns out to be a rather dangerous "fixup" if it sees a file | 72 | than doing what turns out to be a rather dangerous "fixup" if it sees a file |
| 73 | with a different path but the same inode as another file it has previously seen, | 73 | with a different path but the same inode as another file it has previously seen, |
| 74 | pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </Pseudo_Abort>` | 74 | pseudo will throw an ``abort()`` and direct you to a :yocto_wiki:`wiki page </Pseudo_Abort>` |
| @@ -137,10 +137,10 @@ DHCP server/client replaced | |||
| 137 | 137 | ||
| 138 | The ``dhcp`` software package has become unmaintained and thus has been | 138 | The ``dhcp`` software package has become unmaintained and thus has been |
| 139 | functionally replaced by ``dhcpcd`` (client) and ``kea`` (server). You will | 139 | functionally replaced by ``dhcpcd`` (client) and ``kea`` (server). You will |
| 140 | need to replace references to the recipe/package names as appropriate - most | 140 | need to replace references to the recipe/package names as appropriate --- most |
| 141 | commonly, at the package level ``dhcp-client`` should be replaced by | 141 | commonly, at the package level ``dhcp-client`` should be replaced by |
| 142 | ``dhcpcd`` and ``dhcp-server`` should be replaced by ``kea``. If you have any | 142 | ``dhcpcd`` and ``dhcp-server`` should be replaced by ``kea``. If you have any |
| 143 | custom configuration files for these they will need to be adapted - refer to | 143 | custom configuration files for these they will need to be adapted --- refer to |
| 144 | the upstream documentation for ``dhcpcd`` and ``kea`` for further details. | 144 | the upstream documentation for ``dhcpcd`` and ``kea`` for further details. |
| 145 | 145 | ||
| 146 | 146 | ||
| @@ -181,7 +181,7 @@ In addition, the following new checks were added and default to triggering an er | |||
| 181 | 181 | ||
| 182 | - :ref:`missing-update-alternatives <qa-check-missing-update-alternatives>`: Check if the recipe sets the :term:`ALTERNATIVE` variable for any of its packages, and does not inherit the :ref:`update-alternatives <ref-classes-update-alternatives>` class. | 182 | - :ref:`missing-update-alternatives <qa-check-missing-update-alternatives>`: Check if the recipe sets the :term:`ALTERNATIVE` variable for any of its packages, and does not inherit the :ref:`update-alternatives <ref-classes-update-alternatives>` class. |
| 183 | 183 | ||
| 184 | - A trailing slash or duplicated slashes in the value of :term:`S` or :term:`B` will now trigger a warning so that they can be removed and path comparisons can be more reliable - remove any instances of these in your recipes if the warning is displayed. | 184 | - A trailing slash or duplicated slashes in the value of :term:`S` or :term:`B` will now trigger a warning so that they can be removed and path comparisons can be more reliable --- remove any instances of these in your recipes if the warning is displayed. |
| 185 | 185 | ||
| 186 | 186 | ||
| 187 | .. _migration-3.2-src-uri-file-globbing: | 187 | .. _migration-3.2-src-uri-file-globbing: |
| @@ -209,7 +209,7 @@ deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` | |||
| 209 | 209 | ||
| 210 | ``do_deploy`` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as ``do_install`` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. | 210 | ``do_deploy`` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as ``do_install`` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. |
| 211 | 211 | ||
| 212 | Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` - these should be refactored to use ``do_deploy_prepend`` instead. | 212 | Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` --- these should be refactored to use ``do_deploy_prepend`` instead. |
| 213 | 213 | ||
| 214 | 214 | ||
| 215 | .. _migration-3.2-nativesdk-sdk-provides-dummy: | 215 | .. _migration-3.2-nativesdk-sdk-provides-dummy: |
| @@ -303,7 +303,7 @@ now need to be changed to ``inherit image-artifact-names``. | |||
| 303 | Miscellaneous changes | 303 | Miscellaneous changes |
| 304 | --------------------- | 304 | --------------------- |
| 305 | 305 | ||
| 306 | - Support for the long-deprecated ``PACKAGE_GROUP`` variable has now been removed - replace any remaining instances with :term:`FEATURE_PACKAGES`. | 306 | - Support for the long-deprecated ``PACKAGE_GROUP`` variable has now been removed --- replace any remaining instances with :term:`FEATURE_PACKAGES`. |
| 307 | - The ``FILESPATHPKG`` variable, having been previously deprecated, has now been removed. Replace any remaining references with appropriate use of :term:`FILESEXTRAPATHS`. | 307 | - The ``FILESPATHPKG`` variable, having been previously deprecated, has now been removed. Replace any remaining references with appropriate use of :term:`FILESEXTRAPATHS`. |
| 308 | - Erroneous use of ``inherit +=`` (instead of ``INHERIT +=``) in a configuration file now triggers an error instead of silently being ignored. | 308 | - Erroneous use of ``inherit +=`` (instead of ``INHERIT +=``) in a configuration file now triggers an error instead of silently being ignored. |
| 309 | - ptest support has been removed from the ``kbd`` recipe, as upstream has moved to autotest which is difficult to work with in a cross-compilation environment. | 309 | - ptest support has been removed from the ``kbd`` recipe, as upstream has moved to autotest which is difficult to work with in a cross-compilation environment. |
diff --git a/documentation/migration-guides/migration-3.3.rst b/documentation/migration-guides/migration-3.3.rst index d65f1c7b1f..aba5c4237c 100644 --- a/documentation/migration-guides/migration-3.3.rst +++ b/documentation/migration-guides/migration-3.3.rst | |||
| @@ -13,11 +13,10 @@ Minimum system requirements | |||
| 13 | You will now need at least Python 3.6 installed on your build host. Most recent | 13 | You will now need at least Python 3.6 installed on your build host. Most recent |
| 14 | distributions provide this, but should you be building on a distribution that | 14 | distributions provide this, but should you be building on a distribution that |
| 15 | does not have it, you can use the ``buildtools-tarball`` (easily installable | 15 | does not have it, you can use the ``buildtools-tarball`` (easily installable |
| 16 | using ``scripts/install-buildtools``) - see | 16 | using ``scripts/install-buildtools``) --- see |
| 17 | :ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions` | 17 | :ref:`ref-manual/system-requirements:required git, tar, python, make and gcc versions` |
| 18 | for details. | 18 | for details. |
| 19 | 19 | ||
| 20 | |||
| 21 | .. _migration-3.3-removed-recipes: | 20 | .. _migration-3.3-removed-recipes: |
| 22 | 21 | ||
| 23 | Removed recipes | 22 | Removed recipes |
diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index 8db43a1454..c55c0b8c3c 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst | |||
| @@ -146,7 +146,7 @@ Virtual runtime provides | |||
| 146 | ~~~~~~~~~~~~~~~~~~~~~~~~ | 146 | ~~~~~~~~~~~~~~~~~~~~~~~~ |
| 147 | 147 | ||
| 148 | Recipes shouldn't use the ``virtual/`` string in :term:`RPROVIDES` and | 148 | Recipes shouldn't use the ``virtual/`` string in :term:`RPROVIDES` and |
| 149 | :term:`RDEPENDS` - it is confusing because ``virtual/`` has no special | 149 | :term:`RDEPENDS` --- it is confusing because ``virtual/`` has no special |
| 150 | meaning in :term:`RPROVIDES` and :term:`RDEPENDS` (unlike in the | 150 | meaning in :term:`RPROVIDES` and :term:`RDEPENDS` (unlike in the |
| 151 | corresponding build-time :term:`PROVIDES` and :term:`DEPENDS`). | 151 | corresponding build-time :term:`PROVIDES` and :term:`DEPENDS`). |
| 152 | 152 | ||
| @@ -171,7 +171,7 @@ Extensible SDK host extension | |||
| 171 | For a normal SDK, some layers append to :term:`TOOLCHAIN_HOST_TASK` | 171 | For a normal SDK, some layers append to :term:`TOOLCHAIN_HOST_TASK` |
| 172 | unconditionally which is fine, until the eSDK tries to override the | 172 | unconditionally which is fine, until the eSDK tries to override the |
| 173 | variable to its own values. Instead of installing packages specified | 173 | variable to its own values. Instead of installing packages specified |
| 174 | in this variable it uses native recipes instead - a very different | 174 | in this variable it uses native recipes instead --- a very different |
| 175 | approach. This has led to confusing errors when binaries are added | 175 | approach. This has led to confusing errors when binaries are added |
| 176 | to the SDK but not relocated. | 176 | to the SDK but not relocated. |
| 177 | 177 | ||
diff --git a/documentation/migration-guides/release-notes-3.4.rst b/documentation/migration-guides/release-notes-3.4.rst index 5a8fb4b5a9..323e4df7ae 100644 --- a/documentation/migration-guides/release-notes-3.4.rst +++ b/documentation/migration-guides/release-notes-3.4.rst | |||
| @@ -5,7 +5,7 @@ New Features / Enhancements in 3.4 | |||
| 5 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 5 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 6 | 6 | ||
| 7 | - Linux kernel 5.14, glibc 2.34 and ~280 other recipe upgrades | 7 | - Linux kernel 5.14, glibc 2.34 and ~280 other recipe upgrades |
| 8 | - Switched override character to ':' (replacing '_') for more robust parsing and improved performance - see the above migration guide for help | 8 | - Switched override character to ':' (replacing '_') for more robust parsing and improved performance --- see the above migration guide for help |
| 9 | - Rust integrated into core, providing rust support for cross-compilation and SDK | 9 | - Rust integrated into core, providing rust support for cross-compilation and SDK |
| 10 | - New create-spdx class for creating SPDX SBoM documents | 10 | - New create-spdx class for creating SPDX SBoM documents |
| 11 | - New recipes: cargo, core-image-ptest-all, core-image-ptest-fast, core-image-weston-sdk, erofs-utils, gcompat, gi-docgen, libmicrohttpd, libseccomp, libstd-rs, perlcross, python3-markdown, python3-pyyaml, python3-smartypants, python3-typogrify, rust, rust-cross, rust-cross-canadian, rust-hello-world, rust-llvm, rust-tools-cross-canadian, rustfmt, xwayland | 11 | - New recipes: cargo, core-image-ptest-all, core-image-ptest-fast, core-image-weston-sdk, erofs-utils, gcompat, gi-docgen, libmicrohttpd, libseccomp, libstd-rs, perlcross, python3-markdown, python3-pyyaml, python3-smartypants, python3-typogrify, rust, rust-cross, rust-cross-canadian, rust-hello-world, rust-llvm, rust-tools-cross-canadian, rustfmt, xwayland |
