summaryrefslogtreecommitdiffstats
path: root/documentation/migration-guides/migration-3.2.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-01-05 08:34:26 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-01-06 17:39:09 +0000
commit8b1909aa6f7a51a878dc3d4a9223403ad3e164a9 (patch)
treee1418f545ad6640afb5fde004696eef2a9e6e67b /documentation/migration-guides/migration-3.2.rst
parentae280972ffba62d7ed839b692957f61b0955cbca (diff)
downloadpoky-8b1909aa6f7a51a878dc3d4a9223403ad3e164a9.tar.gz
manuals: simplify references to classes
Now that .bbclass is removed from class section titles. We can now have, for example, :ref:`ref-classes-insane` instead of :ref:`insane <ref-classes-insane>`. Then, when necessary, rework paragraphs so that they have lines of even length, not exceeding 80 characters. (From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/migration-guides/migration-3.2.rst')
-rw-r--r--documentation/migration-guides/migration-3.2.rst33
1 files changed, 26 insertions, 7 deletions
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
178In addition, the following new checks were added and default to triggering an error: 178In 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.
209deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` 219deploy 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
223now cleans up ${:term:`DEPLOYDIR`} before running, just as
224:ref:`ref-tasks-install` cleans up ${:term:`D`} before running. This reduces
225the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from
226previous runs, possibly even with different config, in case of incremental
227builds.
213 228
214Most 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. 229Most recipes and classes that inherit the :ref:`ref-classes-deploy` class or
230interact with :ref:`ref-tasks-deploy` are unlikely to be affected by this
231unless they add ``prefuncs`` to :ref:`ref-tasks-deploy` *which also* put files
232into ``${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
219Custom SDK / SDK-style recipes need to include ``nativesdk-sdk-provides-dummy`` 238Custom SDK / SDK-style recipes need to include ``nativesdk-sdk-provides-dummy``
220------------------------------------------------------------------------------- 239-------------------------------------------------------------------------------
221 240
222All :ref:`nativesdk <ref-classes-nativesdk>` packages require ``/bin/sh`` due 241All :ref:`ref-classes-nativesdk` packages require ``/bin/sh`` due
223to their postinstall scriptlets, thus this package has to be dummy-provided 242to their postinstall scriptlets, thus this package has to be dummy-provided
224within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have 243within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have
225a custom SDK recipe (or your own SDK-style recipe similar to e.g. 244a custom SDK recipe (or your own SDK-style recipe similar to e.g.