diff options
Diffstat (limited to 'documentation/migration-guides')
23 files changed, 165 insertions, 165 deletions
diff --git a/documentation/migration-guides/migration-1.3.rst b/documentation/migration-guides/migration-1.3.rst index a135574744..95f7e3572b 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 simplifies a | 94 | The suffix ``nativesdk`` is now implemented as a prefix, which simplifies a lot |
95 | lot of the packaging code for :ref:`nativesdk <ref-classes-nativesdk>` recipes. | 95 | of the packaging code for :ref:`ref-classes-nativesdk` recipes. All custom |
96 | All custom :ref:`nativesdk <ref-classes-nativesdk>` recipes, which are | 96 | :ref:`ref-classes-nativesdk` recipes, which are relocatable packages that are |
97 | relocatable packages that are native to :term:`SDK_ARCH`, and any references | 97 | native to :term:`SDK_ARCH`, and any references need to be updated to use |
98 | need to be updated to use ``nativesdk-*`` instead of ``*-nativesdk``. | 98 | ``nativesdk-*`` instead of ``*-nativesdk``. |
99 | 99 | ||
100 | .. _migration-1.3-task-recipes: | 100 | .. _migration-1.3-task-recipes: |
101 | 101 | ||
@@ -109,7 +109,7 @@ 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 | :ref:`packagegroup <ref-classes-packagegroup>` instead of ``task``, as well | 112 | :ref:`ref-classes-packagegroup` instead of ``task``, as well |
113 | as taking the opportunity to remove anything now handled by | 113 | as taking the opportunity to remove anything now handled by |
114 | :ref:`ref-classes-packagegroup`, such as providing ``-dev`` and ``-dbg`` | 114 | :ref:`ref-classes-packagegroup`, such as providing ``-dev`` and ``-dbg`` |
115 | packages, setting :term:`LIC_FILES_CHKSUM`, and so forth. See the | 115 | packages, setting :term:`LIC_FILES_CHKSUM`, and so forth. See the |
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst index 14b1f4a0a5..d82d33f91f 100644 --- a/documentation/migration-guides/migration-1.5.rst +++ b/documentation/migration-guides/migration-1.5.rst | |||
@@ -95,9 +95,8 @@ The following changes have been made to the package QA checks: | |||
95 | this file within :ref:`ref-tasks-install` if "make | 95 | this file within :ref:`ref-tasks-install` if "make |
96 | install" is installing it. | 96 | install" is installing it. |
97 | 97 | ||
98 | - If you are using the :ref:`buildhistory <ref-classes-buildhistory>` class, | 98 | - If you are using the :ref:`ref-classes-buildhistory` class, the check for the |
99 | the check for the package | 99 | package version going backwards is now controlled using a standard QA check. |
100 | version going backwards is now controlled using a standard QA check. | ||
101 | Thus, if you have customized your :term:`ERROR_QA` or :term:`WARN_QA` values | 100 | Thus, if you have customized your :term:`ERROR_QA` or :term:`WARN_QA` values |
102 | and still wish to have this check performed, you should add | 101 | and still wish to have this check performed, you should add |
103 | "version-going-backwards" to your value for one or the other | 102 | "version-going-backwards" to your value for one or the other |
@@ -131,7 +130,7 @@ The following directory changes exist: | |||
131 | it easier to delete :term:`TMPDIR` and preserve the build history. | 130 | it easier to delete :term:`TMPDIR` and preserve the build history. |
132 | 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`. |
133 | 132 | ||
134 | - When :ref:`buildhistory <ref-classes-buildhistory>` is enabled, its output | 133 | - When :ref:`ref-classes-buildhistory` is enabled, its output |
135 | is now written under the :term:`Build Directory` rather than :term:`TMPDIR`. | 134 | is now written under the :term:`Build Directory` rather than :term:`TMPDIR`. |
136 | Doing so makes it easier to delete :term:`TMPDIR` and preserve the build | 135 | Doing so makes it easier to delete :term:`TMPDIR` and preserve the build |
137 | history. Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`. | 136 | history. Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`. |
@@ -223,7 +222,7 @@ Task Recipes | |||
223 | The previously deprecated ``task.bbclass`` has now been dropped. For | 222 | The previously deprecated ``task.bbclass`` has now been dropped. For |
224 | recipes that previously inherited from this class, you should rename | 223 | recipes that previously inherited from this class, you should rename |
225 | them from ``task-*`` to ``packagegroup-*`` and inherit | 224 | them from ``task-*`` to ``packagegroup-*`` and inherit |
226 | :ref:`packagegroup <ref-classes-packagegroup>` instead. | 225 | :ref:`ref-classes-packagegroup` instead. |
227 | 226 | ||
228 | For more information, see the ":ref:`ref-classes-packagegroup`" section. | 227 | For more information, see the ":ref:`ref-classes-packagegroup`" section. |
229 | 228 | ||
diff --git a/documentation/migration-guides/migration-1.6.rst b/documentation/migration-guides/migration-1.6.rst index 1baf8b311a..48c7c7572e 100644 --- a/documentation/migration-guides/migration-1.6.rst +++ b/documentation/migration-guides/migration-1.6.rst | |||
@@ -11,9 +11,8 @@ Project 1.6 Release (codename "daisy") from the prior release. | |||
11 | ``archiver`` Class | 11 | ``archiver`` Class |
12 | ------------------ | 12 | ------------------ |
13 | 13 | ||
14 | The :ref:`archiver <ref-classes-archiver>` class has been rewritten | 14 | The :ref:`ref-classes-archiver` class has been rewritten and its configuration |
15 | and its configuration has been simplified. For more details on the | 15 | has been simplified. For more details on the source archiver, see the |
16 | source archiver, see the | ||
17 | ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" | 16 | ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" |
18 | section in the Yocto Project Development Tasks Manual. | 17 | section in the Yocto Project Development Tasks Manual. |
19 | 18 | ||
@@ -224,7 +223,7 @@ Package Tests (ptest) are built but not installed by default. For | |||
224 | information on using Package Tests, see the | 223 | information on using Package Tests, see the |
225 | ":ref:`dev-manual/packages:testing packages with ptest`" section in the | 224 | ":ref:`dev-manual/packages:testing packages with ptest`" section in the |
226 | Yocto Project Development Tasks Manual. For information on the | 225 | Yocto Project Development Tasks Manual. For information on the |
227 | :ref:`ptest <ref-classes-ptest>` class, see the ":ref:`ref-classes-ptest`" | 226 | :ref:`ref-classes-ptest` class, see the ":ref:`ref-classes-ptest`" |
228 | section. | 227 | section. |
229 | 228 | ||
230 | .. _migration-1.6-build-changes: | 229 | .. _migration-1.6-build-changes: |
@@ -234,13 +233,13 @@ Build Changes | |||
234 | 233 | ||
235 | Separate build and source directories have been enabled by default for | 234 | Separate build and source directories have been enabled by default for |
236 | selected recipes where it is known to work and for all | 235 | selected recipes where it is known to work and for all |
237 | recipes that inherit the :ref:`cmake <ref-classes-cmake>` class. In | 236 | recipes that inherit the :ref:`ref-classes-cmake` class. In |
238 | future releases the :ref:`autotools <ref-classes-autotools>` class | 237 | future releases the :ref:`ref-classes-autotools` class |
239 | will enable a separate :term:`Build Directory` by default as well. Recipes | 238 | will enable a separate :term:`Build Directory` by default as well. Recipes |
240 | building Autotools-based software that fails to build with a separate | 239 | building Autotools-based software that fails to build with a separate |
241 | :term:`Build Directory` should be changed to inherit from the | 240 | :term:`Build Directory` should be changed to inherit from the |
242 | :ref:`autotools-brokensep <ref-classes-autotools>` class instead of | 241 | :ref:`autotools-brokensep <ref-classes-autotools>` class instead of |
243 | the :ref:`autotools <ref-classes-autotools>` or ``autotools_stage`` classes. | 242 | the :ref:`ref-classes-autotools` or ``autotools_stage`` classes. |
244 | 243 | ||
245 | .. _migration-1.6-building-qemu-native: | 244 | .. _migration-1.6-building-qemu-native: |
246 | 245 | ||
diff --git a/documentation/migration-guides/migration-1.7.rst b/documentation/migration-guides/migration-1.7.rst index 94e9904b66..ca8222098a 100644 --- a/documentation/migration-guides/migration-1.7.rst +++ b/documentation/migration-guides/migration-1.7.rst | |||
@@ -41,13 +41,11 @@ section for more information. | |||
41 | Autotools Class Changes | 41 | Autotools Class Changes |
42 | ----------------------- | 42 | ----------------------- |
43 | 43 | ||
44 | The following :ref:`autotools <ref-classes-autotools>` class changes | 44 | The following :ref:`ref-classes-autotools` class changes occurred: |
45 | occurred: | ||
46 | 45 | ||
47 | - *A separate :term:`Build Directory` is now used by default:* The | 46 | - *A separate :term:`Build Directory` is now used by default:* The |
48 | :ref:`autotools <ref-classes-autotools>` class has been | 47 | :ref:`ref-classes-autotools` class has been changed to use a directory for |
49 | changed to use a directory for building | 48 | building (:term:`B`), which is separate from the source directory |
50 | (:term:`B`), which is separate from the source directory | ||
51 | (:term:`S`). This is commonly referred to as ``B != S``, or | 49 | (:term:`S`). This is commonly referred to as ``B != S``, or |
52 | an out-of-tree build. | 50 | an out-of-tree build. |
53 | 51 | ||
@@ -56,9 +54,8 @@ occurred: | |||
56 | However, if the software is not capable of being built in this | 54 | However, if the software is not capable of being built in this |
57 | manner, you will need to either patch the software so that it can | 55 | manner, you will need to either patch the software so that it can |
58 | build separately, or you will need to change the recipe to inherit | 56 | build separately, or you will need to change the recipe to inherit |
59 | the :ref:`autotools-brokensep <ref-classes-autotools>` class | 57 | the :ref:`autotools-brokensep <ref-classes-autotools>` class instead |
60 | instead of the :ref:`autotools <ref-classes-autotools>` | 58 | of the :ref:`ref-classes-autotools` or ``autotools_stage`` classes. |
61 | or ``autotools_stage`` classes. | ||
62 | 59 | ||
63 | - The ``--foreign`` option is no longer passed to ``automake`` when | 60 | - The ``--foreign`` option is no longer passed to ``automake`` when |
64 | running ``autoconf``: This option tells ``automake`` that a | 61 | running ``autoconf``: This option tells ``automake`` that a |
diff --git a/documentation/migration-guides/migration-1.8.rst b/documentation/migration-guides/migration-1.8.rst index 6a1f9ed56d..5cc5f8a047 100644 --- a/documentation/migration-guides/migration-1.8.rst +++ b/documentation/migration-guides/migration-1.8.rst | |||
@@ -70,17 +70,16 @@ the following:: | |||
70 | Kernel Build Changes | 70 | Kernel Build Changes |
71 | -------------------- | 71 | -------------------- |
72 | 72 | ||
73 | The kernel build process was changed to place the source in a common | 73 | The kernel build process was changed to place the source in a common shared work |
74 | shared work area and to place build artifacts separately in the source | 74 | area and to place build artifacts separately in the source code tree. In theory, |
75 | code tree. In theory, migration paths have been provided for most common | 75 | migration paths have been provided for most common usages in kernel recipes but |
76 | usages in kernel recipes but this might not work in all cases. In | 76 | this might not work in all cases. In particular, users need to ensure that |
77 | particular, users need to ensure that ``${S}`` (source files) and | 77 | ``${S}`` (source files) and ``${B}`` (build artifacts) are used correctly in |
78 | ``${B}`` (build artifacts) are used correctly in functions such as | 78 | functions such as :ref:`ref-tasks-configure` and :ref:`ref-tasks-install`. For |
79 | :ref:`ref-tasks-configure` and | 79 | kernel recipes that do not inherit from :ref:`ref-classes-kernel-yocto` or |
80 | :ref:`ref-tasks-install`. For kernel recipes that do not | 80 | include ``linux-yocto.inc``, you might wish to refer to the ``linux.inc`` file |
81 | inherit from :ref:`kernel-yocto <ref-classes-kernel-yocto>` or include ``linux-yocto.inc``, you might | 81 | in the ``meta-oe`` layer for the kinds of changes you need to make. For reference, |
82 | wish to refer to the ``linux.inc`` file in the ``meta-oe`` layer for the | 82 | here is the |
83 | kinds of changes you need to make. For reference, here is the | ||
84 | :oe_git:`commit </meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>` | 83 | :oe_git:`commit </meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>` |
85 | where the ``linux.inc`` file in ``meta-oe`` was updated. | 84 | where the ``linux.inc`` file in ``meta-oe`` was updated. |
86 | 85 | ||
@@ -123,10 +122,9 @@ need to take corrective steps. | |||
123 | Rebuild Improvements | 122 | Rebuild Improvements |
124 | -------------------- | 123 | -------------------- |
125 | 124 | ||
126 | Changes have been made to the :ref:`base <ref-classes-base>`, | 125 | Changes have been made to the :ref:`ref-classes-base`, |
127 | :ref:`autotools <ref-classes-autotools>`, and | 126 | :ref:`ref-classes-autotools`, and :ref:`ref-classes-cmake` classes to clean out |
128 | :ref:`cmake <ref-classes-cmake>` classes to clean out generated files | 127 | generated files when the :ref:`ref-tasks-configure` task needs to be |
129 | when the :ref:`ref-tasks-configure` task needs to be | ||
130 | re-executed. | 128 | re-executed. |
131 | 129 | ||
132 | One of the improvements is to attempt to run "make clean" during the | 130 | One of the improvements is to attempt to run "make clean" during the |
diff --git a/documentation/migration-guides/migration-2.0.rst b/documentation/migration-guides/migration-2.0.rst index 66b3c632f9..13be9846df 100644 --- a/documentation/migration-guides/migration-2.0.rst +++ b/documentation/migration-guides/migration-2.0.rst | |||
@@ -216,7 +216,7 @@ modifications synchronized, it is not always obvious to developers how | |||
216 | to manipulate the Metadata as compared to the source. | 216 | to manipulate the Metadata as compared to the source. |
217 | 217 | ||
218 | Metadata processing has now been removed from the | 218 | Metadata processing has now been removed from the |
219 | :ref:`kernel-yocto <ref-classes-kernel-yocto>` class and the external | 219 | :ref:`ref-classes-kernel-yocto` class and the external |
220 | Metadata repository ``yocto-kernel-cache``, which has always been used | 220 | Metadata repository ``yocto-kernel-cache``, which has always been used |
221 | to seed the ``linux-yocto`` "meta" branch. This separate ``linux-yocto`` | 221 | to seed the ``linux-yocto`` "meta" branch. This separate ``linux-yocto`` |
222 | cache repository is now the primary location for this data. Due to this | 222 | cache repository is now the primary location for this data. Due to this |
diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst index 01352acbfa..18b05b52cc 100644 --- a/documentation/migration-guides/migration-2.1.rst +++ b/documentation/migration-guides/migration-2.1.rst | |||
@@ -66,7 +66,7 @@ Makefile Environment Changes | |||
66 | :term:`EXTRA_OEMAKE` now defaults to "" instead of | 66 | :term:`EXTRA_OEMAKE` now defaults to "" instead of |
67 | "-e MAKEFLAGS=". Setting :term:`EXTRA_OEMAKE` to "-e MAKEFLAGS=" by default | 67 | "-e MAKEFLAGS=". Setting :term:`EXTRA_OEMAKE` to "-e MAKEFLAGS=" by default |
68 | was a historical accident that has required many classes (e.g. | 68 | was a historical accident that has required many classes (e.g. |
69 | :ref:`autotools <ref-classes-autotools>`, ``module``) and recipes to override this default in order | 69 | :ref:`ref-classes-autotools`, ``module``) and recipes to override this default in order |
70 | to work with sensible build systems. When upgrading to the release, you | 70 | to work with sensible build systems. When upgrading to the release, you |
71 | must edit any recipe that relies upon this old default by either setting | 71 | must edit any recipe that relies upon this old default by either setting |
72 | :term:`EXTRA_OEMAKE` back to "-e MAKEFLAGS=" or by explicitly setting any | 72 | :term:`EXTRA_OEMAKE` back to "-e MAKEFLAGS=" or by explicitly setting any |
@@ -100,7 +100,7 @@ breaking FHS. | |||
100 | ``ac_cv_sizeof_off_t`` is No Longer Cached in Site Files | 100 | ``ac_cv_sizeof_off_t`` is No Longer Cached in Site Files |
101 | -------------------------------------------------------- | 101 | -------------------------------------------------------- |
102 | 102 | ||
103 | For recipes inheriting the :ref:`autotools <ref-classes-autotools>` | 103 | For recipes inheriting the :ref:`ref-classes-autotools` |
104 | class, ``ac_cv_sizeof_off_t`` is no longer cached in the site files for | 104 | class, ``ac_cv_sizeof_off_t`` is no longer cached in the site files for |
105 | ``autoconf``. The reason for this change is because the | 105 | ``autoconf``. The reason for this change is because the |
106 | ``ac_cv_sizeof_off_t`` value is not necessarily static per architecture | 106 | ``ac_cv_sizeof_off_t`` value is not necessarily static per architecture |
@@ -108,12 +108,12 @@ as was previously assumed. Rather, the value changes based on whether | |||
108 | large file support is enabled. For most software that uses ``autoconf``, | 108 | large file support is enabled. For most software that uses ``autoconf``, |
109 | this change should not be a problem. However, if you have a recipe that | 109 | this change should not be a problem. However, if you have a recipe that |
110 | bypasses the standard :ref:`ref-tasks-configure` task | 110 | bypasses the standard :ref:`ref-tasks-configure` task |
111 | from the :ref:`autotools <ref-classes-autotools>` class and the software the recipe is building | 111 | from the :ref:`ref-classes-autotools` class and the software the recipe is building |
112 | uses a very old version of ``autoconf``, the recipe might be incapable | 112 | uses a very old version of ``autoconf``, the recipe might be incapable |
113 | of determining the correct size of ``off_t`` during :ref:`ref-tasks-configure`. | 113 | of determining the correct size of ``off_t`` during :ref:`ref-tasks-configure`. |
114 | 114 | ||
115 | The best course of action is to patch the software as necessary to allow | 115 | The best course of action is to patch the software as necessary to allow |
116 | the default implementation from the :ref:`autotools <ref-classes-autotools>` class to work such | 116 | the default implementation from the :ref:`ref-classes-autotools` class to work such |
117 | that ``autoreconf`` succeeds and produces a working configure script, | 117 | that ``autoreconf`` succeeds and produces a working configure script, |
118 | and to remove the overridden :ref:`ref-tasks-configure` task such that the default | 118 | and to remove the overridden :ref:`ref-tasks-configure` task such that the default |
119 | implementation does get used. | 119 | implementation does get used. |
@@ -138,9 +138,8 @@ should make edits so that those tasks are after the | |||
138 | after :ref:`ref-tasks-rootfs` so that your added tasks run at the correct | 138 | after :ref:`ref-tasks-rootfs` so that your added tasks run at the correct |
139 | time. | 139 | time. |
140 | 140 | ||
141 | A minor part of this restructuring is that the post-processing | 141 | A minor part of this restructuring is that the post-processing definitions and |
142 | definitions and functions have been moved from the | 142 | functions have been moved from the :ref:`ref-classes-image` class to the |
143 | :ref:`image <ref-classes-image>` class to the | ||
144 | :ref:`rootfs-postcommands <ref-classes-rootfs*>` class. Functionally, | 143 | :ref:`rootfs-postcommands <ref-classes-rootfs*>` class. Functionally, |
145 | however, they remain unchanged. | 144 | however, they remain unchanged. |
146 | 145 | ||
@@ -191,18 +190,17 @@ Class Changes | |||
191 | The following classes have changed: | 190 | The following classes have changed: |
192 | 191 | ||
193 | - ``autotools_stage``: Removed because the | 192 | - ``autotools_stage``: Removed because the |
194 | :ref:`autotools <ref-classes-autotools>` class now provides its | 193 | :ref:`ref-classes-autotools` class now provides its |
195 | functionality. Recipes that inherited from ``autotools_stage`` should | 194 | functionality. Recipes that inherited from ``autotools_stage`` should |
196 | now inherit from :ref:`autotools <ref-classes-autotools>` instead. | 195 | now inherit from :ref:`ref-classes-autotools` instead. |
197 | 196 | ||
198 | - ``boot-directdisk``: Merged into the ``image-vm`` class. The | 197 | - ``boot-directdisk``: Merged into the ``image-vm`` class. The |
199 | ``boot-directdisk`` class was rarely directly used. Consequently, | 198 | ``boot-directdisk`` class was rarely directly used. Consequently, |
200 | this change should not cause any issues. | 199 | this change should not cause any issues. |
201 | 200 | ||
202 | - ``bootimg``: Merged into the | 201 | - ``bootimg``: Merged into the :ref:`ref-classes-image-live` class. The |
203 | :ref:`image-live <ref-classes-image-live>` class. The ``bootimg`` | 202 | ``bootimg`` class was rarely directly used. Consequently, this change should |
204 | class was rarely directly used. Consequently, this change should not | 203 | not cause any issues. |
205 | cause any issues. | ||
206 | 204 | ||
207 | - ``packageinfo``: Removed due to its limited use by the Hob UI, which | 205 | - ``packageinfo``: Removed due to its limited use by the Hob UI, which |
208 | has itself been removed. | 206 | has itself been removed. |
@@ -257,14 +255,14 @@ The following changes have been made for the Poky distribution: | |||
257 | not need to change anything unless you are relying on this naming | 255 | not need to change anything unless you are relying on this naming |
258 | elsewhere. | 256 | elsewhere. |
259 | 257 | ||
260 | - The :ref:`uninative <ref-classes-uninative>` class is now enabled | 258 | - The :ref:`ref-classes-uninative` class is now enabled |
261 | by default in Poky. This class attempts to isolate the build system | 259 | by default in Poky. This class attempts to isolate the build system |
262 | from the host distribution's C library and makes re-use of native | 260 | from the host distribution's C library and makes re-use of native |
263 | shared state artifacts across different host distributions practical. | 261 | shared state artifacts across different host distributions practical. |
264 | With this class enabled, a tarball containing a pre-built C library | 262 | With this class enabled, a tarball containing a pre-built C library |
265 | is downloaded at the start of the build. | 263 | is downloaded at the start of the build. |
266 | 264 | ||
267 | The :ref:`uninative <ref-classes-uninative>` class is enabled through the | 265 | The :ref:`ref-classes-uninative` class is enabled through the |
268 | ``meta/conf/distro/include/yocto-uninative.inc`` file, which for | 266 | ``meta/conf/distro/include/yocto-uninative.inc`` file, which for |
269 | those not using the Poky distribution, can include to easily enable | 267 | those not using the Poky distribution, can include to easily enable |
270 | the same functionality. | 268 | the same functionality. |
@@ -403,9 +401,9 @@ These additional changes exist: | |||
403 | as these directories are automatically found and added. | 401 | as these directories are automatically found and added. |
404 | 402 | ||
405 | - Inaccurate disk and CPU percentage data has been dropped from | 403 | - Inaccurate disk and CPU percentage data has been dropped from |
406 | :ref:`buildstats <ref-classes-buildstats>` output. This data has been replaced with | 404 | :ref:`ref-classes-buildstats` output. This data has been replaced with |
407 | ``getrusage()`` data and corrected IO statistics. You will probably | 405 | ``getrusage()`` data and corrected IO statistics. You will probably |
408 | need to update any custom code that reads the :ref:`buildstats <ref-classes-buildstats>` data. | 406 | need to update any custom code that reads the :ref:`ref-classes-buildstats` data. |
409 | 407 | ||
410 | - The ``meta/conf/distro/include/package_regex.inc`` is now deprecated. | 408 | - The ``meta/conf/distro/include/package_regex.inc`` is now deprecated. |
411 | 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 6126af857d..38117d41b4 100644 --- a/documentation/migration-guides/migration-2.3.rst +++ b/documentation/migration-guides/migration-2.3.rst | |||
@@ -52,7 +52,7 @@ Consider the following: | |||
52 | post-installation script that is installed by a function added to | 52 | post-installation script that is installed by a function added to |
53 | :term:`SYSROOT_PREPROCESS_FUNCS`. | 53 | :term:`SYSROOT_PREPROCESS_FUNCS`. |
54 | 54 | ||
55 | For an example, see the :ref:`pixbufcache <ref-classes-pixbufcache>` class in ``meta/classes/`` in | 55 | For an example, see the :ref:`ref-classes-pixbufcache` class in ``meta/classes/`` in |
56 | the :ref:`overview-manual/development-environment:yocto project source repositories`. | 56 | the :ref:`overview-manual/development-environment:yocto project source repositories`. |
57 | 57 | ||
58 | .. note:: | 58 | .. note:: |
@@ -402,7 +402,7 @@ The following QA checks have changed: | |||
402 | warning, you need to address missing runtime dependencies. | 402 | warning, you need to address missing runtime dependencies. |
403 | 403 | ||
404 | For additional information, see the | 404 | For additional information, see the |
405 | :ref:`insane <ref-classes-insane>` class and the | 405 | :ref:`ref-classes-insane` class and the |
406 | ":ref:`ref-manual/qa-checks:errors and warnings`" section. | 406 | ":ref:`ref-manual/qa-checks:errors and warnings`" section. |
407 | 407 | ||
408 | .. _migration-2.3-miscellaneous-changes: | 408 | .. _migration-2.3-miscellaneous-changes: |
@@ -446,7 +446,7 @@ The following miscellaneous changes have occurred: | |||
446 | RSA keys only, and with recent versions of OpenSSH, which deprecates | 446 | RSA keys only, and with recent versions of OpenSSH, which deprecates |
447 | DSA host keys. | 447 | DSA host keys. |
448 | 448 | ||
449 | - The :ref:`buildhistory <ref-classes-buildhistory>` class now | 449 | - The :ref:`ref-classes-buildhistory` class now |
450 | correctly uses tabs as separators between all columns in | 450 | correctly uses tabs as separators between all columns in |
451 | ``installed-package-sizes.txt`` in order to aid import into other | 451 | ``installed-package-sizes.txt`` in order to aid import into other |
452 | tools. | 452 | tools. |
@@ -484,26 +484,24 @@ The following miscellaneous changes have occurred: | |||
484 | 484 | ||
485 | If you need to preserve these ``.la`` files (e.g. in a custom | 485 | If you need to preserve these ``.la`` files (e.g. in a custom |
486 | distribution), you must change :term:`INHERIT_DISTRO` such that | 486 | distribution), you must change :term:`INHERIT_DISTRO` such that |
487 | ":ref:`remove-libtool <ref-classes-remove-libtool>`" is not included | 487 | ":ref:`ref-classes-remove-libtool`" is not included |
488 | in the value. | 488 | in the value. |
489 | 489 | ||
490 | - Extensible SDKs built for GCC 5+ now refuse to install on a | 490 | - Extensible SDKs built for GCC 5+ now refuse to install on a |
491 | distribution where the host GCC version is 4.8 or 4.9. This change | 491 | distribution where the host GCC version is 4.8 or 4.9. This change |
492 | resulted from the fact that the installation is known to fail due to | 492 | resulted from the fact that the installation is known to fail due to |
493 | the way the ``uninative`` shared state (sstate) package is built. See | 493 | the way the ``uninative`` shared state (sstate) package is built. See |
494 | the :ref:`uninative <ref-classes-uninative>` class for additional | 494 | the :ref:`ref-classes-uninative` class for additional information. |
495 | information. | ||
496 | 495 | ||
497 | - All :ref:`native <ref-classes-native>` and | 496 | - All :ref:`ref-classes-native` and :ref:`ref-classes-nativesdk` recipes now |
498 | :ref:`nativesdk <ref-classes-nativesdk>` recipes now use a separate | 497 | use a separate :term:`DISTRO_FEATURES` value instead of sharing the value |
499 | :term:`DISTRO_FEATURES` value instead of sharing the value used by | 498 | used by recipes for the target, in order to avoid unnecessary rebuilds. |
500 | recipes for the target, in order to avoid unnecessary rebuilds. | ||
501 | 499 | ||
502 | The :term:`DISTRO_FEATURES` for :ref:`native <ref-classes-native>` recipes | 500 | The :term:`DISTRO_FEATURES` for :ref:`ref-classes-native` recipes |
503 | is :term:`DISTRO_FEATURES_NATIVE` added to an intersection of | 501 | is :term:`DISTRO_FEATURES_NATIVE` added to an intersection of |
504 | :term:`DISTRO_FEATURES` and :term:`DISTRO_FEATURES_FILTER_NATIVE`. | 502 | :term:`DISTRO_FEATURES` and :term:`DISTRO_FEATURES_FILTER_NATIVE`. |
505 | 503 | ||
506 | For :ref:`nativesdk <ref-classes-nativesdk>` recipes, the corresponding | 504 | For :ref:`ref-classes-nativesdk` recipes, the corresponding |
507 | variables are :term:`DISTRO_FEATURES_NATIVESDK` and | 505 | variables are :term:`DISTRO_FEATURES_NATIVESDK` and |
508 | :term:`DISTRO_FEATURES_FILTER_NATIVESDK`. | 506 | :term:`DISTRO_FEATURES_FILTER_NATIVESDK`. |
509 | 507 | ||
diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst index 74149f8058..9637301a47 100644 --- a/documentation/migration-guides/migration-2.4.rst +++ b/documentation/migration-guides/migration-2.4.rst | |||
@@ -197,12 +197,10 @@ Kernel Device Tree Move | |||
197 | ----------------------- | 197 | ----------------------- |
198 | 198 | ||
199 | Kernel Device Tree support is now easier to enable in a kernel recipe. | 199 | Kernel Device Tree support is now easier to enable in a kernel recipe. |
200 | The Device Tree code has moved to a | 200 | The Device Tree code has moved to a :ref:`ref-classes-kernel-devicetree` class. |
201 | :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class. | ||
202 | Functionality is automatically enabled for any recipe that inherits the | 201 | Functionality is automatically enabled for any recipe that inherits the |
203 | :ref:`kernel <ref-classes-kernel>` class and sets the | 202 | :ref:`kernel <ref-classes-kernel>` class and sets the :term:`KERNEL_DEVICETREE` |
204 | :term:`KERNEL_DEVICETREE` variable. The | 203 | variable. The previous mechanism for doing this, |
205 | previous mechanism for doing this, | ||
206 | ``meta/recipes-kernel/linux/linux-dtb.inc``, is still available to avoid | 204 | ``meta/recipes-kernel/linux/linux-dtb.inc``, is still available to avoid |
207 | breakage, but triggers a deprecation warning. Future releases of the | 205 | breakage, but triggers a deprecation warning. Future releases of the |
208 | Yocto Project will remove ``meta/recipes-kernel/linux/linux-dtb.inc``. | 206 | Yocto Project will remove ``meta/recipes-kernel/linux/linux-dtb.inc``. |
@@ -271,11 +269,11 @@ The following are additional changes: | |||
271 | from ``meta-poky`` to OE-Core (i.e. from | 269 | from ``meta-poky`` to OE-Core (i.e. from |
272 | ``meta-poky/conf/distro/include`` to ``meta/conf/distro/include``). | 270 | ``meta-poky/conf/distro/include`` to ``meta/conf/distro/include``). |
273 | 271 | ||
274 | - The :ref:`buildhistory <ref-classes-buildhistory>` class now makes | 272 | - The :ref:`ref-classes-buildhistory` class now makes |
275 | a single commit per build rather than one commit per subdirectory in | 273 | a single commit per build rather than one commit per subdirectory in |
276 | the repository. This behavior assumes the commits are enabled with | 274 | the repository. This behavior assumes the commits are enabled with |
277 | :term:`BUILDHISTORY_COMMIT` = "1", which | 275 | :term:`BUILDHISTORY_COMMIT` = "1", which |
278 | is typical. Previously, the :ref:`buildhistory <ref-classes-buildhistory>` class made one commit | 276 | is typical. Previously, the :ref:`ref-classes-buildhistory` class made one commit |
279 | per subdirectory in the repository in order to make it easier to see | 277 | per subdirectory in the repository in order to make it easier to see |
280 | the changes for a particular subdirectory. To view a particular | 278 | the changes for a particular subdirectory. To view a particular |
281 | change, specify that subdirectory as the last parameter on the | 279 | change, specify that subdirectory as the last parameter on the |
diff --git a/documentation/migration-guides/migration-2.5.rst b/documentation/migration-guides/migration-2.5.rst index 8456c2306a..9f089bb93b 100644 --- a/documentation/migration-guides/migration-2.5.rst +++ b/documentation/migration-guides/migration-2.5.rst | |||
@@ -139,7 +139,7 @@ The following are BitBake changes: | |||
139 | - Several explicit "run this task for all recipes in the dependency | 139 | - Several explicit "run this task for all recipes in the dependency |
140 | tree" tasks have been removed (e.g. ``fetchall``, ``checkuriall``, | 140 | tree" tasks have been removed (e.g. ``fetchall``, ``checkuriall``, |
141 | and the ``*all`` tasks provided by the ``distrodata`` and | 141 | and the ``*all`` tasks provided by the ``distrodata`` and |
142 | :ref:`archiver <ref-classes-archiver>` classes). There is a BitBake option to complete this for | 142 | :ref:`ref-classes-archiver` classes). There is a BitBake option to complete this for |
143 | any arbitrary task. For example:: | 143 | any arbitrary task. For example:: |
144 | 144 | ||
145 | bitbake <target> -c fetchall | 145 | bitbake <target> -c fetchall |
@@ -189,7 +189,7 @@ Miscellaneous Changes | |||
189 | 189 | ||
190 | The following are additional changes: | 190 | The following are additional changes: |
191 | 191 | ||
192 | - The :ref:`kernel <ref-classes-kernel>` class supports building packages for multiple kernels. | 192 | - The :ref:`ref-classes-kernel` class supports building packages for multiple kernels. |
193 | If your kernel recipe or ``.bbappend`` file mentions packaging at | 193 | If your kernel recipe or ``.bbappend`` file mentions packaging at |
194 | all, you should replace references to the kernel in package names | 194 | all, you should replace references to the kernel in package names |
195 | with ``${KERNEL_PACKAGE_NAME}``. For example, if you disable | 195 | with ``${KERNEL_PACKAGE_NAME}``. For example, if you disable |
@@ -197,7 +197,7 @@ The following are additional changes: | |||
197 | ``RDEPENDS_kernel-base = ""`` you can avoid warnings using | 197 | ``RDEPENDS_kernel-base = ""`` you can avoid warnings using |
198 | ``RDEPENDS_${KERNEL_PACKAGE_NAME}-base = ""`` instead. | 198 | ``RDEPENDS_${KERNEL_PACKAGE_NAME}-base = ""`` instead. |
199 | 199 | ||
200 | - The :ref:`buildhistory <ref-classes-buildhistory>` class commits changes to the repository by | 200 | - The :ref:`ref-classes-buildhistory` class commits changes to the repository by |
201 | default so you no longer need to set ``BUILDHISTORY_COMMIT = "1"``. | 201 | default so you no longer need to set ``BUILDHISTORY_COMMIT = "1"``. |
202 | If you want to disable commits you need to set | 202 | If you want to disable commits you need to set |
203 | ``BUILDHISTORY_COMMIT = "0"`` in your configuration. | 203 | ``BUILDHISTORY_COMMIT = "0"`` in your configuration. |
@@ -209,12 +209,12 @@ The following are additional changes: | |||
209 | maintains a full-featured BSP in the ``meta-ti`` layer. This rename | 209 | maintains a full-featured BSP in the ``meta-ti`` layer. This rename |
210 | avoids the previous name clash that existed between the two BSPs. | 210 | avoids the previous name clash that existed between the two BSPs. |
211 | 211 | ||
212 | - The :ref:`update-alternatives <ref-classes-update-alternatives>` class no longer works with SysV ``init`` | 212 | - The :ref:`ref-classes-update-alternatives` class no longer works with SysV ``init`` |
213 | scripts because this usage has been problematic. Also, the | 213 | scripts because this usage has been problematic. Also, the |
214 | ``sysklogd`` recipe no longer uses ``update-alternatives`` because it | 214 | ``sysklogd`` recipe no longer uses ``update-alternatives`` because it |
215 | is incompatible with other implementations. | 215 | is incompatible with other implementations. |
216 | 216 | ||
217 | - By default, the :ref:`cmake <ref-classes-cmake>` class uses | 217 | - By default, the :ref:`ref-classes-cmake` class uses |
218 | ``ninja`` instead of ``make`` for building. This improves build | 218 | ``ninja`` instead of ``make`` for building. This improves build |
219 | performance. If a recipe is broken with ``ninja``, then the recipe | 219 | performance. If a recipe is broken with ``ninja``, then the recipe |
220 | can set ``OECMAKE_GENERATOR = "Unix Makefiles"`` to change back to | 220 | can set ``OECMAKE_GENERATOR = "Unix Makefiles"`` to change back to |
diff --git a/documentation/migration-guides/migration-2.6.rst b/documentation/migration-guides/migration-2.6.rst index 356f720850..477714b489 100644 --- a/documentation/migration-guides/migration-2.6.rst +++ b/documentation/migration-guides/migration-2.6.rst | |||
@@ -128,10 +128,9 @@ missing from :term:`DEPENDS`). | |||
128 | 128 | ||
129 | .. note:: | 129 | .. note:: |
130 | 130 | ||
131 | This change affects classes beyond just the two mentioned (i.e. | 131 | This change affects classes beyond just the two mentioned (i.e. ``distutils`` |
132 | ``distutils`` and ``distutils3``). Any recipe that inherits ``distutils*`` | 132 | and ``distutils3``). Any recipe that inherits ``distutils*`` classes are |
133 | classes are affected. For example, the ``setuptools`` and | 133 | affected. For example, the ``setuptools`` and :ref:`ref-classes-setuptools3` |
134 | :ref:`setuptools3 <ref-classes-setuptools3>` | ||
135 | recipes are affected since they inherit the ``distutils*`` classes. | 134 | recipes are affected since they inherit the ``distutils*`` classes. |
136 | 135 | ||
137 | Fetching these types of dependencies that are not provided in the | 136 | Fetching these types of dependencies that are not provided in the |
@@ -315,12 +314,11 @@ This section provides information about automatic testing changes: | |||
315 | exists and has been replaced by the | 314 | exists and has been replaced by the |
316 | :term:`TESTIMAGE_AUTO` variable. | 315 | :term:`TESTIMAGE_AUTO` variable. |
317 | 316 | ||
318 | - Inheriting the :ref:`testimage <ref-classes-testimage>` and | 317 | - Inheriting the :ref:`ref-classes-testimage` and :ref:`ref-classes-testsdk` |
319 | :ref:`testsdk <ref-classes-testsdk>` classes: best practices now dictate | 318 | classes: best practices now dictate that you use the :term:`IMAGE_CLASSES` |
320 | that you use the :term:`IMAGE_CLASSES` variable rather than the | 319 | variable rather than the :term:`INHERIT` variable when you inherit the |
321 | :term:`INHERIT` variable when you inherit the | 320 | :ref:`ref-classes-testimage` and :ref:`ref-classes-testsdk` classes used |
322 | :ref:`testimage <ref-classes-testimage>` and | 321 | for automatic testing. |
323 | :ref:`testsdk <ref-classes-testsdk>` classes used for automatic testing. | ||
324 | 322 | ||
325 | .. _migration-2.6-openssl-changes: | 323 | .. _migration-2.6-openssl-changes: |
326 | 324 | ||
diff --git a/documentation/migration-guides/migration-2.7.rst b/documentation/migration-guides/migration-2.7.rst index 6b17ceb90b..c49d2f05d2 100644 --- a/documentation/migration-guides/migration-2.7.rst +++ b/documentation/migration-guides/migration-2.7.rst | |||
@@ -174,8 +174,7 @@ The following miscellaneous changes occurred: | |||
174 | - ``base/pixbufcache``: Obsolete ``sstatecompletions`` code has been | 174 | - ``base/pixbufcache``: Obsolete ``sstatecompletions`` code has been |
175 | removed. | 175 | removed. |
176 | 176 | ||
177 | - :ref:`native <ref-classes-native>` class: | 177 | - :ref:`ref-classes-native` class: :term:`RDEPENDS` handling has been enabled. |
178 | :term:`RDEPENDS` handling has been enabled. | ||
179 | 178 | ||
180 | - ``inetutils``: This recipe has rsh disabled. | 179 | - ``inetutils``: This recipe has rsh disabled. |
181 | 180 | ||
diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst index 5ecfe2d54a..8e7a58e74d 100644 --- a/documentation/migration-guides/migration-3.0.rst +++ b/documentation/migration-guides/migration-3.0.rst | |||
@@ -49,7 +49,7 @@ The following recipes have been removed. | |||
49 | - ``core-image-lsb-sdk``: Part of removed LSB support. | 49 | - ``core-image-lsb-sdk``: Part of removed LSB support. |
50 | 50 | ||
51 | - ``cve-check-tool``: Functionally replaced by the ``cve-update-db`` | 51 | - ``cve-check-tool``: Functionally replaced by the ``cve-update-db`` |
52 | recipe and :ref:`cve-check <ref-classes-cve-check>` class. | 52 | recipe and :ref:`ref-classes-cve-check` class. |
53 | 53 | ||
54 | - ``eglinfo``: No longer maintained. ``eglinfo`` from ``mesa-demos`` is | 54 | - ``eglinfo``: No longer maintained. ``eglinfo`` from ``mesa-demos`` is |
55 | an adequate and maintained alternative. | 55 | an adequate and maintained alternative. |
@@ -144,7 +144,7 @@ CVE Checking | |||
144 | ------------ | 144 | ------------ |
145 | 145 | ||
146 | ``cve-check-tool`` has been functionally replaced by a new | 146 | ``cve-check-tool`` has been functionally replaced by a new |
147 | ``cve-update-db`` recipe and functionality built into the :ref:`cve-check <ref-classes-cve-check>` | 147 | ``cve-update-db`` recipe and functionality built into the :ref:`ref-classes-cve-check` |
148 | class. The result uses NVD JSON data feeds rather than the deprecated | 148 | class. The result uses NVD JSON data feeds rather than the deprecated |
149 | XML feeds that ``cve-check-tool`` was using, supports CVSSv3 scoring, | 149 | XML feeds that ``cve-check-tool`` was using, supports CVSSv3 scoring, |
150 | and makes other improvements. | 150 | and makes other improvements. |
@@ -287,7 +287,7 @@ The following miscellaneous changes have occurred. | |||
287 | :term:`NATIVELSBSTRING` to use all lowercase | 287 | :term:`NATIVELSBSTRING` to use all lowercase |
288 | characters even if it does not contain a version number. This change | 288 | characters even if it does not contain a version number. This change |
289 | is necessary only if you are not using | 289 | is necessary only if you are not using |
290 | :ref:`uninative <ref-classes-uninative>` and :term:`SANITY_TESTED_DISTROS`. | 290 | :ref:`ref-classes-uninative` and :term:`SANITY_TESTED_DISTROS`. |
291 | 291 | ||
292 | - In the ``base-files`` recipe, writing the hostname into | 292 | - In the ``base-files`` recipe, writing the hostname into |
293 | ``/etc/hosts`` and ``/etc/hostname`` is now done within the main | 293 | ``/etc/hosts`` and ``/etc/hostname`` is now done within the main |
diff --git a/documentation/migration-guides/migration-3.1.rst b/documentation/migration-guides/migration-3.1.rst index cbad40112b..fdb959c4af 100644 --- a/documentation/migration-guides/migration-3.1.rst +++ b/documentation/migration-guides/migration-3.1.rst | |||
@@ -127,7 +127,7 @@ renamed to ``features_check``; the ``distro_features_check`` class still | |||
127 | exists but generates a warning and redirects to the new class. In | 127 | exists but generates a warning and redirects to the new class. In |
128 | preparation for a future removal of the old class it is recommended that | 128 | preparation for a future removal of the old class it is recommended that |
129 | you update recipes currently inheriting ``distro_features_check`` to | 129 | you update recipes currently inheriting ``distro_features_check`` to |
130 | inherit :ref:`features_check <ref-classes-features_check>` instead. | 130 | inherit :ref:`ref-classes-features_check` instead. |
131 | 131 | ||
132 | .. _migration-3.1-removed-classes: | 132 | .. _migration-3.1-removed-classes: |
133 | 133 | ||
@@ -240,10 +240,10 @@ Warnings will now be shown at :ref:`ref-tasks-package_qa` time in the following | |||
240 | circumstances: | 240 | circumstances: |
241 | 241 | ||
242 | - A recipe installs ``.desktop`` files containing ``MimeType`` keys but | 242 | - A recipe installs ``.desktop`` files containing ``MimeType`` keys but |
243 | does not inherit the new :ref:`mime-xdg <ref-classes-mime-xdg>` class | 243 | does not inherit the new :ref:`ref-classes-mime-xdg` class |
244 | 244 | ||
245 | - A recipe installs ``.xml`` files into ``${datadir}/mime/packages`` | 245 | - A recipe installs ``.xml`` files into ``${datadir}/mime/packages`` |
246 | but does not inherit the :ref:`mime <ref-classes-mime>` class | 246 | but does not inherit the :ref:`ref-classes-mime` class |
247 | 247 | ||
248 | .. _migration-3.1-x86-live-wic: | 248 | .. _migration-3.1-x86-live-wic: |
249 | 249 | ||
diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index b53f2b7802..c538df04d2 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst | |||
@@ -177,13 +177,23 @@ errors: | |||
177 | 177 | ||
178 | In addition, the following new checks were added and default to triggering an error: | 178 | In addition, the following new checks were added and default to triggering an error: |
179 | 179 | ||
180 | - :ref:`shebang-size <qa-check-shebang-size>`: Check for shebang (#!) lines longer than 128 characters, which can give an error at runtime depending on the operating system. | 180 | - :ref:`shebang-size <qa-check-shebang-size>`: Check for shebang (#!) lines |
181 | longer than 128 characters, which can give an error at runtime depending on | ||
182 | the operating system. | ||
181 | 183 | ||
182 | - :ref:`unhandled-features-check <qa-check-unhandled-features-check>`: Check if any of the variables supported by the :ref:`features_check <ref-classes-features_check>` class is set while not inheriting the class itself. | 184 | - :ref:`unhandled-features-check <qa-check-unhandled-features-check>`: Check |
185 | if any of the variables supported by the :ref:`ref-classes-features_check` | ||
186 | class is set while not inheriting the class itself. | ||
183 | 187 | ||
184 | - :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. | 188 | - :ref:`missing-update-alternatives <qa-check-missing-update-alternatives>`: |
189 | Check if the recipe sets the :term:`ALTERNATIVE` variable for any of its | ||
190 | packages, and does not inherit the :ref:`ref-classes-update-alternatives` | ||
191 | class. | ||
185 | 192 | ||
186 | - 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. | 193 | - A trailing slash or duplicated slashes in the value of :term:`S` or :term:`B` |
194 | will now trigger a warning so that they can be removed and path comparisons | ||
195 | can be more reliable --- remove any instances of these in your recipes if the | ||
196 | warning is displayed. | ||
187 | 197 | ||
188 | 198 | ||
189 | .. _migration-3.2-src-uri-file-globbing: | 199 | .. _migration-3.2-src-uri-file-globbing: |
@@ -209,9 +219,18 @@ files into a subdirectory and reference that instead. | |||
209 | deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` | 219 | deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` |
210 | ---------------------------------------------------------- | 220 | ---------------------------------------------------------- |
211 | 221 | ||
212 | :ref:`ref-tasks-deploy` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as :ref:`ref-tasks-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. | 222 | :ref:`ref-tasks-deploy` as implemented in the :ref:`ref-classes-deploy` class |
223 | now cleans up ${:term:`DEPLOYDIR`} before running, just as | ||
224 | :ref:`ref-tasks-install` cleans up ${:term:`D`} before running. This reduces | ||
225 | the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from | ||
226 | previous runs, possibly even with different config, in case of incremental | ||
227 | builds. | ||
213 | 228 | ||
214 | Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` class or interact with :ref:`ref-tasks-deploy` are unlikely to be affected by this unless they add ``prefuncs`` to :ref:`ref-tasks-deploy` *which also* put files into ``${DEPLOYDIR}`` --- these should be refactored to use ``do_deploy_prepend`` instead. | 229 | Most recipes and classes that inherit the :ref:`ref-classes-deploy` class or |
230 | interact with :ref:`ref-tasks-deploy` are unlikely to be affected by this | ||
231 | unless they add ``prefuncs`` to :ref:`ref-tasks-deploy` *which also* put files | ||
232 | into ``${DEPLOYDIR}`` --- these should be refactored to use | ||
233 | ``do_deploy_prepend`` instead. | ||
215 | 234 | ||
216 | 235 | ||
217 | .. _migration-3.2-nativesdk-sdk-provides-dummy: | 236 | .. _migration-3.2-nativesdk-sdk-provides-dummy: |
@@ -219,7 +238,7 @@ Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` cla | |||
219 | Custom SDK / SDK-style recipes need to include ``nativesdk-sdk-provides-dummy`` | 238 | Custom SDK / SDK-style recipes need to include ``nativesdk-sdk-provides-dummy`` |
220 | ------------------------------------------------------------------------------- | 239 | ------------------------------------------------------------------------------- |
221 | 240 | ||
222 | All :ref:`nativesdk <ref-classes-nativesdk>` packages require ``/bin/sh`` due | 241 | All :ref:`ref-classes-nativesdk` packages require ``/bin/sh`` due |
223 | to their postinstall scriptlets, thus this package has to be dummy-provided | 242 | to their postinstall scriptlets, thus this package has to be dummy-provided |
224 | within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have | 243 | within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have |
225 | a custom SDK recipe (or your own SDK-style recipe similar to e.g. | 244 | a custom SDK recipe (or your own SDK-style recipe similar to e.g. |
diff --git a/documentation/migration-guides/migration-3.3.rst b/documentation/migration-guides/migration-3.3.rst index 16d5e2a3ee..d1e589d7b4 100644 --- a/documentation/migration-guides/migration-3.3.rst +++ b/documentation/migration-guides/migration-3.3.rst | |||
@@ -63,13 +63,13 @@ need to update those. | |||
63 | New ``python3targetconfig`` class | 63 | New ``python3targetconfig`` class |
64 | --------------------------------- | 64 | --------------------------------- |
65 | 65 | ||
66 | A new :ref:`python3targetconfig <ref-classes-python3targetconfig>` class has | 66 | A new :ref:`ref-classes-python3targetconfig` class has |
67 | been created for situations where you would previously have inherited the | 67 | been created for situations where you would previously have inherited the |
68 | :ref:`python3native <ref-classes-python3native>` class but need access to | 68 | :ref:`ref-classes-python3native` class but need access to |
69 | target configuration data (such as correct installation directories). Recipes | 69 | target configuration data (such as correct installation directories). Recipes |
70 | where this situation applies should be changed to inherit | 70 | where this situation applies should be changed to inherit |
71 | :ref:`python3targetconfig <ref-classes-python3targetconfig>` instead of | 71 | :ref:`ref-classes-python3targetconfig` instead of |
72 | :ref:`python3native <ref-classes-python3native>`. This also adds a dependency | 72 | :ref:`ref-classes-python3native`. This also adds a dependency |
73 | on target ``python3``, so it should only be used where appropriate in order to | 73 | on target ``python3``, so it should only be used where appropriate in order to |
74 | avoid unnecessarily lengthening builds. | 74 | avoid unnecessarily lengthening builds. |
75 | 75 | ||
@@ -99,11 +99,10 @@ variable so that recipes can specify it explicitly, for example:: | |||
99 | S = "${WORKDIR}/git" | 99 | S = "${WORKDIR}/git" |
100 | DISTUTILS_SETUP_PATH = "${S}/python/pythonmodule" | 100 | DISTUTILS_SETUP_PATH = "${S}/python/pythonmodule" |
101 | 101 | ||
102 | Recipes that inherit from ``distutils3`` (or | 102 | Recipes that inherit from ``distutils3`` (or :ref:`ref-classes-setuptools3` |
103 | :ref:`setuptools3 <ref-classes-setuptools3>` which itself inherits | 103 | which itself inherits ``distutils3``) that also set :term:`S` to point to a |
104 | ``distutils3``) that also set :term:`S` to point to a Python module within a | 104 | Python module within a subdirectory in the aforementioned manner should be |
105 | subdirectory in the aforementioned manner should be changed to set | 105 | changed to set ``DISTUTILS_SETUP_PATH`` instead. |
106 | ``DISTUTILS_SETUP_PATH`` instead. | ||
107 | 106 | ||
108 | 107 | ||
109 | .. _migration-3.3-bitbake: | 108 | .. _migration-3.3-bitbake: |
diff --git a/documentation/migration-guides/migration-3.4.rst b/documentation/migration-guides/migration-3.4.rst index 88238091a1..076c589c8c 100644 --- a/documentation/migration-guides/migration-3.4.rst +++ b/documentation/migration-guides/migration-3.4.rst | |||
@@ -126,7 +126,7 @@ Removed classes | |||
126 | - ``image-mklibs``: not actively tested and upstream mklibs still | 126 | - ``image-mklibs``: not actively tested and upstream mklibs still |
127 | requires Python 2 | 127 | requires Python 2 |
128 | - ``meta``: no longer useful. Recipes that need to skip installing | 128 | - ``meta``: no longer useful. Recipes that need to skip installing |
129 | packages should inherit :ref:`nopackages <ref-classes-nopackages>` instead. | 129 | packages should inherit :ref:`ref-classes-nopackages` instead. |
130 | 130 | ||
131 | Prelinking disabled by default | 131 | Prelinking disabled by default |
132 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 132 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
@@ -259,7 +259,7 @@ Miscellaneous | |||
259 | instead. | 259 | instead. |
260 | 260 | ||
261 | - The obsolete ``oe_machinstall`` function previously provided in the | 261 | - The obsolete ``oe_machinstall`` function previously provided in the |
262 | :ref:`utils <ref-classes-utils>` class has been removed. For | 262 | :ref:`ref-classes-utils` class has been removed. For |
263 | machine-specific installation it is recommended that you use the | 263 | machine-specific installation it is recommended that you use the |
264 | built-in override support in the fetcher or overrides in general | 264 | built-in override support in the fetcher or overrides in general |
265 | instead. | 265 | instead. |
diff --git a/documentation/migration-guides/migration-4.0.rst b/documentation/migration-guides/migration-4.0.rst index dd840f2bb3..3106498404 100644 --- a/documentation/migration-guides/migration-4.0.rst +++ b/documentation/migration-guides/migration-4.0.rst | |||
@@ -119,7 +119,7 @@ License changes | |||
119 | - The ``AVAILABLE_LICENSES`` variable has been removed. This variable was a performance | 119 | - The ``AVAILABLE_LICENSES`` variable has been removed. This variable was a performance |
120 | liability and is highly dependent on which layers are added to the configuration, | 120 | liability and is highly dependent on which layers are added to the configuration, |
121 | which can cause signature issues for users. In addition the ``available_licenses()`` | 121 | which can cause signature issues for users. In addition the ``available_licenses()`` |
122 | function has been removed from the :ref:`license <ref-classes-license>` class as | 122 | function has been removed from the :ref:`ref-classes-license` class as |
123 | it is no longer needed. | 123 | it is no longer needed. |
124 | 124 | ||
125 | Removed recipes | 125 | Removed recipes |
@@ -143,15 +143,14 @@ Python changes | |||
143 | 143 | ||
144 | - The Python package build process is now based on `wheels <https://pythonwheels.com/>`__. | 144 | - The Python package build process is now based on `wheels <https://pythonwheels.com/>`__. |
145 | Here are the new Python packaging classes that should be used: | 145 | Here are the new Python packaging classes that should be used: |
146 | :ref:`python_flit_core <ref-classes-python_flit_core>`, | 146 | :ref:`ref-classes-python_flit_core`, :ref:`ref-classes-python_setuptools_build_meta` |
147 | :ref:`python_setuptools_build_meta <ref-classes-python_setuptools_build_meta>` | 147 | and :ref:`ref-classes-python_poetry_core`. |
148 | and :ref:`python_poetry_core <ref-classes-python_poetry_core>`. | ||
149 | 148 | ||
150 | - The :ref:`setuptools3 <ref-classes-setuptools3>` class :ref:`ref-tasks-install` task now | 149 | - The :ref:`ref-classes-setuptools3` class :ref:`ref-tasks-install` task now |
151 | installs the ``wheel`` binary archive. In current versions of ``setuptools`` the | 150 | installs the ``wheel`` binary archive. In current versions of ``setuptools`` the |
152 | legacy ``setup.py install`` method is deprecated. If the ``setup.py`` cannot be used | 151 | legacy ``setup.py install`` method is deprecated. If the ``setup.py`` cannot be used |
153 | with wheels, for example it creates files outside of the Python module or standard | 152 | with wheels, for example it creates files outside of the Python module or standard |
154 | entry points, then :ref:`setuptools3_legacy <ref-classes-setuptools3_legacy>` should | 153 | entry points, then :ref:`ref-classes-setuptools3_legacy` should |
155 | be used instead. | 154 | be used instead. |
156 | 155 | ||
157 | Prelink removed | 156 | Prelink removed |
@@ -173,7 +172,7 @@ Reproducible as standard | |||
173 | 172 | ||
174 | Reproducibility is now considered as standard functionality, thus the | 173 | Reproducibility is now considered as standard functionality, thus the |
175 | ``reproducible`` class has been removed and its previous contents merged into the | 174 | ``reproducible`` class has been removed and its previous contents merged into the |
176 | :ref:`base <ref-classes-base>` class. If you have references in your configuration to | 175 | :ref:`ref-classes-base` class. If you have references in your configuration to |
177 | ``reproducible`` in :term:`INHERIT`, :term:`USER_CLASSES` etc. then they should be | 176 | ``reproducible`` in :term:`INHERIT`, :term:`USER_CLASSES` etc. then they should be |
178 | removed. | 177 | removed. |
179 | 178 | ||
@@ -215,15 +214,15 @@ Miscellaneous changes | |||
215 | ~~~~~~~~~~~~~~~~~~~~~ | 214 | ~~~~~~~~~~~~~~~~~~~~~ |
216 | 215 | ||
217 | - ``blacklist.bbclass`` is removed and the functionality moved to the | 216 | - ``blacklist.bbclass`` is removed and the functionality moved to the |
218 | :ref:`base <ref-classes-base>` class with a more descriptive | 217 | :ref:`ref-classes-base` class with a more descriptive |
219 | ``varflag`` variable named :term:`SKIP_RECIPE` which will use the `bb.parse.SkipRecipe()` | 218 | ``varflag`` variable named :term:`SKIP_RECIPE` which will use the `bb.parse.SkipRecipe()` |
220 | function. The usage remains the same, for example:: | 219 | function. The usage remains the same, for example:: |
221 | 220 | ||
222 | SKIP_RECIPE[my-recipe] = "Reason for skipping recipe" | 221 | SKIP_RECIPE[my-recipe] = "Reason for skipping recipe" |
223 | 222 | ||
224 | - :ref:`allarch <ref-classes-allarch>` packagegroups can no longer depend on packages | 223 | - :ref:`ref-classes-allarch` packagegroups can no longer depend on packages |
225 | which use :term:`PKG` renaming such as :ref:`ref-classes-debian`. Such packagegroups | 224 | which use :term:`PKG` renaming such as :ref:`ref-classes-debian`. Such packagegroups |
226 | recipes should be changed to avoid inheriting :ref:`allarch <ref-classes-allarch>`. | 225 | recipes should be changed to avoid inheriting :ref:`ref-classes-allarch`. |
227 | 226 | ||
228 | - The ``lnr`` script has been removed. ``lnr`` implemented the same behaviour as `ln --relative --symbolic`, | 227 | - The ``lnr`` script has been removed. ``lnr`` implemented the same behaviour as `ln --relative --symbolic`, |
229 | since at the time of creation `--relative` was only available in coreutils 8.16 | 228 | since at the time of creation `--relative` was only available in coreutils 8.16 |
@@ -232,7 +231,7 @@ Miscellaneous changes | |||
232 | any calls to ``lnr`` in your recipes or classes, they should be replaced with | 231 | any calls to ``lnr`` in your recipes or classes, they should be replaced with |
233 | `ln --relative --symbolic` or `ln -rs` if you prefer the short version. | 232 | `ln --relative --symbolic` or `ln -rs` if you prefer the short version. |
234 | 233 | ||
235 | - The ``package_qa_handle_error()`` function formerly in the :ref:`insane <ref-classes-insane>` | 234 | - The ``package_qa_handle_error()`` function formerly in the :ref:`ref-classes-insane` |
236 | class has been moved and renamed - if you have any references in your own custom | 235 | class has been moved and renamed - if you have any references in your own custom |
237 | classes they should be changed to ``oe.qa.handle_error()``. | 236 | classes they should be changed to ``oe.qa.handle_error()``. |
238 | 237 | ||
diff --git a/documentation/migration-guides/migration-4.1.rst b/documentation/migration-guides/migration-4.1.rst index 8b9db40ddc..86721b9873 100644 --- a/documentation/migration-guides/migration-4.1.rst +++ b/documentation/migration-guides/migration-4.1.rst | |||
@@ -92,7 +92,7 @@ now cause an error:: | |||
92 | 92 | ||
93 | INHERIT += "testimage" | 93 | INHERIT += "testimage" |
94 | 94 | ||
95 | Since :ref:`testimage <ref-classes-testimage>` is a class intended solely to | 95 | Since :ref:`ref-classes-testimage` is a class intended solely to |
96 | affect image recipes, this would be correctly specified as:: | 96 | affect image recipes, this would be correctly specified as:: |
97 | 97 | ||
98 | IMAGE_CLASSES += "testimage" | 98 | IMAGE_CLASSES += "testimage" |
@@ -154,16 +154,16 @@ Miscellaneous changes | |||
154 | you can set :term:`WATCHDOG_TIMEOUT` to the desired timeout in seconds. Note | 154 | you can set :term:`WATCHDOG_TIMEOUT` to the desired timeout in seconds. Note |
155 | that the same :term:`WATCHDOG_TIMEOUT` variable also specifies the timeout used | 155 | that the same :term:`WATCHDOG_TIMEOUT` variable also specifies the timeout used |
156 | for the ``watchdog`` tool (if that is being built). | 156 | for the ``watchdog`` tool (if that is being built). |
157 | - The :ref:`image-buildinfo <ref-classes-image-buildinfo>` class now writes to | 157 | - The :ref:`ref-classes-image-buildinfo` class now writes to |
158 | ``${sysconfdir}/buildinfo`` instead of ``${sysconfdir}/build`` by default (i.e. | 158 | ``${sysconfdir}/buildinfo`` instead of ``${sysconfdir}/build`` by default (i.e. |
159 | the default value of :term:`IMAGE_BUILDINFO_FILE` has been changed). If you have | 159 | the default value of :term:`IMAGE_BUILDINFO_FILE` has been changed). If you have |
160 | code that reads this from images at build or runtime you will need to update it | 160 | code that reads this from images at build or runtime you will need to update it |
161 | or specify your own value for :term:`IMAGE_BUILDINFO_FILE`. | 161 | or specify your own value for :term:`IMAGE_BUILDINFO_FILE`. |
162 | - In the :ref:`archiver <ref-classes-archiver>` class, the default | 162 | - In the :ref:`ref-classes-archiver` class, the default |
163 | ``ARCHIVER_OUTDIR`` value no longer includes the :term:`MACHINE` value in order | 163 | ``ARCHIVER_OUTDIR`` value no longer includes the :term:`MACHINE` value in order |
164 | to avoid the archive task running multiple times in a multiconfig setup. If you | 164 | to avoid the archive task running multiple times in a multiconfig setup. If you |
165 | have custom code that does something with the files archived by the | 165 | have custom code that does something with the files archived by the |
166 | :ref:`archiver <ref-classes-archiver>` class then you may need to adjust it to | 166 | :ref:`ref-classes-archiver` class then you may need to adjust it to |
167 | the new structure. | 167 | the new structure. |
168 | - If you are not using `systemd` then udev is now configured to use labels | 168 | - If you are not using `systemd` then udev is now configured to use labels |
169 | (``LABEL`` or ``PARTLABEL``) to set the mount point for the device. For example:: | 169 | (``LABEL`` or ``PARTLABEL``) to set the mount point for the device. For example:: |
@@ -194,7 +194,7 @@ Miscellaneous changes | |||
194 | :term:`PACKAGECONFIG`. If you are customising this file you will need to | 194 | :term:`PACKAGECONFIG`. If you are customising this file you will need to |
195 | update your customisations. | 195 | update your customisations. |
196 | - With the introduction of picobuild in | 196 | - With the introduction of picobuild in |
197 | :ref:`python_pep517 <ref-classes-python_pep517>`, The ``PEP517_BUILD_API`` | 197 | :ref:`ref-classes-python_pep517`, The ``PEP517_BUILD_API`` |
198 | variable is no longer supported. If you have any references to this variable | 198 | variable is no longer supported. If you have any references to this variable |
199 | you should remove them. | 199 | you should remove them. |
200 | 200 | ||
diff --git a/documentation/migration-guides/migration-general.rst b/documentation/migration-guides/migration-general.rst index c3b8a785db..1820f5cfd8 100644 --- a/documentation/migration-guides/migration-general.rst +++ b/documentation/migration-guides/migration-general.rst | |||
@@ -76,24 +76,24 @@ any new Yocto Project release. | |||
76 | 76 | ||
77 | - *Checking Image / SDK Changes*: | 77 | - *Checking Image / SDK Changes*: |
78 | 78 | ||
79 | The :ref:`buildhistory <ref-classes-buildhistory>` class can be used | 79 | The :ref:`ref-classes-buildhistory` class can be used |
80 | if you wish to check the impact of changes to images / SDKs across | 80 | if you wish to check the impact of changes to images / SDKs across |
81 | the migration (e.g. added/removed packages, added/removed files, size | 81 | the migration (e.g. added/removed packages, added/removed files, size |
82 | changes etc.). To do this, follow these steps: | 82 | changes etc.). To do this, follow these steps: |
83 | 83 | ||
84 | #. Enable :ref:`buildhistory <ref-classes-buildhistory>` before the migration | 84 | #. Enable :ref:`ref-classes-buildhistory` before the migration |
85 | 85 | ||
86 | #. Run a pre-migration build | 86 | #. Run a pre-migration build |
87 | 87 | ||
88 | #. Capture the :ref:`buildhistory <ref-classes-buildhistory>` output (as | 88 | #. Capture the :ref:`ref-classes-buildhistory` output (as |
89 | specified by :term:`BUILDHISTORY_DIR`) and ensure it is preserved for | 89 | specified by :term:`BUILDHISTORY_DIR`) and ensure it is preserved for |
90 | subsequent builds. How you would do this depends on how you are running | 90 | subsequent builds. How you would do this depends on how you are running |
91 | your builds - if you are doing this all on one workstation in the same | 91 | your builds - if you are doing this all on one workstation in the same |
92 | :term:`Build Directory` you may not need to do anything other than not | 92 | :term:`Build Directory` you may not need to do anything other than not |
93 | deleting the :ref:`buildhistory <ref-classes-buildhistory>` output | 93 | deleting the :ref:`ref-classes-buildhistory` output |
94 | directory. For builds in a pipeline it may be more complicated. | 94 | directory. For builds in a pipeline it may be more complicated. |
95 | 95 | ||
96 | #. Set a tag in the :ref:`buildhistory <ref-classes-buildhistory>` output (which is a git repository) before | 96 | #. Set a tag in the :ref:`ref-classes-buildhistory` output (which is a git repository) before |
97 | migration, to make the commit from the pre-migration build easy to find | 97 | migration, to make the commit from the pre-migration build easy to find |
98 | as you may end up running multiple builds during the migration. | 98 | as you may end up running multiple builds during the migration. |
99 | 99 | ||
@@ -102,7 +102,7 @@ any new Yocto Project release. | |||
102 | #. Run a build | 102 | #. Run a build |
103 | 103 | ||
104 | #. Check the output changes between the previously set tag and HEAD in the | 104 | #. Check the output changes between the previously set tag and HEAD in the |
105 | :ref:`buildhistory <ref-classes-buildhistory>` output using ``git diff`` or ``buildhistory-diff``. | 105 | :ref:`ref-classes-buildhistory` output using ``git diff`` or ``buildhistory-diff``. |
106 | 106 | ||
107 | For more information on using :ref:`buildhistory <ref-classes-buildhistory>`, see | 107 | For more information on using :ref:`ref-classes-buildhistory`, see |
108 | :ref:`dev-manual/build-quality:maintaining build output quality`. | 108 | :ref:`dev-manual/build-quality: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 6b2b7eade6..d76bb004b1 100644 --- a/documentation/migration-guides/release-notes-3.4.rst +++ b/documentation/migration-guides/release-notes-3.4.rst | |||
@@ -9,7 +9,7 @@ New Features / Enhancements in 3.4 | |||
9 | - Linux kernel 5.14, glibc 2.34 and ~280 other recipe upgrades | 9 | - Linux kernel 5.14, glibc 2.34 and ~280 other recipe upgrades |
10 | - Switched override character to ':' (replacing '_') for more robust parsing and improved performance --- see the above migration guide for help | 10 | - Switched override character to ':' (replacing '_') for more robust parsing and improved performance --- see the above migration guide for help |
11 | - Rust integrated into core, providing rust support for cross-compilation and SDK | 11 | - Rust integrated into core, providing rust support for cross-compilation and SDK |
12 | - New :ref:`create-spdx <ref-classes-create-spdx>` class for creating SPDX SBoM documents | 12 | - New :ref:`ref-classes-create-spdx` class for creating SPDX SBoM documents |
13 | - 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 | 13 | - 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 |
14 | - Several optimisations to reduce unnecessary task dependencies for faster builds | 14 | - Several optimisations to reduce unnecessary task dependencies for faster builds |
15 | - seccomp integrated into core, with additional enabling for gnutls, systemd, qemu | 15 | - seccomp integrated into core, with additional enabling for gnutls, systemd, qemu |
@@ -71,7 +71,7 @@ New Features / Enhancements in 3.4 | |||
71 | 71 | ||
72 | - Enable :ref:`ref-tasks-populate_sdk` with multilibs | 72 | - Enable :ref:`ref-tasks-populate_sdk` with multilibs |
73 | - New ``SDKPATHINSTALL`` variable decouples default install path from | 73 | - New ``SDKPATHINSTALL`` variable decouples default install path from |
74 | built in path to avoid rebuilding :ref:`nativesdk <ref-classes-nativesdk>` | 74 | built in path to avoid rebuilding :ref:`ref-classes-nativesdk` |
75 | components on e.g. :term:`DISTRO_VERSION` changes | 75 | components on e.g. :term:`DISTRO_VERSION` changes |
76 | - eSDK: Error if trying to generate an eSDK from a multiconfig | 76 | - eSDK: Error if trying to generate an eSDK from a multiconfig |
77 | - 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 | 77 | - 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 |
diff --git a/documentation/migration-guides/release-notes-4.0.rst b/documentation/migration-guides/release-notes-4.0.rst index b1f89cf0a7..563113b4db 100644 --- a/documentation/migration-guides/release-notes-4.0.rst +++ b/documentation/migration-guides/release-notes-4.0.rst | |||
@@ -13,7 +13,7 @@ New Features / Enhancements in 4.0 | |||
13 | - Reproducibility: this release fixes the reproducibility issues with | 13 | - Reproducibility: this release fixes the reproducibility issues with |
14 | ``rust-llvm`` and ``golang``. Recipes in OpenEmbedded-Core are now fully | 14 | ``rust-llvm`` and ``golang``. Recipes in OpenEmbedded-Core are now fully |
15 | reproducible. Functionality previously in the optional "reproducible" | 15 | reproducible. Functionality previously in the optional "reproducible" |
16 | class has been merged into the :ref:`base <ref-classes-base>` class. | 16 | class has been merged into the :ref:`ref-classes-base` class. |
17 | 17 | ||
18 | - Network access is now disabled by default for tasks other than where it is expected to ensure build integrity (where host kernel supports it) | 18 | - Network access is now disabled by default for tasks other than where it is expected to ensure build integrity (where host kernel supports it) |
19 | 19 | ||
@@ -31,8 +31,7 @@ New Features / Enhancements in 4.0 | |||
31 | - The Python package build process is now based on `wheels <https://pythonwheels.com/>`__ | 31 | - The Python package build process is now based on `wheels <https://pythonwheels.com/>`__ |
32 | in line with the upstream direction. | 32 | in line with the upstream direction. |
33 | 33 | ||
34 | - New :ref:`overlayfs <ref-classes-overlayfs>` and | 34 | - New :ref:`ref-classes-overlayfs` and :ref:`ref-classes-overlayfs-etc` classes and |
35 | :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` classes and | ||
36 | ``overlayroot`` support in the :term:`Initramfs` framework to make it easier to | 35 | ``overlayroot`` support in the :term:`Initramfs` framework to make it easier to |
37 | overlay read-only filesystems (for example) with | 36 | overlay read-only filesystems (for example) with |
38 | :wikipedia:`OverlayFS <OverlayFS>`. | 37 | :wikipedia:`OverlayFS <OverlayFS>`. |
@@ -218,7 +217,7 @@ New Features / Enhancements in 4.0 | |||
218 | - Ensure addition of patch-fuzz retriggers do_qa_patch | 217 | - Ensure addition of patch-fuzz retriggers do_qa_patch |
219 | - Added a sanity check for allarch packagegroups | 218 | - Added a sanity check for allarch packagegroups |
220 | 219 | ||
221 | - :ref:`create-spdx <ref-classes-create-spdx>` class improvements: | 220 | - :ref:`ref-classes-create-spdx` class improvements: |
222 | 221 | ||
223 | - Get SPDX-License-Identifier from source files | 222 | - Get SPDX-License-Identifier from source files |
224 | - Generate manifest also for SDKs | 223 | - Generate manifest also for SDKs |
@@ -238,9 +237,9 @@ New Features / Enhancements in 4.0 | |||
238 | 237 | ||
239 | - SDK-related enhancements: | 238 | - SDK-related enhancements: |
240 | 239 | ||
241 | - Extended recipes to :ref:`nativesdk <ref-classes-nativesdk>`: ``cargo``, | 240 | - Extended recipes to :ref:`ref-classes-nativesdk`: ``cargo``, |
242 | ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging`` | 241 | ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging`` |
243 | - Enabled :ref:`nativesdk <ref-classes-nativesdk>` recipes to find a correct version | 242 | - Enabled :ref:`ref-classes-nativesdk` recipes to find a correct version |
244 | of the rust cross compiler | 243 | of the rust cross compiler |
245 | - Support creating per-toolchain cmake file in SDK | 244 | - Support creating per-toolchain cmake file in SDK |
246 | 245 | ||
diff --git a/documentation/migration-guides/release-notes-4.1.rst b/documentation/migration-guides/release-notes-4.1.rst index 09eb6d8c06..cd48e202ab 100644 --- a/documentation/migration-guides/release-notes-4.1.rst +++ b/documentation/migration-guides/release-notes-4.1.rst | |||
@@ -30,7 +30,7 @@ New Features / Enhancements in 4.1 | |||
30 | - Support for building rust for the target | 30 | - Support for building rust for the target |
31 | - Significant SDK toolchain build optimisation | 31 | - Significant SDK toolchain build optimisation |
32 | - Support for building native components in the SDK | 32 | - Support for building native components in the SDK |
33 | - Support ``crate://`` fetcher with :ref:`externalsrc <ref-classes-externalsrc>` | 33 | - Support ``crate://`` fetcher with :ref:`ref-classes-externalsrc` |
34 | 34 | ||
35 | - New core recipes: | 35 | - New core recipes: |
36 | 36 | ||
@@ -52,7 +52,7 @@ New Features / Enhancements in 4.1 | |||
52 | - Added support for Ignored CVEs | 52 | - Added support for Ignored CVEs |
53 | - Enable recursive CVE checking also for ``do_populate_sdk`` | 53 | - Enable recursive CVE checking also for ``do_populate_sdk`` |
54 | - New :term:`CVE_CHECK_SHOW_WARNINGS` variable to disable unpatched CVE warning messages | 54 | - New :term:`CVE_CHECK_SHOW_WARNINGS` variable to disable unpatched CVE warning messages |
55 | - The :ref:`pypi <ref-classes-pypi>` class now defaults :term:`CVE_PRODUCT` from :term:`PYPI_PACKAGE` | 55 | - The :ref:`ref-classes-pypi` class now defaults :term:`CVE_PRODUCT` from :term:`PYPI_PACKAGE` |
56 | - Added current kernel CVEs to ignore list since we stay as close to the kernel stable releases as we can | 56 | - Added current kernel CVEs to ignore list since we stay as close to the kernel stable releases as we can |
57 | - Optimisations to avoid dependencies on fetching | 57 | - Optimisations to avoid dependencies on fetching |
58 | 58 | ||
@@ -60,9 +60,9 @@ New Features / Enhancements in 4.1 | |||
60 | - Dependency of -dev package on main package is now an :term:`RRECOMMENDS` and can be easily set via new :term:`DEV_PKG_DEPENDENCY` variable | 60 | - Dependency of -dev package on main package is now an :term:`RRECOMMENDS` and can be easily set via new :term:`DEV_PKG_DEPENDENCY` variable |
61 | 61 | ||
62 | - Support for CPU, I/O and memory pressure regulation in BitBake | 62 | - Support for CPU, I/O and memory pressure regulation in BitBake |
63 | - Pressure data gathering in :ref:`buildstats <ref-classes-buildstats>` and rendering in ``pybootchartgui`` | 63 | - Pressure data gathering in :ref:`ref-classes-buildstats` and rendering in ``pybootchartgui`` |
64 | 64 | ||
65 | - New Picobuild system for lightweight Python PEP-517 build support in the :ref:`python_pep517 <ref-classes-python_pep517>` class | 65 | - New Picobuild system for lightweight Python PEP-517 build support in the :ref:`ref-classes-python_pep517` class |
66 | 66 | ||
67 | - Many classes are now split into global and recipe contexts for better | 67 | - Many classes are now split into global and recipe contexts for better |
68 | validation. For more information, see | 68 | validation. For more information, see |
@@ -99,10 +99,10 @@ New Features / Enhancements in 4.1 | |||
99 | - SDK-related enhancements: | 99 | - SDK-related enhancements: |
100 | 100 | ||
101 | - :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>` | 101 | - :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>` |
102 | - :ref:`image-buildinfo <ref-classes-image-buildinfo>` class now also writes build information to SDKs | 102 | - :ref:`ref-classes-image-buildinfo` class now also writes build information to SDKs |
103 | - New :term:`SDK_TOOLCHAIN_LANGS` variable to control support of rust / go in SDK | 103 | - New :term:`SDK_TOOLCHAIN_LANGS` variable to control support of rust / go in SDK |
104 | - rust-llvm: enabled :ref:`nativesdk <ref-classes-nativesdk>` variant | 104 | - rust-llvm: enabled :ref:`ref-classes-nativesdk` variant |
105 | - python3-pluggy: enabled for :ref:`native <ref-classes-native>` / :ref:`nativesdk <ref-classes-nativesdk>` | 105 | - python3-pluggy: enabled for :ref:`ref-classes-native` / :ref:`ref-classes-nativesdk` |
106 | 106 | ||
107 | - QEMU/runqemu enhancements: | 107 | - QEMU/runqemu enhancements: |
108 | 108 | ||
@@ -115,11 +115,11 @@ New Features / Enhancements in 4.1 | |||
115 | - New variable :term:`UBOOT_MKIMAGE_KERNEL_TYPE` | 115 | - New variable :term:`UBOOT_MKIMAGE_KERNEL_TYPE` |
116 | - New variable :term:`FIT_PAD_ALG` to control FIT image padding algorithm | 116 | - New variable :term:`FIT_PAD_ALG` to control FIT image padding algorithm |
117 | - New :term:`KERNEL_DEPLOY_DEPEND` variable to allow disabling image dependency on deploying the kernel | 117 | - New :term:`KERNEL_DEPLOY_DEPEND` variable to allow disabling image dependency on deploying the kernel |
118 | - :ref:`image_types <ref-classes-image_types>`: isolate the write of UBI | 118 | - :ref:`ref-classes-image_types`: isolate the write of UBI |
119 | configuration to a ``write_ubi_config`` function that can be easily overridden | 119 | configuration to a ``write_ubi_config`` function that can be easily overridden |
120 | 120 | ||
121 | - openssh: add support for config snippet includes to ssh and sshd | 121 | - openssh: add support for config snippet includes to ssh and sshd |
122 | - :ref:`create-spdx <ref-classes-create-spdx>`: Add :term:`SPDX_PRETTY` option | 122 | - :ref:`ref-classes-create-spdx`: Add :term:`SPDX_PRETTY` option |
123 | - wpa-supplicant: build static library if not disabled via :term:`DISABLE_STATIC` | 123 | - wpa-supplicant: build static library if not disabled via :term:`DISABLE_STATIC` |
124 | - wpa-supplicant: package dynamic modules | 124 | - wpa-supplicant: package dynamic modules |
125 | - openssl: extract legacy provider module to a separate package | 125 | - openssl: extract legacy provider module to a separate package |
@@ -132,11 +132,11 @@ New Features / Enhancements in 4.1 | |||
132 | - systemd: systemd-systemctl: Support instance conf files during enable | 132 | - systemd: systemd-systemctl: Support instance conf files during enable |
133 | - weston.init: enable ``xwayland`` in weston.ini if ``x11`` is in :term:`DISTRO_FEATURES` | 133 | - weston.init: enable ``xwayland`` in weston.ini if ``x11`` is in :term:`DISTRO_FEATURES` |
134 | - New ``npm_registry`` Python module to enable caching with nodejs 16+ | 134 | - New ``npm_registry`` Python module to enable caching with nodejs 16+ |
135 | - :ref:`npm <ref-classes-npm>`: replaced ``npm pack`` call with ``tar czf`` for nodejs 16+ compatibility and improved ``do_configure`` performance | 135 | - :ref:`ref-classes-npm`: replaced ``npm pack`` call with ``tar czf`` for nodejs 16+ compatibility and improved ``do_configure`` performance |
136 | - Enabled :ref:`bin_package <ref-classes-bin-package>` class to work properly in the native case | 136 | - Enabled :ref:`ref-classes-bin-package` class to work properly in the native case |
137 | - Enabled :ref:`buildpaths <qa-check-buildpaths>` QA check as a warning by default | 137 | - Enabled :ref:`buildpaths <qa-check-buildpaths>` QA check as a warning by default |
138 | - New :term:`OVERLAYFS_ETC_EXPOSE_LOWER` to provide read-only access to the original ``/etc`` content with :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` | 138 | - New :term:`OVERLAYFS_ETC_EXPOSE_LOWER` to provide read-only access to the original ``/etc`` content with :ref:`ref-classes-overlayfs-etc` |
139 | - New :term:`OVERLAYFS_QA_SKIP` variable to allow skipping check on :ref:`overlayfs <ref-classes-overlayfs>` mounts | 139 | - New :term:`OVERLAYFS_QA_SKIP` variable to allow skipping check on :ref:`ref-classes-overlayfs` mounts |
140 | - New :term:`PACKAGECONFIG` options for individual recipes: | 140 | - New :term:`PACKAGECONFIG` options for individual recipes: |
141 | 141 | ||
142 | - apr: xsi-strerror | 142 | - apr: xsi-strerror |
@@ -176,7 +176,7 @@ New Features / Enhancements in 4.1 | |||
176 | - The Python ``zoneinfo`` module is now split out to its own ``python3-zoneinfo`` package. | 176 | - The Python ``zoneinfo`` module is now split out to its own ``python3-zoneinfo`` package. |
177 | - busybox: added devmem 128-bit support | 177 | - busybox: added devmem 128-bit support |
178 | - vim: split xxd out into its own package | 178 | - vim: split xxd out into its own package |
179 | - New :ref:`github-releases <ref-classes-github-releases>` class to consolidate version checks for github-based packages | 179 | - New :ref:`ref-classes-github-releases` class to consolidate version checks for github-based packages |
180 | - ``devtool reset`` now preserves ``workspace/sources`` source trees in ``workspace/attic/sources/`` instead of leaving them in-place | 180 | - ``devtool reset`` now preserves ``workspace/sources`` source trees in ``workspace/attic/sources/`` instead of leaving them in-place |
181 | - scripts/patchreview: Add commit to stored json data | 181 | - scripts/patchreview: Add commit to stored json data |
182 | - scripts/patchreview: Make json output human parsable | 182 | - scripts/patchreview: Make json output human parsable |
@@ -204,7 +204,7 @@ Known Issues in 4.1 | |||
204 | :yocto_bugs:`bug 14626 </show_bug.cgi?id=14626>`, which also details the fix. | 204 | :yocto_bugs:`bug 14626 </show_bug.cgi?id=14626>`, which also details the fix. |
205 | 205 | ||
206 | - The change to :ref:`migration-4.1-classes-split` inadvertently moved the | 206 | - The change to :ref:`migration-4.1-classes-split` inadvertently moved the |
207 | :ref:`externalsrc <ref-classes-externalsrc>` class to ``meta/classes-recipe``, | 207 | :ref:`ref-classes-externalsrc` class to ``meta/classes-recipe``, |
208 | when it is not recipe-specific and can also be used in a global context. The | 208 | when it is not recipe-specific and can also be used in a global context. The |
209 | class will be moved back to ``meta/classes`` in the next point release. Filed | 209 | class will be moved back to ``meta/classes`` in the next point release. Filed |
210 | as :yocto_bugs:`bug 14940 </show_bug.cgi?id=14940>`. | 210 | as :yocto_bugs:`bug 14940 </show_bug.cgi?id=14940>`. |