diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2021-11-23 18:47:55 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-12-13 23:31:34 +0000 |
commit | a19add4aaaa4ff64ae3403eae415c08713bbdb38 (patch) | |
tree | 35e27a4aa032849c826344fd99f0207c39cb18bb /documentation | |
parent | 2b578eae4e50774dd449282beb287e10b0485cbc (diff) | |
download | poky-a19add4aaaa4ff64ae3403eae415c08713bbdb38.tar.gz |
migration-guides: add more class references
(From yocto-docs rev: 29031a9da0f1a500a8b2b6a642ee553a352255f8)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
11 files changed, 22 insertions, 19 deletions
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst index 11c821265c..15b0b43092 100644 --- a/documentation/migration-guides/migration-1.5.rst +++ b/documentation/migration-guides/migration-1.5.rst | |||
@@ -95,7 +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 ``buildhistory`` class, the check for the package | 98 | - If you are using the :ref:`buildhistory <ref-classes-buildhistory>` class, |
99 | the check for the package | ||
99 | version going backwards is now controlled using a standard QA check. | 100 | version going backwards is now controlled using a standard QA check. |
100 | Thus, if you have customized your :term:`ERROR_QA` or :term:`WARN_QA` values | 101 | Thus, if you have customized your :term:`ERROR_QA` or :term:`WARN_QA` values |
101 | and still wish to have this check performed, you should add | 102 | and still wish to have this check performed, you should add |
diff --git a/documentation/migration-guides/migration-1.7.rst b/documentation/migration-guides/migration-1.7.rst index 8c642da202..88a6855d50 100644 --- a/documentation/migration-guides/migration-1.7.rst +++ b/documentation/migration-guides/migration-1.7.rst | |||
@@ -43,7 +43,8 @@ The following :ref:`autotools <ref-classes-autotools>` class changes | |||
43 | occurred: | 43 | occurred: |
44 | 44 | ||
45 | - *A separate build directory is now used by default:* The | 45 | - *A separate build directory is now used by default:* The |
46 | ``autotools`` class has been changed to use a directory for building | 46 | :ref:`autotools <ref-classes-autotools>` class has been |
47 | changed to use a directory for building | ||
47 | (:term:`B`), which is separate from the source directory | 48 | (:term:`B`), which is separate from the source directory |
48 | (:term:`S`). This is commonly referred to as ``B != S``, or | 49 | (:term:`S`). This is commonly referred to as ``B != S``, or |
49 | an out-of-tree build. | 50 | an out-of-tree build. |
@@ -54,7 +55,8 @@ occurred: | |||
54 | 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 |
55 | 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 |
56 | the :ref:`autotools-brokensep <ref-classes-autotools>` class | 57 | the :ref:`autotools-brokensep <ref-classes-autotools>` class |
57 | instead of the ``autotools`` or ``autotools_stage`` classes. | 58 | instead of the :ref:`autotools <ref-classes-autotools>` |
59 | or ``autotools_stage`` classes. | ||
58 | 60 | ||
59 | - The ``--foreign`` option is no longer passed to ``automake`` when | 61 | - The ``--foreign`` option is no longer passed to ``automake`` when |
60 | running ``autoconf``: This option tells ``automake`` that a | 62 | running ``autoconf``: This option tells ``automake`` that a |
diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst index 3135d69caa..eb29694bb5 100644 --- a/documentation/migration-guides/migration-2.1.rst +++ b/documentation/migration-guides/migration-2.1.rst | |||
@@ -106,12 +106,12 @@ as was previously assumed. Rather, the value changes based on whether | |||
106 | large file support is enabled. For most software that uses ``autoconf``, | 106 | large file support is enabled. For most software that uses ``autoconf``, |
107 | this change should not be a problem. However, if you have a recipe that | 107 | this change should not be a problem. However, if you have a recipe that |
108 | bypasses the standard :ref:`ref-tasks-configure` task | 108 | bypasses the standard :ref:`ref-tasks-configure` task |
109 | from the ``autotools`` class and the software the recipe is building | 109 | from the :ref:`autotools <ref-classes-autotools>` class and the software the recipe is building |
110 | uses a very old version of ``autoconf``, the recipe might be incapable | 110 | uses a very old version of ``autoconf``, the recipe might be incapable |
111 | of determining the correct size of ``off_t`` during ``do_configure``. | 111 | of determining the correct size of ``off_t`` during ``do_configure``. |
112 | 112 | ||
113 | The best course of action is to patch the software as necessary to allow | 113 | The best course of action is to patch the software as necessary to allow |
114 | the default implementation from the ``autotools`` class to work such | 114 | the default implementation from the :ref:`autotools <ref-classes-autotools>` class to work such |
115 | that ``autoreconf`` succeeds and produces a working configure script, | 115 | that ``autoreconf`` succeeds and produces a working configure script, |
116 | and to remove the overridden ``do_configure`` task such that the default | 116 | and to remove the overridden ``do_configure`` task such that the default |
117 | implementation does get used. | 117 | implementation does get used. |
@@ -262,7 +262,7 @@ The following changes have been made for the Poky distribution: | |||
262 | 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 |
263 | is downloaded at the start of the build. | 263 | is downloaded at the start of the build. |
264 | 264 | ||
265 | The ``uninative`` class is enabled through the | 265 | The :ref:`uninative <ref-classes-uninative>` class is enabled through the |
266 | ``meta/conf/distro/include/yocto-uninative.inc`` file, which for | 266 | ``meta/conf/distro/include/yocto-uninative.inc`` file, which for |
267 | those not using the Poky distribution, can include to easily enable | 267 | those not using the Poky distribution, can include to easily enable |
268 | the same functionality. | 268 | the same functionality. |
diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst index cbdc6a739e..c063deb44b 100644 --- a/documentation/migration-guides/migration-2.2.rst +++ b/documentation/migration-guides/migration-2.2.rst | |||
@@ -439,7 +439,7 @@ The following miscellaneous changes have occurred: | |||
439 | 439 | ||
440 | - ``packagegroup-core-tools-testapps``: Removed Piglit. | 440 | - ``packagegroup-core-tools-testapps``: Removed Piglit. |
441 | 441 | ||
442 | - ``image.bbclass``: Renamed COMPRESS(ION) to CONVERSION. This change | 442 | - :ref:`image.bbclass <ref-classes-image>`: Renamed COMPRESS(ION) to CONVERSION. This change |
443 | means that ``COMPRESSIONTYPES``, ``COMPRESS_DEPENDS`` and | 443 | means that ``COMPRESSIONTYPES``, ``COMPRESS_DEPENDS`` and |
444 | ``COMPRESS_CMD`` are deprecated in favor of ``CONVERSIONTYPES``, | 444 | ``COMPRESS_CMD`` are deprecated in favor of ``CONVERSIONTYPES``, |
445 | ``CONVERSION_DEPENDS`` and ``CONVERSION_CMD``. The ``COMPRESS*`` | 445 | ``CONVERSION_DEPENDS`` and ``CONVERSION_CMD``. The ``COMPRESS*`` |
diff --git a/documentation/migration-guides/migration-2.3.rst b/documentation/migration-guides/migration-2.3.rst index b79bc541c5..0b6b33d2cb 100644 --- a/documentation/migration-guides/migration-2.3.rst +++ b/documentation/migration-guides/migration-2.3.rst | |||
@@ -50,7 +50,7 @@ Consider the following: | |||
50 | post-installation script that is installed by a function added to | 50 | post-installation script that is installed by a function added to |
51 | :term:`SYSROOT_PREPROCESS_FUNCS`. | 51 | :term:`SYSROOT_PREPROCESS_FUNCS`. |
52 | 52 | ||
53 | For an example, see the ``pixbufcache`` class in ``meta/classes/`` in | 53 | For an example, see the :ref:`pixbufcache <ref-classes-pixbufcache>` class in ``meta/classes/`` in |
54 | the :ref:`overview-manual/development-environment:yocto project source repositories`. | 54 | the :ref:`overview-manual/development-environment:yocto project source repositories`. |
55 | 55 | ||
56 | .. note:: | 56 | .. note:: |
diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst index ae1a212b5d..ef5f32e6ef 100644 --- a/documentation/migration-guides/migration-2.4.rst +++ b/documentation/migration-guides/migration-2.4.rst | |||
@@ -273,7 +273,7 @@ The following are additional changes: | |||
273 | 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 |
274 | the repository. This behavior assumes the commits are enabled with | 274 | the repository. This behavior assumes the commits are enabled with |
275 | :term:`BUILDHISTORY_COMMIT` = "1", which | 275 | :term:`BUILDHISTORY_COMMIT` = "1", which |
276 | is typical. Previously, the ``buildhistory`` class made one commit | 276 | is typical. Previously, the :ref:`buildhistory <ref-classes-buildhistory>` class made one commit |
277 | 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 |
278 | the changes for a particular subdirectory. To view a particular | 278 | the changes for a particular subdirectory. To view a particular |
279 | 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 79f804fa1d..bd75522773 100644 --- a/documentation/migration-guides/migration-2.5.rst +++ b/documentation/migration-guides/migration-2.5.rst | |||
@@ -137,7 +137,7 @@ The following are BitBake changes: | |||
137 | - Several explicit "run this task for all recipes in the dependency | 137 | - Several explicit "run this task for all recipes in the dependency |
138 | tree" tasks have been removed (e.g. ``fetchall``, ``checkuriall``, | 138 | tree" tasks have been removed (e.g. ``fetchall``, ``checkuriall``, |
139 | and the ``*all`` tasks provided by the ``distrodata`` and | 139 | and the ``*all`` tasks provided by the ``distrodata`` and |
140 | ``archiver`` classes). There is a BitBake option to complete this for | 140 | :ref:`archiver <ref-classes-archiver>` classes). There is a BitBake option to complete this for |
141 | any arbitrary task. For example:: | 141 | any arbitrary task. For example:: |
142 | 142 | ||
143 | bitbake <target> -c fetchall | 143 | bitbake <target> -c fetchall |
@@ -187,7 +187,7 @@ Miscellaneous Changes | |||
187 | 187 | ||
188 | The following are additional changes: | 188 | The following are additional changes: |
189 | 189 | ||
190 | - The ``kernel`` class supports building packages for multiple kernels. | 190 | - The :ref:`kernel <ref-classes-kernel>` class supports building packages for multiple kernels. |
191 | If your kernel recipe or ``.bbappend`` file mentions packaging at | 191 | If your kernel recipe or ``.bbappend`` file mentions packaging at |
192 | all, you should replace references to the kernel in package names | 192 | all, you should replace references to the kernel in package names |
193 | with ``${KERNEL_PACKAGE_NAME}``. For example, if you disable | 193 | with ``${KERNEL_PACKAGE_NAME}``. For example, if you disable |
@@ -195,7 +195,7 @@ The following are additional changes: | |||
195 | ``RDEPENDS_kernel-base = ""`` you can avoid warnings using | 195 | ``RDEPENDS_kernel-base = ""`` you can avoid warnings using |
196 | ``RDEPENDS_${KERNEL_PACKAGE_NAME}-base = ""`` instead. | 196 | ``RDEPENDS_${KERNEL_PACKAGE_NAME}-base = ""`` instead. |
197 | 197 | ||
198 | - The ``buildhistory`` class commits changes to the repository by | 198 | - The :ref:`buildhistory <ref-classes-buildhistory>` class commits changes to the repository by |
199 | default so you no longer need to set ``BUILDHISTORY_COMMIT = "1"``. | 199 | default so you no longer need to set ``BUILDHISTORY_COMMIT = "1"``. |
200 | If you want to disable commits you need to set | 200 | If you want to disable commits you need to set |
201 | ``BUILDHISTORY_COMMIT = "0"`` in your configuration. | 201 | ``BUILDHISTORY_COMMIT = "0"`` in your configuration. |
@@ -207,7 +207,7 @@ The following are additional changes: | |||
207 | maintains a full-featured BSP in the ``meta-ti`` layer. This rename | 207 | maintains a full-featured BSP in the ``meta-ti`` layer. This rename |
208 | avoids the previous name clash that existed between the two BSPs. | 208 | avoids the previous name clash that existed between the two BSPs. |
209 | 209 | ||
210 | - The ``update-alternatives`` class no longer works with SysV ``init`` | 210 | - The :ref:`update-alternatives <ref-classes-update-alternatives>` class no longer works with SysV ``init`` |
211 | scripts because this usage has been problematic. Also, the | 211 | scripts because this usage has been problematic. Also, the |
212 | ``sysklogd`` recipe no longer uses ``update-alternatives`` because it | 212 | ``sysklogd`` recipe no longer uses ``update-alternatives`` because it |
213 | is incompatible with other implementations. | 213 | is incompatible with other implementations. |
diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst index 9a5f5714bd..610298bda6 100644 --- a/documentation/migration-guides/migration-3.0.rst +++ b/documentation/migration-guides/migration-3.0.rst | |||
@@ -47,7 +47,7 @@ The following recipes have been removed. | |||
47 | - ``core-image-lsb-sdk``: Part of removed LSB support. | 47 | - ``core-image-lsb-sdk``: Part of removed LSB support. |
48 | 48 | ||
49 | - ``cve-check-tool``: Functionally replaced by the ``cve-update-db`` | 49 | - ``cve-check-tool``: Functionally replaced by the ``cve-update-db`` |
50 | recipe and ``cve-check`` class. | 50 | recipe and :ref:`cve-check <ref-classes-cve-check>` class. |
51 | 51 | ||
52 | - ``eglinfo``: No longer maintained. ``eglinfo`` from ``mesa-demos`` is | 52 | - ``eglinfo``: No longer maintained. ``eglinfo`` from ``mesa-demos`` is |
53 | an adequate and maintained alternative. | 53 | an adequate and maintained alternative. |
@@ -142,7 +142,7 @@ CVE Checking | |||
142 | ------------ | 142 | ------------ |
143 | 143 | ||
144 | ``cve-check-tool`` has been functionally replaced by a new | 144 | ``cve-check-tool`` has been functionally replaced by a new |
145 | ``cve-update-db`` recipe and functionality built into the ``cve-check`` | 145 | ``cve-update-db`` recipe and functionality built into the :ref:`cve-check <ref-classes-cve-check>` |
146 | class. The result uses NVD JSON data feeds rather than the deprecated | 146 | class. The result uses NVD JSON data feeds rather than the deprecated |
147 | XML feeds that ``cve-check-tool`` was using, supports CVSSv3 scoring, | 147 | XML feeds that ``cve-check-tool`` was using, supports CVSSv3 scoring, |
148 | and makes other improvements. | 148 | and makes other improvements. |
diff --git a/documentation/migration-guides/migration-3.1.rst b/documentation/migration-guides/migration-3.1.rst index 80b8f6baa5..cb0296717e 100644 --- a/documentation/migration-guides/migration-3.1.rst +++ b/documentation/migration-guides/migration-3.1.rst | |||
@@ -125,7 +125,7 @@ renamed to ``features_check``; the ``distro_features_check`` class still | |||
125 | exists but generates a warning and redirects to the new class. In | 125 | exists but generates a warning and redirects to the new class. In |
126 | preparation for a future removal of the old class it is recommended that | 126 | preparation for a future removal of the old class it is recommended that |
127 | you update recipes currently inheriting ``distro_features_check`` to | 127 | you update recipes currently inheriting ``distro_features_check`` to |
128 | inherit ``features_check`` instead. | 128 | inherit :ref:`features_check <ref-classes-features_check>` instead. |
129 | 129 | ||
130 | .. _migration-3.1-removed-classes: | 130 | .. _migration-3.1-removed-classes: |
131 | 131 | ||
@@ -241,7 +241,7 @@ circumstances: | |||
241 | does not inherit the new ``mime-xdg`` class | 241 | does not inherit the new ``mime-xdg`` class |
242 | 242 | ||
243 | - A recipe installs ``.xml`` files into ``${datadir}/mime/packages`` | 243 | - A recipe installs ``.xml`` files into ``${datadir}/mime/packages`` |
244 | but does not inherit the ``mime`` class | 244 | but does not inherit the :ref:`mime <ref-classes-mime>` class |
245 | 245 | ||
246 | .. _migration-3.1-x86-live-wic: | 246 | .. _migration-3.1-x86-live-wic: |
247 | 247 | ||
diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst index a940f23238..d593effe97 100644 --- a/documentation/migration-guides/migration-3.2.rst +++ b/documentation/migration-guides/migration-3.2.rst | |||
@@ -209,7 +209,7 @@ deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` | |||
209 | 209 | ||
210 | ``do_deploy`` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as ``do_install`` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. | 210 | ``do_deploy`` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as ``do_install`` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. |
211 | 211 | ||
212 | Most recipes and classes that inherit the ``deploy`` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` - these should be refactored to use ``do_deploy_prepend`` instead. | 212 | Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` class or interact with ``do_deploy`` are unlikely to be affected by this unless they add ``prefuncs`` to ``do_deploy`` *which also* put files into ``${DEPLOYDIR}`` - these should be refactored to use ``do_deploy_prepend`` instead. |
213 | 213 | ||
214 | 214 | ||
215 | .. _migration-3.2-nativesdk-sdk-provides-dummy: | 215 | .. _migration-3.2-nativesdk-sdk-provides-dummy: |
diff --git a/documentation/migration-guides/migration-3.3.rst b/documentation/migration-guides/migration-3.3.rst index 28857e820b..f065a17e68 100644 --- a/documentation/migration-guides/migration-3.3.rst +++ b/documentation/migration-guides/migration-3.3.rst | |||
@@ -64,7 +64,7 @@ New ``python3targetconfig`` class | |||
64 | 64 | ||
65 | A new :ref:`python3targetconfig <ref-classes-python3targetconfig>` class has been | 65 | A new :ref:`python3targetconfig <ref-classes-python3targetconfig>` class has been |
66 | created for situations where you would previously have inherited the | 66 | created for situations where you would previously have inherited the |
67 | ``python3native`` class but need access to target configuration data (such as | 67 | :ref:`python3native <ref-classes-python3native>` class but need access to target configuration data (such as |
68 | correct installation directories). Recipes where this situation applies should | 68 | correct installation directories). Recipes where this situation applies should |
69 | be changed to inherit ``python3targetconfig`` instead of ``python3native``. This | 69 | be changed to inherit ``python3targetconfig`` instead of ``python3native``. This |
70 | also adds a dependency on target ``python3``, so it should only be used where | 70 | also adds a dependency on target ``python3``, so it should only be used where |