diff options
Diffstat (limited to 'documentation/migration-guides')
| -rw-r--r-- | documentation/migration-guides/migration-1.3.rst | 21 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-1.5.rst | 5 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-1.6.rst | 9 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-1.8.rst | 6 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-2.1.rst | 8 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-2.3.rst | 21 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-2.6.rst | 12 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-3.0.rst | 4 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-3.2.rst | 8 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-3.3.rst | 16 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-3.4.rst | 2 | ||||
| -rw-r--r-- | documentation/migration-guides/migration-general.rst | 21 | ||||
| -rw-r--r-- | documentation/migration-guides/release-notes-3.4.rst | 6 | ||||
| -rw-r--r-- | documentation/migration-guides/release-notes-4.0.rst | 15 | ||||
| -rw-r--r-- | documentation/migration-guides/release-notes-4.1.rst | 9 |
15 files changed, 91 insertions, 72 deletions
diff --git a/documentation/migration-guides/migration-1.3.rst b/documentation/migration-guides/migration-1.3.rst index 3ba189b773..a135574744 100644 --- a/documentation/migration-guides/migration-1.3.rst +++ b/documentation/migration-guides/migration-1.3.rst | |||
| @@ -91,11 +91,11 @@ consistency. | |||
| 91 | nativesdk | 91 | nativesdk |
| 92 | ~~~~~~~~~ | 92 | ~~~~~~~~~ |
| 93 | 93 | ||
| 94 | The suffix ``nativesdk`` is now implemented as a prefix, which | 94 | The suffix ``nativesdk`` is now implemented as a prefix, which simplifies a |
| 95 | simplifies a lot of the packaging code for ``nativesdk`` recipes. All | 95 | lot of the packaging code for :ref:`nativesdk <ref-classes-nativesdk>` recipes. |
| 96 | custom ``nativesdk`` recipes, which are relocatable packages that are | 96 | All custom :ref:`nativesdk <ref-classes-nativesdk>` recipes, which are |
| 97 | native to :term:`SDK_ARCH`, and any references need to | 97 | relocatable packages that are native to :term:`SDK_ARCH`, and any references |
| 98 | be updated to use ``nativesdk-*`` instead of ``*-nativesdk``. | 98 | need to be updated to use ``nativesdk-*`` instead of ``*-nativesdk``. |
| 99 | 99 | ||
| 100 | .. _migration-1.3-task-recipes: | 100 | .. _migration-1.3-task-recipes: |
| 101 | 101 | ||
| @@ -109,12 +109,11 @@ automatic upgrade path for most packages. However, you should update | |||
| 109 | references in your own recipes and configurations as they could be | 109 | references in your own recipes and configurations as they could be |
| 110 | removed in future releases. You should also rename any custom ``task-*`` | 110 | removed in future releases. You should also rename any custom ``task-*`` |
| 111 | recipes to ``packagegroup-*``, and change them to inherit | 111 | recipes to ``packagegroup-*``, and change them to inherit |
| 112 | ``packagegroup`` instead of ``task``, as well as taking the opportunity | 112 | :ref:`packagegroup <ref-classes-packagegroup>` instead of ``task``, as well |
| 113 | to remove anything now handled by :ref:`ref-classes-packagegroup`, such as | 113 | as taking the opportunity to remove anything now handled by |
| 114 | providing ``-dev`` and ``-dbg`` packages, setting | 114 | :ref:`ref-classes-packagegroup`, such as providing ``-dev`` and ``-dbg`` |
| 115 | :term:`LIC_FILES_CHKSUM`, and so forth. See the | 115 | packages, setting :term:`LIC_FILES_CHKSUM`, and so forth. See the |
| 116 | :ref:`ref-classes-packagegroup` section for | 116 | :ref:`ref-classes-packagegroup` section for further details. |
| 117 | further details. | ||
| 118 | 117 | ||
| 119 | .. _migration-1.3-image-features: | 118 | .. _migration-1.3-image-features: |
| 120 | 119 | ||
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst index 70a087ff1a..b47980dc67 100644 --- a/documentation/migration-guides/migration-1.5.rst +++ b/documentation/migration-guides/migration-1.5.rst | |||
| @@ -130,6 +130,11 @@ The following directory changes exist: | |||
| 130 | it easier to delete :term:`TMPDIR` and preserve the build history. | 130 | it easier to delete :term:`TMPDIR` and preserve the build history. |
| 131 | Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`. | 131 | Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`. |
| 132 | 132 | ||
| 133 | - When :ref:`buildhistory <ref-classes-buildhistory>` is enabled, its output | ||
| 134 | is now written under the :term:`Build Directory` rather than :term:`TMPDIR`. | ||
| 135 | Doing so makes it easier to delete :term:`TMPDIR` and preserve the build | ||
| 136 | history. Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`. | ||
| 137 | |||
| 133 | - The ``pkgdata`` directory produced as part of the packaging process | 138 | - The ``pkgdata`` directory produced as part of the packaging process |
| 134 | has been collapsed into a single machine-specific directory. This | 139 | has been collapsed into a single machine-specific directory. This |
| 135 | directory is located under ``sysroots`` and uses a machine-specific | 140 | directory is located under ``sysroots`` and uses a machine-specific |
diff --git a/documentation/migration-guides/migration-1.6.rst b/documentation/migration-guides/migration-1.6.rst index d3de264650..d07731dcb0 100644 --- a/documentation/migration-guides/migration-1.6.rst +++ b/documentation/migration-guides/migration-1.6.rst | |||
| @@ -220,9 +220,10 @@ Package Test (ptest) | |||
| 220 | 220 | ||
| 221 | Package Tests (ptest) are built but not installed by default. For | 221 | Package Tests (ptest) are built but not installed by default. For |
| 222 | information on using Package Tests, see the | 222 | information on using Package Tests, see the |
| 223 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" | 223 | ":ref:`dev-manual/common-tasks:testing packages with ptest`" section in the |
| 224 | section in the Yocto Project Development Tasks Manual. For information on the | 224 | Yocto Project Development Tasks Manual. For information on the |
| 225 | ``ptest`` class, see the ":ref:`ref-classes-ptest`" section. | 225 | :ref:`ptest <ref-classes-ptest>` class, see the ":ref:`ref-classes-ptest`" |
| 226 | section. | ||
| 226 | 227 | ||
| 227 | .. _migration-1.6-build-changes: | 228 | .. _migration-1.6-build-changes: |
| 228 | 229 | ||
| @@ -237,7 +238,7 @@ will enable a separate :term:`Build Directory` by default as well. Recipes | |||
| 237 | building Autotools-based software that fails to build with a separate | 238 | building Autotools-based software that fails to build with a separate |
| 238 | :term:`Build Directory` should be changed to inherit from the | 239 | :term:`Build Directory` should be changed to inherit from the |
| 239 | :ref:`autotools-brokensep <ref-classes-autotools>` class instead of | 240 | :ref:`autotools-brokensep <ref-classes-autotools>` class instead of |
| 240 | the ``autotools`` or ``autotools_stage``\ classes. | 241 | the :ref:`autotools <ref-classes-autotools>` or ``autotools_stage`` classes. |
| 241 | 242 | ||
| 242 | .. _migration-1.6-building-qemu-native: | 243 | .. _migration-1.6-building-qemu-native: |
| 243 | 244 | ||
diff --git a/documentation/migration-guides/migration-1.8.rst b/documentation/migration-guides/migration-1.8.rst index f058029b30..35a2a21e5b 100644 --- a/documentation/migration-guides/migration-1.8.rst +++ b/documentation/migration-guides/migration-1.8.rst | |||
| @@ -76,15 +76,15 @@ particular, users need to ensure that ``${S}`` (source files) and | |||
| 76 | ``${B}`` (build artifacts) are used correctly in functions such as | 76 | ``${B}`` (build artifacts) are used correctly in functions such as |
| 77 | :ref:`ref-tasks-configure` and | 77 | :ref:`ref-tasks-configure` and |
| 78 | :ref:`ref-tasks-install`. For kernel recipes that do not | 78 | :ref:`ref-tasks-install`. For kernel recipes that do not |
| 79 | inherit from ``kernel-yocto`` or include ``linux-yocto.inc``, you might | 79 | inherit from :ref:`kernel-yocto <ref-classes-kernel-yocto>` or include ``linux-yocto.inc``, you might |
| 80 | wish to refer to the ``linux.inc`` file in the ``meta-oe`` layer for the | 80 | wish to refer to the ``linux.inc`` file in the ``meta-oe`` layer for the |
| 81 | kinds of changes you need to make. For reference, here is the | 81 | kinds of changes you need to make. For reference, here is the |
| 82 | :oe_git:`commit </meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>` | 82 | :oe_git:`commit </meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>` |
| 83 | where the ``linux.inc`` file in ``meta-oe`` was updated. | 83 | where the ``linux.inc`` file in ``meta-oe`` was updated. |
| 84 | 84 | ||
| 85 | Recipes that rely on the kernel source code and do not inherit the | 85 | Recipes that rely on the kernel source code and do not inherit the |
| 86 | module classes might need to add explicit dependencies on the | 86 | :ref:`module <ref-classes-module>` classes might need to add explicit |
| 87 | :ref:`ref-tasks-shared_workdir` kernel task, for example:: | 87 | dependencies on the :ref:`ref-tasks-shared_workdir` kernel task, for example:: |
| 88 | 88 | ||
| 89 | do_configure[depends] += "virtual/kernel:do_shared_workdir" | 89 | do_configure[depends] += "virtual/kernel:do_shared_workdir" |
| 90 | 90 | ||
diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst index c19ba5501c..f045feadff 100644 --- a/documentation/migration-guides/migration-2.1.rst +++ b/documentation/migration-guides/migration-2.1.rst | |||
| @@ -64,7 +64,7 @@ Makefile Environment Changes | |||
| 64 | :term:`EXTRA_OEMAKE` now defaults to "" instead of | 64 | :term:`EXTRA_OEMAKE` now defaults to "" instead of |
| 65 | "-e MAKEFLAGS=". Setting :term:`EXTRA_OEMAKE` to "-e MAKEFLAGS=" by default | 65 | "-e MAKEFLAGS=". Setting :term:`EXTRA_OEMAKE` to "-e MAKEFLAGS=" by default |
| 66 | was a historical accident that has required many classes (e.g. | 66 | was a historical accident that has required many classes (e.g. |
| 67 | ``autotools``, ``module``) and recipes to override this default in order | 67 | :ref:`autotools <ref-classes-autotools>`, ``module``) and recipes to override this default in order |
| 68 | to work with sensible build systems. When upgrading to the release, you | 68 | to work with sensible build systems. When upgrading to the release, you |
| 69 | must edit any recipe that relies upon this old default by either setting | 69 | must edit any recipe that relies upon this old default by either setting |
| 70 | :term:`EXTRA_OEMAKE` back to "-e MAKEFLAGS=" or by explicitly setting any | 70 | :term:`EXTRA_OEMAKE` back to "-e MAKEFLAGS=" or by explicitly setting any |
| @@ -191,7 +191,7 @@ The following classes have changed: | |||
| 191 | - ``autotools_stage``: Removed because the | 191 | - ``autotools_stage``: Removed because the |
| 192 | :ref:`autotools <ref-classes-autotools>` class now provides its | 192 | :ref:`autotools <ref-classes-autotools>` class now provides its |
| 193 | functionality. Recipes that inherited from ``autotools_stage`` should | 193 | functionality. Recipes that inherited from ``autotools_stage`` should |
| 194 | now inherit from ``autotools`` instead. | 194 | now inherit from :ref:`autotools <ref-classes-autotools>` instead. |
| 195 | 195 | ||
| 196 | - ``boot-directdisk``: Merged into the ``image-vm`` class. The | 196 | - ``boot-directdisk``: Merged into the ``image-vm`` class. The |
| 197 | ``boot-directdisk`` class was rarely directly used. Consequently, | 197 | ``boot-directdisk`` class was rarely directly used. Consequently, |
| @@ -401,9 +401,9 @@ These additional changes exist: | |||
| 401 | as these directories are automatically found and added. | 401 | as these directories are automatically found and added. |
| 402 | 402 | ||
| 403 | - Inaccurate disk and CPU percentage data has been dropped from | 403 | - Inaccurate disk and CPU percentage data has been dropped from |
| 404 | ``buildstats`` output. This data has been replaced with | 404 | :ref:`buildstats <ref-classes-buildstats>` output. This data has been replaced with |
| 405 | ``getrusage()`` data and corrected IO statistics. You will probably | 405 | ``getrusage()`` data and corrected IO statistics. You will probably |
| 406 | need to update any custom code that reads the ``buildstats`` data. | 406 | need to update any custom code that reads the :ref:`buildstats <ref-classes-buildstats>` data. |
| 407 | 407 | ||
| 408 | - The ``meta/conf/distro/include/package_regex.inc`` is now deprecated. | 408 | - The ``meta/conf/distro/include/package_regex.inc`` is now deprecated. |
| 409 | The contents of this file have been moved to individual recipes. | 409 | The contents of this file have been moved to individual recipes. |
diff --git a/documentation/migration-guides/migration-2.3.rst b/documentation/migration-guides/migration-2.3.rst index d49ed474ca..4a1f159e92 100644 --- a/documentation/migration-guides/migration-2.3.rst +++ b/documentation/migration-guides/migration-2.3.rst | |||
| @@ -481,9 +481,9 @@ The following miscellaneous changes have occurred: | |||
| 481 | is an unnecessary burden. | 481 | is an unnecessary burden. |
| 482 | 482 | ||
| 483 | If you need to preserve these ``.la`` files (e.g. in a custom | 483 | If you need to preserve these ``.la`` files (e.g. in a custom |
| 484 | distribution), you must change | 484 | distribution), you must change :term:`INHERIT_DISTRO` such that |
| 485 | :term:`INHERIT_DISTRO` such that | 485 | ":ref:`remove-libtool <ref-classes-remove-libtool>`" is not included |
| 486 | "remove-libtool" is not included in the value. | 486 | in the value. |
| 487 | 487 | ||
| 488 | - Extensible SDKs built for GCC 5+ now refuse to install on a | 488 | - Extensible SDKs built for GCC 5+ now refuse to install on a |
| 489 | distribution where the host GCC version is 4.8 or 4.9. This change | 489 | distribution where the host GCC version is 4.8 or 4.9. This change |
| @@ -492,18 +492,17 @@ The following miscellaneous changes have occurred: | |||
| 492 | the :ref:`uninative <ref-classes-uninative>` class for additional | 492 | the :ref:`uninative <ref-classes-uninative>` class for additional |
| 493 | information. | 493 | information. |
| 494 | 494 | ||
| 495 | - All native and nativesdk recipes now use a separate | 495 | - All :ref:`native <ref-classes-native>` and |
| 496 | :ref:`nativesdk <ref-classes-nativesdk>` recipes now use a separate | ||
| 496 | :term:`DISTRO_FEATURES` value instead of sharing the value used by | 497 | :term:`DISTRO_FEATURES` value instead of sharing the value used by |
| 497 | recipes for the target, in order to avoid unnecessary rebuilds. | 498 | recipes for the target, in order to avoid unnecessary rebuilds. |
| 498 | 499 | ||
| 499 | The :term:`DISTRO_FEATURES` for ``native`` recipes is | 500 | The :term:`DISTRO_FEATURES` for :ref:`native <ref-classes-native>` recipes |
| 500 | :term:`DISTRO_FEATURES_NATIVE` added to | 501 | is :term:`DISTRO_FEATURES_NATIVE` added to an intersection of |
| 501 | an intersection of :term:`DISTRO_FEATURES` and | 502 | :term:`DISTRO_FEATURES` and :term:`DISTRO_FEATURES_FILTER_NATIVE`. |
| 502 | :term:`DISTRO_FEATURES_FILTER_NATIVE`. | ||
| 503 | 503 | ||
| 504 | For nativesdk recipes, the corresponding variables are | 504 | For :ref:`nativesdk <ref-classes-nativesdk>` recipes, the corresponding |
| 505 | :term:`DISTRO_FEATURES_NATIVESDK` | 505 | variables are :term:`DISTRO_FEATURES_NATIVESDK` and |
| 506 | and | ||
| 507 | :term:`DISTRO_FEATURES_FILTER_NATIVESDK`. | 506 | :term:`DISTRO_FEATURES_FILTER_NATIVESDK`. |
| 508 | 507 | ||
| 509 | - The ``FILESDIR`` variable, which was previously deprecated and rarely | 508 | - The ``FILESDIR`` variable, which was previously deprecated and rarely |
diff --git a/documentation/migration-guides/migration-2.6.rst b/documentation/migration-guides/migration-2.6.rst index eedede2457..59592997ff 100644 --- a/documentation/migration-guides/migration-2.6.rst +++ b/documentation/migration-guides/migration-2.6.rst | |||
| @@ -128,7 +128,8 @@ missing from :term:`DEPENDS`). | |||
| 128 | 128 | ||
| 129 | This change affects classes beyond just the two mentioned (i.e. | 129 | This change affects classes beyond just the two mentioned (i.e. |
| 130 | ``distutils`` and ``distutils3``). Any recipe that inherits ``distutils*`` | 130 | ``distutils`` and ``distutils3``). Any recipe that inherits ``distutils*`` |
| 131 | classes are affected. For example, the ``setuptools`` and ``setuptools3`` | 131 | classes are affected. For example, the ``setuptools`` and |
| 132 | :ref:`setuptools3 <ref-classes-setuptools3>` | ||
| 132 | recipes are affected since they inherit the ``distutils*`` classes. | 133 | recipes are affected since they inherit the ``distutils*`` classes. |
| 133 | 134 | ||
| 134 | Fetching these types of dependencies that are not provided in the | 135 | Fetching these types of dependencies that are not provided in the |
| @@ -315,13 +316,12 @@ This section provides information about automatic testing changes: | |||
| 315 | exists and has been replaced by the | 316 | exists and has been replaced by the |
| 316 | :term:`TESTIMAGE_AUTO` variable. | 317 | :term:`TESTIMAGE_AUTO` variable. |
| 317 | 318 | ||
| 318 | - Inheriting the ``testimage`` and ``testsdk`` Classes: Best | 319 | - Inheriting the :ref:`testimage <ref-classes-testimage>` and |
| 319 | practices now dictate that you use the | 320 | :ref:`testsdk <ref-classes-testsdk>` classes: best practices now dictate |
| 320 | :term:`IMAGE_CLASSES` variable rather than the | 321 | that you use the :term:`IMAGE_CLASSES` variable rather than the |
| 321 | :term:`INHERIT` variable when you inherit the | 322 | :term:`INHERIT` variable when you inherit the |
| 322 | :ref:`testimage <ref-classes-testimage>` and | 323 | :ref:`testimage <ref-classes-testimage>` and |
| 323 | :ref:`testsdk <ref-classes-testsdk>` classes used for automatic | 324 | :ref:`testsdk <ref-classes-testsdk>` classes used for automatic testing. |
| 324 | testing. | ||
| 325 | 325 | ||
| 326 | .. _migration-2.6-openssl-changes: | 326 | .. _migration-2.6-openssl-changes: |
| 327 | 327 | ||
diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst index 90736e6009..95a33d4dd4 100644 --- a/documentation/migration-guides/migration-3.0.rst +++ b/documentation/migration-guides/migration-3.0.rst | |||
| @@ -282,8 +282,8 @@ The following miscellaneous changes have occurred. | |||
| 282 | - You must change the host distro identifier used in | 282 | - You must change the host distro identifier used in |
| 283 | :term:`NATIVELSBSTRING` to use all lowercase | 283 | :term:`NATIVELSBSTRING` to use all lowercase |
| 284 | characters even if it does not contain a version number. This change | 284 | characters even if it does not contain a version number. This change |
| 285 | is necessary only if you are not using ``uninative`` and | 285 | is necessary only if you are not using |
| 286 | :term:`SANITY_TESTED_DISTROS`. | 286 | :ref:`uninative <ref-classes-uninative>` and :term:`SANITY_TESTED_DISTROS`. |
| 287 | 287 | ||
| 288 | - In the ``base-files`` recipe, writing the hostname into | 288 | - In the ``base-files`` recipe, writing the hostname into |
| 289 | ``/etc/hosts`` and ``/etc/hostname`` is now done within the main | 289 | ``/etc/hosts`` and ``/etc/hostname`` is now done within the main |
diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index a714bd6bca..630d5c2b94 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst | |||
| @@ -217,7 +217,13 @@ Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` cla | |||
| 217 | Custom SDK / SDK-style recipes need to include ``nativesdk-sdk-provides-dummy`` | 217 | Custom SDK / SDK-style recipes need to include ``nativesdk-sdk-provides-dummy`` |
| 218 | ------------------------------------------------------------------------------- | 218 | ------------------------------------------------------------------------------- |
| 219 | 219 | ||
| 220 | All ``nativesdk`` packages require ``/bin/sh`` due to their postinstall scriptlets, thus this package has to be dummy-provided within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have a custom SDK recipe (or your own SDK-style recipe similar to e.g. ``buildtools-tarball``), you will need to ensure ``nativesdk-sdk-provides-dummy`` or an equivalent is included in :term:`TOOLCHAIN_HOST_TASK`. | 220 | All :ref:`nativesdk <ref-classes-nativesdk>` packages require ``/bin/sh`` due |
| 221 | to their postinstall scriptlets, thus this package has to be dummy-provided | ||
| 222 | within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have | ||
| 223 | a custom SDK recipe (or your own SDK-style recipe similar to e.g. | ||
| 224 | ``buildtools-tarball``), you will need to ensure | ||
| 225 | ``nativesdk-sdk-provides-dummy`` or an equivalent is included in | ||
| 226 | :term:`TOOLCHAIN_HOST_TASK`. | ||
| 221 | 227 | ||
| 222 | 228 | ||
| 223 | ``ld.so.conf`` now moved back to main ``glibc`` package | 229 | ``ld.so.conf`` now moved back to main ``glibc`` package |
diff --git a/documentation/migration-guides/migration-3.3.rst b/documentation/migration-guides/migration-3.3.rst index aba5c4237c..d110aacd81 100644 --- a/documentation/migration-guides/migration-3.3.rst +++ b/documentation/migration-guides/migration-3.3.rst | |||
| @@ -61,13 +61,15 @@ need to update those. | |||
| 61 | New ``python3targetconfig`` class | 61 | New ``python3targetconfig`` class |
| 62 | --------------------------------- | 62 | --------------------------------- |
| 63 | 63 | ||
| 64 | A new :ref:`python3targetconfig <ref-classes-python3targetconfig>` class has been | 64 | A new :ref:`python3targetconfig <ref-classes-python3targetconfig>` class has |
| 65 | created for situations where you would previously have inherited the | 65 | been created for situations where you would previously have inherited the |
| 66 | :ref:`python3native <ref-classes-python3native>` class but need access to target configuration data (such as | 66 | :ref:`python3native <ref-classes-python3native>` class but need access to |
| 67 | correct installation directories). Recipes where this situation applies should | 67 | target configuration data (such as correct installation directories). Recipes |
| 68 | be changed to inherit ``python3targetconfig`` instead of ``python3native``. This | 68 | where this situation applies should be changed to inherit |
| 69 | also adds a dependency on target ``python3``, so it should only be used where | 69 | :ref:`python3targetconfig <ref-classes-python3targetconfig>` instead of |
| 70 | appropriate in order to avoid unnecessarily lengthening builds. | 70 | :ref:`python3native <ref-classes-python3native>`. This also adds a dependency |
| 71 | on target ``python3``, so it should only be used where appropriate in order to | ||
| 72 | avoid unnecessarily lengthening builds. | ||
| 71 | 73 | ||
| 72 | Some example recipes where this change has been made: ``gpgme``, ``libcap-ng``, | 74 | Some example recipes where this change has been made: ``gpgme``, ``libcap-ng``, |
| 73 | ``python3-pycairo``. | 75 | ``python3-pycairo``. |
diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index 4ceea7b0e4..ac4d08e051 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst | |||
| @@ -124,7 +124,7 @@ Removed classes | |||
| 124 | - ``image-mklibs``: not actively tested and upstream mklibs still | 124 | - ``image-mklibs``: not actively tested and upstream mklibs still |
| 125 | requires Python 2 | 125 | requires Python 2 |
| 126 | - ``meta``: no longer useful. Recipes that need to skip installing | 126 | - ``meta``: no longer useful. Recipes that need to skip installing |
| 127 | packages should inherit ``nopackages`` instead. | 127 | packages should inherit :ref:`nopackages <ref-classes-nopackages>` instead. |
| 128 | 128 | ||
| 129 | Prelinking disabled by default | 129 | Prelinking disabled by default |
| 130 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 130 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
diff --git a/documentation/migration-guides/migration-general.rst b/documentation/migration-guides/migration-general.rst index 847bdad739..8503017580 100644 --- a/documentation/migration-guides/migration-general.rst +++ b/documentation/migration-guides/migration-general.rst | |||
| @@ -79,18 +79,19 @@ any new Yocto Project release. | |||
| 79 | the migration (e.g. added/removed packages, added/removed files, size | 79 | the migration (e.g. added/removed packages, added/removed files, size |
| 80 | changes etc.). To do this, follow these steps: | 80 | changes etc.). To do this, follow these steps: |
| 81 | 81 | ||
| 82 | 1. Enable buildhistory before the migration | 82 | 1. Enable :ref:`buildhistory <ref-classes-buildhistory>` before the migration |
| 83 | 83 | ||
| 84 | 2. Run a pre-migration build | 84 | 2. Run a pre-migration build |
| 85 | 85 | ||
| 86 | 3. Capture the buildhistory output (as specified by :term:`BUILDHISTORY_DIR`) | 86 | 3. Capture the :ref:`buildhistory <ref-classes-buildhistory>` output (as |
| 87 | and ensure it is preserved for subsequent builds. How you would do this | 87 | specified by :term:`BUILDHISTORY_DIR`) and ensure it is preserved for |
| 88 | depends on how you are running your builds - if you are doing this all on | 88 | subsequent builds. How you would do this depends on how you are running |
| 89 | one workstation in the same :term:`Build Directory` you may not need to do | 89 | your builds - if you are doing this all on one workstation in the same |
| 90 | anything other than not deleting the buildhistory output directory. For | 90 | :term:`Build Directory` you may not need to do anything other than not |
| 91 | builds in a pipeline it may be more complicated. | 91 | deleting the :ref:`buildhistory <ref-classes-buildhistory>` output |
| 92 | directory. For builds in a pipeline it may be more complicated. | ||
| 92 | 93 | ||
| 93 | 4. Set a tag in the buildhistory output (which is a git repository) before | 94 | 4. Set a tag in the :ref:`buildhistory <ref-classes-buildhistory>` output (which is a git repository) before |
| 94 | migration, to make the commit from the pre-migration build easy to find | 95 | migration, to make the commit from the pre-migration build easy to find |
| 95 | as you may end up running multiple builds during the migration. | 96 | as you may end up running multiple builds during the migration. |
| 96 | 97 | ||
| @@ -99,7 +100,7 @@ any new Yocto Project release. | |||
| 99 | 6. Run a build | 100 | 6. Run a build |
| 100 | 101 | ||
| 101 | 7. Check the output changes between the previously set tag and HEAD in the | 102 | 7. Check the output changes between the previously set tag and HEAD in the |
| 102 | buildhistory output using ``git diff`` or ``buildhistory-diff``. | 103 | :ref:`buildhistory <ref-classes-buildhistory>` output using ``git diff`` or ``buildhistory-diff``. |
| 103 | 104 | ||
| 104 | For more information on using buildhistory, see | 105 | For more information on using :ref:`buildhistory <ref-classes-buildhistory>`, see |
| 105 | :ref:`dev-manual/common-tasks:maintaining build output quality`. | 106 | :ref:`dev-manual/common-tasks:maintaining build output quality`. |
diff --git a/documentation/migration-guides/release-notes-3.4.rst b/documentation/migration-guides/release-notes-3.4.rst index 62683b4a5c..83ca901016 100644 --- a/documentation/migration-guides/release-notes-3.4.rst +++ b/documentation/migration-guides/release-notes-3.4.rst | |||
| @@ -7,7 +7,7 @@ New Features / Enhancements in 3.4 | |||
| 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 :ref:`create-spdx <ref-classes-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 |
| 12 | - Several optimisations to reduce unnecessary task dependencies for faster builds | 12 | - Several optimisations to reduce unnecessary task dependencies for faster builds |
| 13 | - seccomp integrated into core, with additional enabling for gnutls, systemd, qemu | 13 | - seccomp integrated into core, with additional enabling for gnutls, systemd, qemu |
| @@ -68,7 +68,9 @@ New Features / Enhancements in 3.4 | |||
| 68 | - SDK-related enhancements: | 68 | - SDK-related enhancements: |
| 69 | 69 | ||
| 70 | - Enable :ref:`ref-tasks-populate_sdk` with multilibs | 70 | - Enable :ref:`ref-tasks-populate_sdk` with multilibs |
| 71 | - New ``SDKPATHINSTALL`` variable decouples default install path from built in path to avoid rebuilding nativesdk components on e.g. :term:`DISTRO_VERSION` changes | 71 | - New ``SDKPATHINSTALL`` variable decouples default install path from |
| 72 | built in path to avoid rebuilding :ref:`nativesdk <ref-classes-nativesdk>` | ||
| 73 | components on e.g. :term:`DISTRO_VERSION` changes | ||
| 72 | - eSDK: Error if trying to generate an eSDK from a multiconfig | 74 | - eSDK: Error if trying to generate an eSDK from a multiconfig |
| 73 | - eSDK: introduce :term:`TOOLCHAIN_HOST_TASK_ESDK` to be used in place of :term:`TOOLCHAIN_HOST_TASK` to add components to the host part of the eSDK | 75 | - eSDK: introduce :term:`TOOLCHAIN_HOST_TASK_ESDK` to be used in place of :term:`TOOLCHAIN_HOST_TASK` to add components to the host part of the eSDK |
| 74 | 76 | ||
diff --git a/documentation/migration-guides/release-notes-4.0.rst b/documentation/migration-guides/release-notes-4.0.rst index d57227502e..3be7342a9c 100644 --- a/documentation/migration-guides/release-notes-4.0.rst +++ b/documentation/migration-guides/release-notes-4.0.rst | |||
| @@ -8,9 +8,10 @@ New Features / Enhancements in 4.0 | |||
| 8 | 8 | ||
| 9 | - Linux kernel 5.15, glibc 2.35 and ~300 other recipe upgrades | 9 | - Linux kernel 5.15, glibc 2.35 and ~300 other recipe upgrades |
| 10 | 10 | ||
| 11 | - Reproducibility: this release fixes the reproducibility issues with ``rust-llvm`` and | 11 | - Reproducibility: this release fixes the reproducibility issues with |
| 12 | ``golang``. Recipes in OpenEmbedded-Core are now fully reproducible. Functionality | 12 | ``rust-llvm`` and ``golang``. Recipes in OpenEmbedded-Core are now fully |
| 13 | previously in the optional "reproducible" class has been merged into the base class. | 13 | reproducible. Functionality previously in the optional "reproducible" |
| 14 | class has been merged into the :ref:`base <ref-classes-base>` class. | ||
| 14 | 15 | ||
| 15 | - Network access is now disabled by default for tasks other than where it is expected to ensure build integrity (where host kernel supports it) | 16 | - Network access is now disabled by default for tasks other than where it is expected to ensure build integrity (where host kernel supports it) |
| 16 | 17 | ||
| @@ -215,7 +216,7 @@ New Features / Enhancements in 4.0 | |||
| 215 | - Ensure addition of patch-fuzz retriggers do_qa_patch | 216 | - Ensure addition of patch-fuzz retriggers do_qa_patch |
| 216 | - Added a sanity check for allarch packagegroups | 217 | - Added a sanity check for allarch packagegroups |
| 217 | 218 | ||
| 218 | - create-spdx class improvements: | 219 | - :ref:`create-spdx <ref-classes-create-spdx>` class improvements: |
| 219 | 220 | ||
| 220 | - Get SPDX-License-Identifier from source files | 221 | - Get SPDX-License-Identifier from source files |
| 221 | - Generate manifest also for SDKs | 222 | - Generate manifest also for SDKs |
| @@ -235,8 +236,10 @@ New Features / Enhancements in 4.0 | |||
| 235 | 236 | ||
| 236 | - SDK-related enhancements: | 237 | - SDK-related enhancements: |
| 237 | 238 | ||
| 238 | - Extended recipes to ``nativesdk``: ``cargo``, ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging`` | 239 | - Extended recipes to :ref:`nativesdk <ref-classes-nativesdk>`: ``cargo``, |
| 239 | - Enabled nativesdk recipes to find a correct version of the rust cross compiler | 240 | ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging`` |
| 241 | - Enabled :ref:`nativesdk <ref-classes-nativesdk>` recipes to find a correct version | ||
| 242 | of the rust cross compiler | ||
| 240 | - Support creating per-toolchain cmake file in SDK | 243 | - Support creating per-toolchain cmake file in SDK |
| 241 | 244 | ||
| 242 | - Rust enhancements: | 245 | - Rust enhancements: |
diff --git a/documentation/migration-guides/release-notes-4.1.rst b/documentation/migration-guides/release-notes-4.1.rst index 119cc4fd2e..60402b6588 100644 --- a/documentation/migration-guides/release-notes-4.1.rst +++ b/documentation/migration-guides/release-notes-4.1.rst | |||
| @@ -58,7 +58,7 @@ New Features / Enhancements in 4.1 | |||
| 58 | - Dependency of -dev package on main package is now an :term:`RRECOMMENDS` and can be easily set via new :term:`DEV_PKG_DEPENDENCY` variable | 58 | - Dependency of -dev package on main package is now an :term:`RRECOMMENDS` and can be easily set via new :term:`DEV_PKG_DEPENDENCY` variable |
| 59 | 59 | ||
| 60 | - Support for CPU, I/O and memory pressure regulation in BitBake | 60 | - Support for CPU, I/O and memory pressure regulation in BitBake |
| 61 | - Pressure data gathering in ``buildstats`` and rendering in ``pybootchartgui`` | 61 | - Pressure data gathering in :ref:`buildstats <ref-classes-buildstats>` and rendering in ``pybootchartgui`` |
| 62 | 62 | ||
| 63 | - New Picobuild system for lightweight Python PEP-517 build support in the :ref:`python_pep517 <ref-classes-python_pep517>` class | 63 | - New Picobuild system for lightweight Python PEP-517 build support in the :ref:`python_pep517 <ref-classes-python_pep517>` class |
| 64 | 64 | ||
| @@ -99,8 +99,8 @@ New Features / Enhancements in 4.1 | |||
| 99 | - :ref:`Support for using the regular build system as an SDK <sdk-manual/extensible:Setting up the Extensible SDK environment directly in a Yocto build>` | 99 | - :ref:`Support for using the regular build system as an SDK <sdk-manual/extensible:Setting up the Extensible SDK environment directly in a Yocto build>` |
| 100 | - :ref:`image-buildinfo <ref-classes-image-buildinfo>` class now also writes build information to SDKs | 100 | - :ref:`image-buildinfo <ref-classes-image-buildinfo>` class now also writes build information to SDKs |
| 101 | - New :term:`SDK_TOOLCHAIN_LANGS` variable to control support of rust / go in SDK | 101 | - New :term:`SDK_TOOLCHAIN_LANGS` variable to control support of rust / go in SDK |
| 102 | - rust-llvm: enabled nativesdk variant | 102 | - rust-llvm: enabled :ref:`nativesdk <ref-classes-nativesdk>` variant |
| 103 | - python3-pluggy: enabled for native/nativesdk | 103 | - python3-pluggy: enabled for :ref:`native <ref-classes-native>` / :ref:`nativesdk <ref-classes-nativesdk>` |
| 104 | 104 | ||
| 105 | - QEMU/runqemu enhancements: | 105 | - QEMU/runqemu enhancements: |
| 106 | 106 | ||
| @@ -113,7 +113,8 @@ New Features / Enhancements in 4.1 | |||
| 113 | - New variable :term:`UBOOT_MKIMAGE_KERNEL_TYPE` | 113 | - New variable :term:`UBOOT_MKIMAGE_KERNEL_TYPE` |
| 114 | - New variable :term:`FIT_PAD_ALG` to control FIT image padding algorithm | 114 | - New variable :term:`FIT_PAD_ALG` to control FIT image padding algorithm |
| 115 | - New :term:`KERNEL_DEPLOY_DEPEND` variable to allow disabling image dependency on deploying the kernel | 115 | - New :term:`KERNEL_DEPLOY_DEPEND` variable to allow disabling image dependency on deploying the kernel |
| 116 | - image_types: isolate the write of UBI configuration to a ``write_ubi_config`` function that can be easily overridden | 116 | - :ref:`image_types <ref-classes-image_types>`: isolate the write of UBI |
| 117 | configuration to a ``write_ubi_config`` function that can be easily overridden | ||
| 117 | 118 | ||
| 118 | - openssh: add support for config snippet includes to ssh and sshd | 119 | - openssh: add support for config snippet includes to ssh and sshd |
| 119 | - :ref:`create-spdx <ref-classes-create-spdx>`: Add ``SPDX_PRETTY`` option | 120 | - :ref:`create-spdx <ref-classes-create-spdx>`: Add ``SPDX_PRETTY`` option |
