summaryrefslogtreecommitdiffstats
path: root/documentation/migration-guides
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2021-05-27 20:41:17 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-06-19 16:54:01 +0100
commit7d3f57cfd2e4322bcd96d67d330124f221a9aedd (patch)
tree5d07321b7c8bc59bb7fcc0372fab8b7a1966cf06 /documentation/migration-guides
parent7a9b74e9d2a5cf3b1fb3ac7565c50eae6e0d4632 (diff)
downloadpoky-7d3f57cfd2e4322bcd96d67d330124f221a9aedd.tar.gz
docs: replace ``FOO`` by :term:`FOO` where possible
If a variable has a glossary entry and some rST files write about those variables, it's better to point to the glossary entry instead of just highlighting it by surrounding it with two tick quotes. This was automated by the following python script: """ import re from pathlib import Path with open('objects.inv.txt', 'r') as f: objects = f.readlines() with open('bitbake-objects.inv.txt', 'r') as f: objects = objects + f.readlines() re_term = re.compile(r'variables.html#term-([A-Z_0-9]*)') terms = [] for obj in objects: match = re_term.search(obj) if match and match.group(1): terms.append(match.group(1)) for rst in Path('.').rglob('*.rst'): with open(rst, 'r') as f: content = "".joing(f.readlines()) for term in terms: content = re.sub(r'``({})``(?!.*\s*[~-]+)'.format(term), r':term:`\1`', content) with open(rst, 'w') as f: f.write(content) """ (From yocto-docs rev: ba49d9babfcb84bc5c26a68c8c3880a1d9c236d3) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/migration-guides')
-rw-r--r--documentation/migration-guides/migration-1.3.rst4
-rw-r--r--documentation/migration-guides/migration-1.4.rst14
-rw-r--r--documentation/migration-guides/migration-1.5.rst22
-rw-r--r--documentation/migration-guides/migration-1.6.rst12
-rw-r--r--documentation/migration-guides/migration-1.7.rst4
-rw-r--r--documentation/migration-guides/migration-1.8.rst4
-rw-r--r--documentation/migration-guides/migration-2.0.rst4
-rw-r--r--documentation/migration-guides/migration-2.1.rst8
-rw-r--r--documentation/migration-guides/migration-2.2.rst6
-rw-r--r--documentation/migration-guides/migration-2.3.rst20
-rw-r--r--documentation/migration-guides/migration-2.4.rst4
-rw-r--r--documentation/migration-guides/migration-2.5.rst2
-rw-r--r--documentation/migration-guides/migration-2.6.rst22
-rw-r--r--documentation/migration-guides/migration-2.7.rst2
-rw-r--r--documentation/migration-guides/migration-3.1.rst2
-rw-r--r--documentation/migration-guides/migration-3.2.rst6
16 files changed, 68 insertions, 68 deletions
diff --git a/documentation/migration-guides/migration-1.3.rst b/documentation/migration-guides/migration-1.3.rst
index db5333ccd7..afb868e7cb 100644
--- a/documentation/migration-guides/migration-1.3.rst
+++ b/documentation/migration-guides/migration-1.3.rst
@@ -125,7 +125,7 @@ Image recipes that previously included ``apps-console-core`` in
125:term:`IMAGE_FEATURES` should now include ``splash`` 125:term:`IMAGE_FEATURES` should now include ``splash``
126instead to enable the boot-up splash screen. Retaining 126instead to enable the boot-up splash screen. Retaining
127``apps-console-core`` will still include the splash screen but generates a 127``apps-console-core`` will still include the splash screen but generates a
128warning. The ``apps-x11-core`` and ``apps-x11-games`` ``IMAGE_FEATURES`` 128warning. The ``apps-x11-core`` and ``apps-x11-games`` :term:`IMAGE_FEATURES`
129features have been removed. 129features have been removed.
130 130
131.. _migration-1.3-removed-recipes: 131.. _migration-1.3-removed-recipes:
@@ -185,7 +185,7 @@ include :term:`PE` as part of the filename::
185 185
186 KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PE}-${PV}-${PR}-${MACHINE}-${DATETIME}" 186 KERNEL_IMAGE_BASE_NAME ?= "${KERNEL_IMAGETYPE}-${PE}-${PV}-${PR}-${MACHINE}-${DATETIME}"
187 187
188Because the ``PE`` variable is not set by default, these binary files 188Because the :term:`PE` variable is not set by default, these binary files
189could result with names that include two dash characters. Here is an 189could result with names that include two dash characters. Here is an
190example:: 190example::
191 191
diff --git a/documentation/migration-guides/migration-1.4.rst b/documentation/migration-guides/migration-1.4.rst
index 07dd93b761..3f980915cf 100644
--- a/documentation/migration-guides/migration-1.4.rst
+++ b/documentation/migration-guides/migration-1.4.rst
@@ -28,7 +28,7 @@ Differences include the following:
28 and uninstall script functions ``pkg_preinst``, ``pkg_postinst``, 28 and uninstall script functions ``pkg_preinst``, ``pkg_postinst``,
29 ``pkg_prerm``, and ``pkg_postrm`` should always have a package name 29 ``pkg_prerm``, and ``pkg_postrm`` should always have a package name
30 override. For example, use ``RDEPENDS_${PN}`` for the main package 30 override. For example, use ``RDEPENDS_${PN}`` for the main package
31 instead of ``RDEPENDS``. BitBake uses more strict checks when it 31 instead of :term:`RDEPENDS`. BitBake uses more strict checks when it
32 parses recipes. 32 parses recipes.
33 33
34.. _migration-1.4-build-behavior: 34.. _migration-1.4-build-behavior:
@@ -53,10 +53,10 @@ Differences include the following:
53 :term:`SRC_URI`, the build system now uses 53 :term:`SRC_URI`, the build system now uses
54 :term:`FILESOVERRIDES` instead of 54 :term:`FILESOVERRIDES` instead of
55 :term:`OVERRIDES` for the directory names. In 55 :term:`OVERRIDES` for the directory names. In
56 general, the values previously in ``OVERRIDES`` are now in 56 general, the values previously in :term:`OVERRIDES` are now in
57 ``FILESOVERRIDES`` as well. However, if you relied upon an additional 57 :term:`FILESOVERRIDES` as well. However, if you relied upon an additional
58 value you previously added to ``OVERRIDES``, you might now need to 58 value you previously added to :term:`OVERRIDES`, you might now need to
59 add it to ``FILESOVERRIDES`` unless you are already adding it through 59 add it to :term:`FILESOVERRIDES` unless you are already adding it through
60 the :term:`MACHINEOVERRIDES` or 60 the :term:`MACHINEOVERRIDES` or
61 :term:`DISTROOVERRIDES` variables, as 61 :term:`DISTROOVERRIDES` variables, as
62 appropriate. For more related changes, see the 62 appropriate. For more related changes, see the
@@ -105,7 +105,7 @@ Variables
105 105
106The following variables have changed: 106The following variables have changed:
107 107
108- ``SANITY_TESTED_DISTROS``: This variable now uses a distribution 108- :term:`SANITY_TESTED_DISTROS`: This variable now uses a distribution
109 ID, which is composed of the host distributor ID followed by the 109 ID, which is composed of the host distributor ID followed by the
110 release. Previously, 110 release. Previously,
111 :term:`SANITY_TESTED_DISTROS` was 111 :term:`SANITY_TESTED_DISTROS` was
@@ -114,7 +114,7 @@ The following variables have changed:
114 you are not specifically setting this variable, or if you are 114 you are not specifically setting this variable, or if you are
115 specifically setting it to "". 115 specifically setting it to "".
116 116
117- ``SRC_URI``: The ``${``\ :term:`PN`\ ``}``, 117- :term:`SRC_URI`: The ``${``\ :term:`PN`\ ``}``,
118 ``${``\ :term:`PF`\ ``}``, 118 ``${``\ :term:`PF`\ ``}``,
119 ``${``\ :term:`P`\ ``}``, and ``FILE_DIRNAME`` directories 119 ``${``\ :term:`P`\ ``}``, and ``FILE_DIRNAME`` directories
120 have been dropped from the default value of the 120 have been dropped from the default value of the
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst
index f6bd118c9d..e956d9fffa 100644
--- a/documentation/migration-guides/migration-1.5.rst
+++ b/documentation/migration-guides/migration-1.5.rst
@@ -68,7 +68,7 @@ The following changes have been made that relate to BitBake:
68- ``${``\ :term:`P`\ ``}`` and 68- ``${``\ :term:`P`\ ``}`` and
69 ``${``\ :term:`PF`\ ``}`` are no longer added to 69 ``${``\ :term:`PF`\ ``}`` are no longer added to
70 :term:`PROVIDES` by default in ``bitbake.conf``. 70 :term:`PROVIDES` by default in ``bitbake.conf``.
71 These version-specific ``PROVIDES`` items were seldom used. 71 These version-specific :term:`PROVIDES` items were seldom used.
72 Attempting to use them could result in two versions being built 72 Attempting to use them could result in two versions being built
73 simultaneously rather than just one version due to the way BitBake 73 simultaneously rather than just one version due to the way BitBake
74 resolves dependencies. 74 resolves dependencies.
@@ -84,9 +84,9 @@ The following changes have been made to the package QA checks:
84 :term:`WARN_QA` values in your configuration, check 84 :term:`WARN_QA` values in your configuration, check
85 that they contain all of the issues that you wish to be reported. 85 that they contain all of the issues that you wish to be reported.
86 Previous Yocto Project versions contained a bug that meant that any 86 Previous Yocto Project versions contained a bug that meant that any
87 item not mentioned in ``ERROR_QA`` or ``WARN_QA`` would be treated as 87 item not mentioned in :term:`ERROR_QA` or :term:`WARN_QA` would be treated as
88 a warning. Consequently, several important items were not already in 88 a warning. Consequently, several important items were not already in
89 the default value of ``WARN_QA``. All of the possible QA checks are 89 the default value of :term:`WARN_QA`. All of the possible QA checks are
90 now documented in the ":ref:`insane.bbclass <ref-classes-insane>`" 90 now documented in the ":ref:`insane.bbclass <ref-classes-insane>`"
91 section. 91 section.
92 92
@@ -97,7 +97,7 @@ The following changes have been made to the package QA checks:
97 97
98- If you are using the ``buildhistory`` class, the check for the package 98- If you are using the ``buildhistory`` class, the check for the package
99 version going backwards is now controlled using a standard QA check. 99 version going backwards is now controlled using a standard QA check.
100 Thus, if you have customized your ``ERROR_QA`` or ``WARN_QA`` values 100 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 101 and still wish to have this check performed, you should add
102 "version-going-backwards" to your value for one or the other 102 "version-going-backwards" to your value for one or the other
103 variables depending on how you wish it to be handled. See the 103 variables depending on how you wish it to be handled. See the
@@ -129,7 +129,7 @@ The following directory changes exist:
129- When buildhistory is enabled, its output is now written under the 129- When buildhistory is enabled, its output is now written under the
130 :term:`Build Directory` rather than 130 :term:`Build Directory` rather than
131 :term:`TMPDIR`. Doing so makes it easier to delete 131 :term:`TMPDIR`. Doing so makes it easier to delete
132 ``TMPDIR`` and preserve the build history. Additionally, data for 132 :term:`TMPDIR` and preserve the build history. Additionally, data for
133 produced SDKs is now split by :term:`IMAGE_NAME`. 133 produced SDKs is now split by :term:`IMAGE_NAME`.
134 134
135- The ``pkgdata`` directory produced as part of the packaging process 135- The ``pkgdata`` directory produced as part of the packaging process
@@ -157,20 +157,20 @@ major issue in the way the values are used.
157The following changes have been made that relate to 157The following changes have been made that relate to
158:term:`IMAGE_FEATURES`: 158:term:`IMAGE_FEATURES`:
159 159
160- The value of ``IMAGE_FEATURES`` is now validated to ensure invalid 160- The value of :term:`IMAGE_FEATURES` is now validated to ensure invalid
161 feature items are not added. Some users mistakenly add package names 161 feature items are not added. Some users mistakenly add package names
162 to this variable instead of using 162 to this variable instead of using
163 :term:`IMAGE_INSTALL` in order to have the 163 :term:`IMAGE_INSTALL` in order to have the
164 package added to the image, which does not work. This change is 164 package added to the image, which does not work. This change is
165 intended to catch those kinds of situations. Valid ``IMAGE_FEATURES`` 165 intended to catch those kinds of situations. Valid :term:`IMAGE_FEATURES`
166 are drawn from ``PACKAGE_GROUP`` definitions, 166 are drawn from ``PACKAGE_GROUP`` definitions,
167 :term:`COMPLEMENTARY_GLOB` and a new 167 :term:`COMPLEMENTARY_GLOB` and a new
168 "validitems" varflag on ``IMAGE_FEATURES``. The "validitems" varflag 168 "validitems" varflag on :term:`IMAGE_FEATURES`. The "validitems" varflag
169 change allows additional features to be added if they are not 169 change allows additional features to be added if they are not
170 provided using the previous two mechanisms. 170 provided using the previous two mechanisms.
171 171
172- The previously deprecated "apps-console-core" ``IMAGE_FEATURES`` item 172- The previously deprecated "apps-console-core" :term:`IMAGE_FEATURES` item
173 is no longer supported. Add "splash" to ``IMAGE_FEATURES`` if you 173 is no longer supported. Add "splash" to :term:`IMAGE_FEATURES` if you
174 wish to have the splash screen enabled, since this is all that 174 wish to have the splash screen enabled, since this is all that
175 apps-console-core was doing. 175 apps-console-core was doing.
176 176
@@ -285,7 +285,7 @@ Following are changes to ``udev``:
285 ``udev-extraconf`` to your image. 285 ``udev-extraconf`` to your image.
286 286
287- ``udev`` no longer brings in ``pciutils-ids`` or ``usbutils-ids`` 287- ``udev`` no longer brings in ``pciutils-ids`` or ``usbutils-ids``
288 through ``RRECOMMENDS``. These are not needed by ``udev`` itself and 288 through :term:`RRECOMMENDS`. These are not needed by ``udev`` itself and
289 removing them saves around 350KB. 289 removing them saves around 350KB.
290 290
291.. _migration-1.5-removed-renamed-recipes: 291.. _migration-1.5-removed-renamed-recipes:
diff --git a/documentation/migration-guides/migration-1.6.rst b/documentation/migration-guides/migration-1.6.rst
index 1408e12c23..eea3d17676 100644
--- a/documentation/migration-guides/migration-1.6.rst
+++ b/documentation/migration-guides/migration-1.6.rst
@@ -61,7 +61,7 @@ If you do not specify a branch, BitBake looks in the default "master" branch.
61 61
62Alternatively, if you need to bypass this check (e.g. if you are 62Alternatively, if you need to bypass this check (e.g. if you are
63fetching a revision corresponding to a tag that is not on any branch), 63fetching a revision corresponding to a tag that is not on any branch),
64you can add ";nobranch=1" to the end of the URL within ``SRC_URI``. 64you can add ";nobranch=1" to the end of the URL within :term:`SRC_URI`.
65 65
66.. _migration-1.6-bitbake-deps: 66.. _migration-1.6-bitbake-deps:
67 67
@@ -134,9 +134,9 @@ OpenEmbedded build system variables, see the ":doc:`/ref-manual/variables`" Chap
134 134
135:term:`TMPDIR` can no longer be on an NFS mount. NFS does 135:term:`TMPDIR` can no longer be on an NFS mount. NFS does
136not offer full POSIX locking and inode consistency and can cause 136not offer full POSIX locking and inode consistency and can cause
137unexpected issues if used to store ``TMPDIR``. 137unexpected issues if used to store :term:`TMPDIR`.
138 138
139The check for this occurs on startup. If ``TMPDIR`` is detected on an 139The check for this occurs on startup. If :term:`TMPDIR` is detected on an
140NFS mount, an error occurs. 140NFS mount, an error occurs.
141 141
142.. _migration-1.6-variable-changes-PRINC: 142.. _migration-1.6-variable-changes-PRINC:
@@ -274,7 +274,7 @@ In addition to ``core-image-basic`` being renamed,
274Licensing 274Licensing
275--------- 275---------
276 276
277The top-level ``LICENSE`` file has been changed to better describe the 277The top-level :term:`LICENSE` file has been changed to better describe the
278license of the various components of :term:`OpenEmbedded-Core (OE-Core)`. However, 278license of the various components of :term:`OpenEmbedded-Core (OE-Core)`. However,
279the licensing itself remains unchanged. 279the licensing itself remains unchanged.
280 280
@@ -284,7 +284,7 @@ recipes point to this file within
284``${COREBASE}/LICENSE``) and thus the accompanying checksum must be 284``${COREBASE}/LICENSE``) and thus the accompanying checksum must be
285changed from 3f40d7994397109285ec7b81fdeb3b58 to 285changed from 3f40d7994397109285ec7b81fdeb3b58 to
2864d92cd373abda3937c2bc47fbc49d690. A better alternative is to have 2864d92cd373abda3937c2bc47fbc49d690. A better alternative is to have
287``LIC_FILES_CHKSUM`` point to a file describing the license that is 287:term:`LIC_FILES_CHKSUM` point to a file describing the license that is
288distributed with the source that the recipe is building, if possible, 288distributed with the source that the recipe is building, if possible,
289rather than pointing to ``${COREBASE}/LICENSE``. 289rather than pointing to ``${COREBASE}/LICENSE``.
290 290
@@ -297,7 +297,7 @@ The "-fpermissive" option has been removed from the default
297:term:`CFLAGS` value. You need to take action on 297:term:`CFLAGS` value. You need to take action on
298individual recipes that fail when building with this option. You need to 298individual recipes that fail when building with this option. You need to
299either patch the recipes to fix the issues reported by the compiler, or 299either patch the recipes to fix the issues reported by the compiler, or
300you need to add "-fpermissive" to ``CFLAGS`` in the recipes. 300you need to add "-fpermissive" to :term:`CFLAGS` in the recipes.
301 301
302.. _migration-1.6-custom-images: 302.. _migration-1.6-custom-images:
303 303
diff --git a/documentation/migration-guides/migration-1.7.rst b/documentation/migration-guides/migration-1.7.rst
index 999f11a12b..c3a50eec88 100644
--- a/documentation/migration-guides/migration-1.7.rst
+++ b/documentation/migration-guides/migration-1.7.rst
@@ -140,9 +140,9 @@ part of the variable name. This change not only simplifies usage but
140also allows the values of these variables to be appropriately 140also allows the values of these variables to be appropriately
141incorporated into task signatures and thus trigger the appropriate tasks 141incorporated into task signatures and thus trigger the appropriate tasks
142to re-execute when changed. You should replace any references to 142to re-execute when changed. You should replace any references to
143``module_autoload_*`` with ``KERNEL_MODULE_AUTOLOAD``, and add any 143``module_autoload_*`` with :term:`KERNEL_MODULE_AUTOLOAD`, and add any
144modules for which ``module_conf_*`` is specified to 144modules for which ``module_conf_*`` is specified to
145``KERNEL_MODULE_PROBECONF``. 145:term:`KERNEL_MODULE_PROBECONF`.
146 146
147.. _migration-1.7-qa-check-changes: 147.. _migration-1.7-qa-check-changes:
148 148
diff --git a/documentation/migration-guides/migration-1.8.rst b/documentation/migration-guides/migration-1.8.rst
index 971bd33f40..51a13873e2 100644
--- a/documentation/migration-guides/migration-1.8.rst
+++ b/documentation/migration-guides/migration-1.8.rst
@@ -153,8 +153,8 @@ The following QA Check and Validation Changes have occurred:
153 instead of ``${D}``. 153 instead of ``${D}``.
154 154
155- :term:`S` now needs to be set to a valid value within a 155- :term:`S` now needs to be set to a valid value within a
156 recipe. If ``S`` is not set in the recipe, the directory is not 156 recipe. If :term:`S` is not set in the recipe, the directory is not
157 automatically created. If ``S`` does not point to a directory that 157 automatically created. If :term:`S` does not point to a directory that
158 exists at the time the :ref:`ref-tasks-unpack` task 158 exists at the time the :ref:`ref-tasks-unpack` task
159 finishes, a warning will be shown. 159 finishes, a warning will be shown.
160 160
diff --git a/documentation/migration-guides/migration-2.0.rst b/documentation/migration-guides/migration-2.0.rst
index 22d0752226..7217853779 100644
--- a/documentation/migration-guides/migration-2.0.rst
+++ b/documentation/migration-guides/migration-2.0.rst
@@ -25,7 +25,7 @@ and the porting guide at
25https://gcc.gnu.org/gcc-5/porting_to.html. 25https://gcc.gnu.org/gcc-5/porting_to.html.
26 26
27Alternatively, you can switch back to GCC 4.9 or 4.8 by setting 27Alternatively, you can switch back to GCC 4.9 or 4.8 by setting
28``GCCVERSION`` in your configuration, as follows:: 28:term:`GCCVERSION` in your configuration, as follows::
29 29
30 GCCVERSION = "4.9%" 30 GCCVERSION = "4.9%"
31 31
@@ -244,7 +244,7 @@ The following QA checks have been added:
244 244
245- Added an "invalid-packageconfig" check for any options specified in 245- Added an "invalid-packageconfig" check for any options specified in
246 :term:`PACKAGECONFIG` that do not match any 246 :term:`PACKAGECONFIG` that do not match any
247 ``PACKAGECONFIG`` option defined for the recipe. 247 :term:`PACKAGECONFIG` option defined for the recipe.
248 248
249.. _migration-2.0-miscellaneous: 249.. _migration-2.0-miscellaneous:
250 250
diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst
index d4db8218cf..6c5ed965dc 100644
--- a/documentation/migration-guides/migration-2.1.rst
+++ b/documentation/migration-guides/migration-2.1.rst
@@ -28,8 +28,8 @@ characters. This practice is now a requirement as BitBake's datastore
28now assumes lower-case characters in order to give a slight performance 28now assumes lower-case characters in order to give a slight performance
29boost during parsing. In practical terms, this requirement means that 29boost during parsing. In practical terms, this requirement means that
30anything that ends up in :term:`OVERRIDES` must now 30anything that ends up in :term:`OVERRIDES` must now
31appear in lower-case characters (e.g. values for ``MACHINE``, 31appear in lower-case characters (e.g. values for :term:`MACHINE`,
32``TARGET_ARCH``, ``DISTRO``, and also recipe names if 32:term:`TARGET_ARCH`, :term:`DISTRO`, and also recipe names if
33``_pn-``\ recipename overrides are to be effective). 33``_pn-``\ recipename overrides are to be effective).
34 34
35.. _migration-2.1-expand-parameter-to-getvar-and-getvarflag-now-mandatory: 35.. _migration-2.1-expand-parameter-to-getvar-and-getvarflag-now-mandatory:
@@ -68,7 +68,7 @@ was a historical accident that has required many classes (e.g.
68to work with sensible build systems. When upgrading to the release, you 68to work with sensible build systems. When upgrading to the release, you
69must edit any recipe that relies upon this old default by either setting 69must edit any recipe that relies upon this old default by either setting
70``EXTRA_OEMAKE`` back to "-e MAKEFLAGS=" or by explicitly setting any 70``EXTRA_OEMAKE`` back to "-e MAKEFLAGS=" or by explicitly setting any
71required variable value overrides using ``EXTRA_OEMAKE``, which is 71required variable value overrides using :term:`EXTRA_OEMAKE`, which is
72typically only needed when a Makefile sets a default value for a 72typically only needed when a Makefile sets a default value for a
73variable that is inappropriate for cross-compilation using the "=" 73variable that is inappropriate for cross-compilation using the "="
74operator rather than the "?=" operator. 74operator rather than the "?=" operator.
@@ -376,7 +376,7 @@ These additional changes exist:
376 run-postinsts 376 run-postinsts
377 377
378 With the Yocto Project 2.1 release, these packages are 378 With the Yocto Project 2.1 release, these packages are
379 only removed if "read-only-rootfs" is in ``IMAGE_FEATURES``, since 379 only removed if "read-only-rootfs" is in :term:`IMAGE_FEATURES`, since
380 they might still be needed for a read-write image even in the absence 380 they might still be needed for a read-write image even in the absence
381 of a package manager (e.g. if users need to be added, modified, or 381 of a package manager (e.g. if users need to be added, modified, or
382 removed at runtime). 382 removed at runtime).
diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst
index e30761dc99..c93081e1da 100644
--- a/documentation/migration-guides/migration-2.2.rst
+++ b/documentation/migration-guides/migration-2.2.rst
@@ -239,7 +239,7 @@ to catch recipes that are building software without using the
239OpenEmbedded :term:`LDFLAGS`. This change could result in 239OpenEmbedded :term:`LDFLAGS`. This change could result in
240seeing some "No GNU_HASH in the elf binary" QA issues when building such 240seeing some "No GNU_HASH in the elf binary" QA issues when building such
241recipes. You need to fix these recipes so that they use the expected 241recipes. You need to fix these recipes so that they use the expected
242``LDFLAGS``. Depending on how the software is built, the build system 242:term:`LDFLAGS`. Depending on how the software is built, the build system
243used by the software (e.g. a Makefile) might need to be patched. 243used by the software (e.g. a Makefile) might need to be patched.
244However, sometimes making this fix is as simple as adding the following 244However, sometimes making this fix is as simple as adding the following
245to the recipe:: 245to the recipe::
@@ -291,7 +291,7 @@ The following changes took place for BitBake:
291 :term:`SRC_URI` parameters to specify these. This 291 :term:`SRC_URI` parameters to specify these. This
292 change is more in-line with how the other fetchers work for source 292 change is more in-line with how the other fetchers work for source
293 control systems. Recipes that fetch from Perforce will need to be 293 control systems. Recipes that fetch from Perforce will need to be
294 updated to use ``SRCREV`` in place of specifying the source revision 294 updated to use :term:`SRCREV` in place of specifying the source revision
295 within ``SRC_URI``. 295 within ``SRC_URI``.
296 296
297- Some of BitBake's internal code structures for accessing the recipe 297- Some of BitBake's internal code structures for accessing the recipe
@@ -308,7 +308,7 @@ The following changes took place for BitBake:
308 to cause any problems for most users. However, the setscene 308 to cause any problems for most users. However, the setscene
309 verification function as pointed to by 309 verification function as pointed to by
310 ``BB_SETSCENE_VERIFY_FUNCTION`` needed to change signature. 310 ``BB_SETSCENE_VERIFY_FUNCTION`` needed to change signature.
311 Consequently, a new variable named ``BB_SETSCENE_VERIFY_FUNCTION2`` 311 Consequently, a new variable named :term:`BB_SETSCENE_VERIFY_FUNCTION2`
312 has been added allowing multiple versions of BitBake to work with 312 has been added allowing multiple versions of BitBake to work with
313 suitably written metadata, which includes OpenEmbedded-Core and Poky. 313 suitably written metadata, which includes OpenEmbedded-Core and Poky.
314 Anyone with custom BitBake task scheduler code might also need to 314 Anyone with custom BitBake task scheduler code might also need to
diff --git a/documentation/migration-guides/migration-2.3.rst b/documentation/migration-guides/migration-2.3.rst
index 6cdc209e35..f9bdf0d27b 100644
--- a/documentation/migration-guides/migration-2.3.rst
+++ b/documentation/migration-guides/migration-2.3.rst
@@ -35,7 +35,7 @@ Consider the following:
35 As an example, see the ``dbus`` recipe. You will see that this recipe 35 As an example, see the ``dbus`` recipe. You will see that this recipe
36 has a ``pkg_postinst`` that calls ``systemctl`` if "systemd" is in 36 has a ``pkg_postinst`` that calls ``systemctl`` if "systemd" is in
37 :term:`DISTRO_FEATURES`. In the example, 37 :term:`DISTRO_FEATURES`. In the example,
38 ``systemd-systemctl-native`` is added to ``PACKAGE_WRITE_DEPS``, 38 ``systemd-systemctl-native`` is added to :term:`PACKAGE_WRITE_DEPS`,
39 which is also conditional on "systemd" being in ``DISTRO_FEATURES``. 39 which is also conditional on "systemd" being in ``DISTRO_FEATURES``.
40 40
41- Examine Recipes that Use ``SSTATEPOSTINSTFUNCS``: You need to 41- Examine Recipes that Use ``SSTATEPOSTINSTFUNCS``: You need to
@@ -136,7 +136,7 @@ The following changes to scripts took place:
136 removed because the script was found to be deleting files it should 136 removed because the script was found to be deleting files it should
137 not have, which lead to broken build trees. Rather than trying to 137 not have, which lead to broken build trees. Rather than trying to
138 delete portions of :term:`TMPDIR` and getting it wrong, 138 delete portions of :term:`TMPDIR` and getting it wrong,
139 it is recommended that you delete ``TMPDIR`` and have it restored 139 it is recommended that you delete :term:`TMPDIR` and have it restored
140 from shared state (sstate) on subsequent builds. 140 from shared state (sstate) on subsequent builds.
141 141
142- ``wipe-sysroot``: The ``wipe-sysroot`` script has been removed as 142- ``wipe-sysroot``: The ``wipe-sysroot`` script has been removed as
@@ -200,10 +200,10 @@ The following changes took place for BitBake:
200 section in the BitBake 200 section in the BitBake
201 User Manual for additional information. 201 User Manual for additional information.
202 202
203- ``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2`` 203- ``BB_SETSCENE_VERIFY_FUNCTION`` and :term:`BB_SETSCENE_VERIFY_FUNCTION2`
204 Removed: Because the mechanism they were part of is no longer 204 Removed: Because the mechanism they were part of is no longer
205 necessary with recipe-specific sysroots, the 205 necessary with recipe-specific sysroots, the
206 ``BB_SETSCENE_VERIFY_FUNCTION`` and ``BB_SETSCENE_VERIFY_FUNCTION2`` 206 ``BB_SETSCENE_VERIFY_FUNCTION`` and :term:`BB_SETSCENE_VERIFY_FUNCTION2`
207 variables have been removed. 207 variables have been removed.
208 208
209.. _migration-2.3-absolute-symlinks: 209.. _migration-2.3-absolute-symlinks:
@@ -426,10 +426,10 @@ The following miscellaneous changes have occurred:
426 426
427- If the :term:`DISTRO_VERSION` value contains 427- If the :term:`DISTRO_VERSION` value contains
428 the value of the :term:`DATE` variable, which is the 428 the value of the :term:`DATE` variable, which is the
429 default between Poky releases, the ``DATE`` value is explicitly 429 default between Poky releases, the :term:`DATE` value is explicitly
430 excluded from ``/etc/issue`` and ``/etc/issue.net``, which is 430 excluded from ``/etc/issue`` and ``/etc/issue.net``, which is
431 displayed at the login prompt, in order to avoid conflicts with 431 displayed at the login prompt, in order to avoid conflicts with
432 Multilib enabled. Regardless, the ``DATE`` value is inaccurate if the 432 Multilib enabled. Regardless, the :term:`DATE` value is inaccurate if the
433 ``base-files`` recipe is restored from shared state (sstate) rather 433 ``base-files`` recipe is restored from shared state (sstate) rather
434 than rebuilt. 434 than rebuilt.
435 435
@@ -451,7 +451,7 @@ The following miscellaneous changes have occurred:
451 tools. 451 tools.
452 452
453- The ``USE_LDCONFIG`` variable has been replaced with the "ldconfig" 453- The ``USE_LDCONFIG`` variable has been replaced with the "ldconfig"
454 ``DISTRO_FEATURES`` feature. Distributions that previously set:: 454 :term:`DISTRO_FEATURES` feature. Distributions that previously set::
455 455
456 USE_LDCONFIG = "0" 456 USE_LDCONFIG = "0"
457 457
@@ -494,12 +494,12 @@ The following miscellaneous changes have occurred:
494 information. 494 information.
495 495
496- All native and nativesdk recipes now use a separate 496- All native and nativesdk recipes now use a separate
497 ``DISTRO_FEATURES`` value instead of sharing the value used by 497 :term:`DISTRO_FEATURES` value instead of sharing the value used by
498 recipes for the target, in order to avoid unnecessary rebuilds. 498 recipes for the target, in order to avoid unnecessary rebuilds.
499 499
500 The ``DISTRO_FEATURES`` for ``native`` recipes is 500 The :term:`DISTRO_FEATURES` for ``native`` recipes is
501 :term:`DISTRO_FEATURES_NATIVE` added to 501 :term:`DISTRO_FEATURES_NATIVE` added to
502 an intersection of ``DISTRO_FEATURES`` and 502 an intersection of :term:`DISTRO_FEATURES` and
503 :term:`DISTRO_FEATURES_FILTER_NATIVE`. 503 :term:`DISTRO_FEATURES_FILTER_NATIVE`.
504 504
505 For nativesdk recipes, the corresponding variables are 505 For nativesdk recipes, the corresponding variables are
diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst
index 44f31dc8a9..07f2bef623 100644
--- a/documentation/migration-guides/migration-2.4.rst
+++ b/documentation/migration-guides/migration-2.4.rst
@@ -63,7 +63,7 @@ occurred:
63 63
64 - The ``ionice`` program is now packaged in a separate 64 - The ``ionice`` program is now packaged in a separate
65 "util-linux-ionice" package. The main ``util-linux`` package has a 65 "util-linux-ionice" package. The main ``util-linux`` package has a
66 recommended runtime dependency (i.e. ``RRECOMMENDS``) on the 66 recommended runtime dependency (i.e. :term:`RRECOMMENDS`) on the
67 ``util-linux-ionice`` package. 67 ``util-linux-ionice`` package.
68 68
69- ``initscripts``: The ``sushell`` program is now packaged in a 69- ``initscripts``: The ``sushell`` program is now packaged in a
@@ -71,7 +71,7 @@ occurred:
71 systems to pull ``sushell`` in when ``selinux`` is enabled. The 71 systems to pull ``sushell`` in when ``selinux`` is enabled. The
72 change also eliminates needing to pull in the entire ``initscripts`` 72 change also eliminates needing to pull in the entire ``initscripts``
73 package. The main ``initscripts`` package has a runtime dependency 73 package. The main ``initscripts`` package has a runtime dependency
74 (i.e. ``RDEPENDS``) on the ``sushell`` package when "selinux" is in 74 (i.e. :term:`RDEPENDS`) on the ``sushell`` package when "selinux" is in
75 ``DISTRO_FEATURES``. 75 ``DISTRO_FEATURES``.
76 76
77- ``glib-2.0``: The ``glib-2.0`` package now has a recommended 77- ``glib-2.0``: The ``glib-2.0`` package now has a recommended
diff --git a/documentation/migration-guides/migration-2.5.rst b/documentation/migration-guides/migration-2.5.rst
index c7e0760463..d14580df21 100644
--- a/documentation/migration-guides/migration-2.5.rst
+++ b/documentation/migration-guides/migration-2.5.rst
@@ -281,7 +281,7 @@ The following are additional changes:
281 ``IMAGE_FSTYPES``. 281 ``IMAGE_FSTYPES``.
282 282
283- Recipes with an unconditional dependency on ``libpam`` are only 283- Recipes with an unconditional dependency on ``libpam`` are only
284 buildable with ``pam`` in ``DISTRO_FEATURES``. If the dependency is 284 buildable with ``pam`` in :term:`DISTRO_FEATURES`. If the dependency is
285 truly optional then it is recommended that the dependency be 285 truly optional then it is recommended that the dependency be
286 conditional upon ``pam`` being in ``DISTRO_FEATURES``. 286 conditional upon ``pam`` being in ``DISTRO_FEATURES``.
287 287
diff --git a/documentation/migration-guides/migration-2.6.rst b/documentation/migration-guides/migration-2.6.rst
index e27fad82c6..3216ed5ae3 100644
--- a/documentation/migration-guides/migration-2.6.rst
+++ b/documentation/migration-guides/migration-2.6.rst
@@ -156,11 +156,11 @@ Image/Kernel Artifact Naming Changes
156The following changes have been made: 156The following changes have been made:
157 157
158- Name variables (e.g. :term:`IMAGE_NAME`) use a new 158- Name variables (e.g. :term:`IMAGE_NAME`) use a new
159 ``IMAGE_VERSION_SUFFIX`` variable instead of 159 :term:`IMAGE_VERSION_SUFFIX` variable instead of
160 :term:`DATETIME`. Using ``IMAGE_VERSION_SUFFIX`` 160 :term:`DATETIME`. Using :term:`IMAGE_VERSION_SUFFIX`
161 allows easier and more direct changes. 161 allows easier and more direct changes.
162 162
163 The ``IMAGE_VERSION_SUFFIX`` variable is set in the ``bitbake.conf`` 163 The :term:`IMAGE_VERSION_SUFFIX` variable is set in the ``bitbake.conf``
164 configuration file as follows:: 164 configuration file as follows::
165 165
166 IMAGE_VERSION_SUFFIX = "-${DATETIME}" 166 IMAGE_VERSION_SUFFIX = "-${DATETIME}"
@@ -212,19 +212,19 @@ The following changes have been made:
212The :term:`SERIAL_CONSOLE` variable has been 212The :term:`SERIAL_CONSOLE` variable has been
213functionally replaced by the 213functionally replaced by the
214:term:`SERIAL_CONSOLES` variable for some time. 214:term:`SERIAL_CONSOLES` variable for some time.
215With the Yocto Project 2.6 release, ``SERIAL_CONSOLE`` has been 215With the Yocto Project 2.6 release, :term:`SERIAL_CONSOLE` has been
216officially deprecated. 216officially deprecated.
217 217
218``SERIAL_CONSOLE`` will continue to work as before for the 2.6 release. 218:term:`SERIAL_CONSOLE` will continue to work as before for the 2.6 release.
219However, for the sake of future compatibility, it is recommended that 219However, for the sake of future compatibility, it is recommended that
220you replace all instances of ``SERIAL_CONSOLE`` with 220you replace all instances of :term:`SERIAL_CONSOLE` with
221``SERIAL_CONSOLES``. 221:term:`SERIAL_CONSOLES`.
222 222
223.. note:: 223.. note::
224 224
225 The only difference in usage is that ``SERIAL_CONSOLES`` 225 The only difference in usage is that :term:`SERIAL_CONSOLES`
226 expects entries to be separated using semicolons as compared to 226 expects entries to be separated using semicolons as compared to
227 ``SERIAL_CONSOLE``, which expects spaces. 227 :term:`SERIAL_CONSOLE`, which expects spaces.
228 228
229.. _migration-2.6-poky-sets-unknown-configure-option-to-qa-error: 229.. _migration-2.6-poky-sets-unknown-configure-option-to-qa-error:
230 230
@@ -387,14 +387,14 @@ QEMU (i.e. "qemu-usermode" is in
387default). 387default).
388 388
389If you wish to disable Python profile-guided optimization regardless of 389If you wish to disable Python profile-guided optimization regardless of
390the value of ``MACHINE_FEATURES``, then ensure that 390the value of :term:`MACHINE_FEATURES`, then ensure that
391:term:`PACKAGECONFIG` for the ``python3`` recipe 391:term:`PACKAGECONFIG` for the ``python3`` recipe
392does not contain "pgo". You could accomplish the latter using the 392does not contain "pgo". You could accomplish the latter using the
393following at the configuration level:: 393following at the configuration level::
394 394
395 PACKAGECONFIG_remove_pn-python3 = "pgo" 395 PACKAGECONFIG_remove_pn-python3 = "pgo"
396 396
397Alternatively, you can set ``PACKAGECONFIG`` using an append file 397Alternatively, you can set :term:`PACKAGECONFIG` using an append file
398for the ``python3`` recipe. 398for the ``python3`` recipe.
399 399
400.. _migration-2.6-miscellaneous-changes: 400.. _migration-2.6-miscellaneous-changes:
diff --git a/documentation/migration-guides/migration-2.7.rst b/documentation/migration-guides/migration-2.7.rst
index 66cb84584f..25d92296cc 100644
--- a/documentation/migration-guides/migration-2.7.rst
+++ b/documentation/migration-guides/migration-2.7.rst
@@ -91,7 +91,7 @@ This section provides information about packaging changes.
91 package_name\ ``-src``). If you are currently using ``dbg-pkgs`` in 91 package_name\ ``-src``). If you are currently using ``dbg-pkgs`` in
92 :term:`IMAGE_FEATURES` to bring in debug 92 :term:`IMAGE_FEATURES` to bring in debug
93 symbols and you still need the sources, you must now also add 93 symbols and you still need the sources, you must now also add
94 ``src-pkgs`` to ``IMAGE_FEATURES``. Source packages remain in the 94 ``src-pkgs`` to :term:`IMAGE_FEATURES`. Source packages remain in the
95 target portion of the SDK by default, unless you have set your own 95 target portion of the SDK by default, unless you have set your own
96 value for :term:`SDKIMAGE_FEATURES` that 96 value for :term:`SDKIMAGE_FEATURES` that
97 does not include ``src-pkgs``. 97 does not include ``src-pkgs``.
diff --git a/documentation/migration-guides/migration-3.1.rst b/documentation/migration-guides/migration-3.1.rst
index d6a30dc274..80b8f6baa5 100644
--- a/documentation/migration-guides/migration-3.1.rst
+++ b/documentation/migration-guides/migration-3.1.rst
@@ -260,7 +260,7 @@ Miscellaneous changes
260--------------------- 260---------------------
261 261
262- The undocumented ``SRC_DISTRIBUTE_LICENSES`` variable has now been 262- The undocumented ``SRC_DISTRIBUTE_LICENSES`` variable has now been
263 removed in favour of a new ``AVAILABLE_LICENSES`` variable which is 263 removed in favour of a new :term:`AVAILABLE_LICENSES` variable which is
264 dynamically set based upon license files found in 264 dynamically set based upon license files found in
265 ``${COMMON_LICENSE_DIR}`` and ``${LICENSE_PATH}``. 265 ``${COMMON_LICENSE_DIR}`` and ``${LICENSE_PATH}``.
266 266
diff --git a/documentation/migration-guides/migration-3.2.rst b/documentation/migration-guides/migration-3.2.rst
index dd316a70ff..a940f23238 100644
--- a/documentation/migration-guides/migration-3.2.rst
+++ b/documentation/migration-guides/migration-3.2.rst
@@ -62,10 +62,10 @@ There is a possible complication where some existing recipe may break, for
62example, a recipe was found to be writing to ``${B}/install`` for 62example, a recipe was found to be writing to ``${B}/install`` for
63``make install`` in ``do_install`` and since ``${B}`` is listed as not to be tracked, 63``make install`` in ``do_install`` and since ``${B}`` is listed as not to be tracked,
64there were errors trying to ``chown root`` for files in this location. Another 64there were errors trying to ``chown root`` for files in this location. Another
65example was the ``tcl`` recipe where the source directory ``S`` is set to a 65example was the ``tcl`` recipe where the source directory :term:`S` is set to a
66subdirectory of the source tree but files were written out to the directory 66subdirectory of the source tree but files were written out to the directory
67structure above that subdirectory. For these types of cases in your own recipes, 67structure above that subdirectory. For these types of cases in your own recipes,
68extend ``PSEUDO_IGNORE_PATHS`` to cover additional paths that pseudo should not 68extend :term:`PSEUDO_IGNORE_PATHS` to cover additional paths that pseudo should not
69be monitoring. 69be monitoring.
70 70
71In addition, pseudo's behaviour on mismatches has now been changed - rather 71In addition, pseudo's behaviour on mismatches has now been changed - rather
@@ -207,7 +207,7 @@ files into a subdirectory and reference that instead.
207deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` 207deploy class now cleans ``DEPLOYDIR`` before ``do_deploy``
208---------------------------------------------------------- 208----------------------------------------------------------
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 ``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
212Most 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. 212Most 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.
213 213