summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2021-06-19 09:07:35 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-07-16 21:59:31 +0100
commit5a6fb291ad16ce4110e65adf2d29e8ccfe6fa25a (patch)
treedf43222dc7a0def1bbc6246ca2a33953f85e584f /documentation
parentbe3e14dd43220db034a63b7a9f5516feb6a00110 (diff)
downloadpoky-5a6fb291ad16ce4110e65adf2d29e8ccfe6fa25a.tar.gz
docs: replace remaining ``FOO`` by :term:`FOO`
A few occurences appeared between the time the original patch was sent and it was applied, this fixes it. Also, the original patch didn't take into account lowercase terms, this is now fixed, see module_autoload for example. Finally, as is often the case with regexp, there was a typo in it that didn't make it match as much as it should have. The script that is used to do the replacement of ``FOO`` by :term:`FOO` is the following Python code: import re from pathlib import Path from runpy import run_module import contextlib import io import sys re_term = re.compile(r'variables.html#term-([a-zA-Z_0-9]*)') terms = [] new_terms = set() with contextlib.redirect_stdout(io.StringIO()) as f: run_module('sphinx.ext.intersphinx', run_name='__main__') objects = f.getvalue() match = re_term.search(objects) while match: if match.group(1): terms.append(match.group(1)) match = re_term.search(objects, match.end()) for rst in Path('.').rglob('*.rst'): with open(rst, 'r') as f: content = "".join(f.readlines()) for term in terms: content = re.sub(r'``({})``(?!.*\s+[~=-]{{{:d},}})'.format(term, len(term)), r':term:`\1`', content) with open(rst, 'w') as f: f.write(content) This script takes one argument as input: an objects.inv. Bitbake's can be gotten from https://docs.yoctoproject.org/bitbake/objects.inv. The objetcs.inv from the current git repo can be gotten from documentation/_build/html/objetcs.inv after running `make html`. Note that this excludes from replacement terms that appear in section titles as it requires refs to be changed too. This can be automated too if need be but right now it looks a bit confusing to have an anchor link (for sections) also have a term/reference link in it. I am not sure this is desired today. This is the result of two runs of the aforementioned script, once with Bitbake objects.inv and once with this repo's. Fixes: ba49d9babfcb "docs: replace ``FOO`` by :term:`FOO` where possible" (From yocto-docs rev: 1e1b0c4dd241b6657035172b1f7b5f341afa8b25) Signed-off-by: Quentin Schulz <foss@0leil.net> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/bsp-guide/bsp.rst2
-rw-r--r--documentation/dev-manual/common-tasks.rst24
-rw-r--r--documentation/kernel-dev/common.rst8
-rw-r--r--documentation/migration-guides/migration-1.5.rst4
-rw-r--r--documentation/migration-guides/migration-1.7.rst2
-rw-r--r--documentation/migration-guides/migration-2.1.rst4
-rw-r--r--documentation/migration-guides/migration-2.2.rst4
-rw-r--r--documentation/migration-guides/migration-2.3.rst2
-rw-r--r--documentation/migration-guides/migration-2.4.rst6
-rw-r--r--documentation/migration-guides/migration-2.5.rst4
-rw-r--r--documentation/migration-guides/migration-2.6.rst2
-rw-r--r--documentation/migration-guides/migration-2.7.rst2
-rw-r--r--documentation/migration-guides/migration-3.0.rst2
-rw-r--r--documentation/overview-manual/concepts.rst6
-rw-r--r--documentation/ref-manual/classes.rst10
-rw-r--r--documentation/ref-manual/faq.rst2
-rw-r--r--documentation/ref-manual/kickstart.rst2
-rw-r--r--documentation/ref-manual/qa-checks.rst2
-rw-r--r--documentation/ref-manual/variables.rst60
19 files changed, 74 insertions, 74 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 5c43f53d0c..5f62376d69 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -1365,7 +1365,7 @@ Project Reference Manual.
1365- :term:`IMAGE_INSTALL`: 1365- :term:`IMAGE_INSTALL`:
1366 Specifies packages to install into an image through the 1366 Specifies packages to install into an image through the
1367 :ref:`image <ref-classes-image>` class. Recipes 1367 :ref:`image <ref-classes-image>` class. Recipes
1368 use the ``IMAGE_INSTALL`` variable. 1368 use the :term:`IMAGE_INSTALL` variable.
1369 1369
1370- ``do_image_wic[depends]``: A task that is constructed during the 1370- ``do_image_wic[depends]``: A task that is constructed during the
1371 build. In this example, the task depends on specific tools in order 1371 build. In this example, the task depends on specific tools in order
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 4eab12d838..2af2896171 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -268,7 +268,7 @@ following list:
268 quickly. 268 quickly.
269 269
270 In summary, you need to place all files referenced from 270 In summary, you need to place all files referenced from
271 ``SRC_URI`` in a machine-specific subdirectory within the layer in 271 :term:`SRC_URI` in a machine-specific subdirectory within the layer in
272 order to restrict those files to machine-specific builds. 272 order to restrict those files to machine-specific builds.
273 273
274- *Perform Steps to Apply for Yocto Project Compatibility:* If you want 274- *Perform Steps to Apply for Yocto Project Compatibility:* If you want
@@ -1305,7 +1305,7 @@ scanning directory locations for local files in :term:`SRC_URI`.
1305 1305
1306The :term:`SRC_URI` variable in your recipe must define each unique location 1306The :term:`SRC_URI` variable in your recipe must define each unique location
1307for your source files. It is good practice to not hard-code version 1307for your source files. It is good practice to not hard-code version
1308numbers in a URL used in ``SRC_URI``. Rather than hard-code these 1308numbers in a URL used in :term:`SRC_URI`. Rather than hard-code these
1309values, use ``${``\ :term:`PV`\ ``}``, 1309values, use ``${``\ :term:`PV`\ ``}``,
1310which causes the fetch process to use the version specified in the 1310which causes the fetch process to use the version specified in the
1311recipe filename. Specifying the version in this manner means that 1311recipe filename. Specifying the version in this manner means that
@@ -2743,7 +2743,7 @@ recognizes the machine as "crownbay".
2743The most important variables you must set in your machine configuration 2743The most important variables you must set in your machine configuration
2744file or include from a lower-level configuration file are as follows: 2744file or include from a lower-level configuration file are as follows:
2745 2745
2746- ``TARGET_ARCH`` (e.g. "arm") 2746- :term:`TARGET_ARCH` (e.g. "arm")
2747 2747
2748- ``PREFERRED_PROVIDER_virtual/kernel`` 2748- ``PREFERRED_PROVIDER_virtual/kernel``
2749 2749
@@ -2751,9 +2751,9 @@ file or include from a lower-level configuration file are as follows:
2751 2751
2752You might also need these variables: 2752You might also need these variables:
2753 2753
2754- ``SERIAL_CONSOLES`` (e.g. "115200;ttyS0 115200;ttyS1") 2754- :term:`SERIAL_CONSOLES` (e.g. "115200;ttyS0 115200;ttyS1")
2755 2755
2756- ``KERNEL_IMAGETYPE`` (e.g. "zImage") 2756- :term:`KERNEL_IMAGETYPE` (e.g. "zImage")
2757 2757
2758- :term:`IMAGE_FSTYPES` (e.g. "tar.gz jffs2") 2758- :term:`IMAGE_FSTYPES` (e.g. "tar.gz jffs2")
2759 2759
@@ -3277,7 +3277,7 @@ The actual directory depends on several things:
3277 3277
3278- :term:`EXTENDPE`: The epoch - (if 3278- :term:`EXTENDPE`: The epoch - (if
3279 :term:`PE` is not specified, which is 3279 :term:`PE` is not specified, which is
3280 usually the case for most recipes, then ``EXTENDPE`` is blank). 3280 usually the case for most recipes, then :term:`EXTENDPE` is blank).
3281 3281
3282- :term:`PV`: The recipe version. 3282- :term:`PV`: The recipe version.
3283 3283
@@ -4167,7 +4167,7 @@ your tunings to best consider build times and package feed maintenance.
4167 If :term:`DISTRO` settings change or fundamental configuration settings 4167 If :term:`DISTRO` settings change or fundamental configuration settings
4168 such as the filesystem layout, you need to work with a clean :term:`TMPDIR`. 4168 such as the filesystem layout, you need to work with a clean :term:`TMPDIR`.
4169 Sharing :term:`TMPDIR` under these circumstances might work but since it is 4169 Sharing :term:`TMPDIR` under these circumstances might work but since it is
4170 not guaranteed, you should use a clean ``TMPDIR``. 4170 not guaranteed, you should use a clean :term:`TMPDIR`.
4171 4171
4172- *Enable the Appropriate Package Architecture:* By default, the 4172- *Enable the Appropriate Package Architecture:* By default, the
4173 OpenEmbedded build system enables three levels of package 4173 OpenEmbedded build system enables three levels of package
@@ -4392,7 +4392,7 @@ directory:
4392 INHERIT += "own-mirrors" 4392 INHERIT += "own-mirrors"
4393 BB_NO_NETWORK = "1" 4393 BB_NO_NETWORK = "1"
4394 4394
4395 The ``SOURCE_MIRROR_URL`` and ``own-mirror`` 4395 The :term:`SOURCE_MIRROR_URL` and ``own-mirror``
4396 class set up the system to use the downloads directory as your "own 4396 class set up the system to use the downloads directory as your "own
4397 mirror". Using the :term:`BB_NO_NETWORK` variable makes sure that 4397 mirror". Using the :term:`BB_NO_NETWORK` variable makes sure that
4398 BitBake's fetching process in step 3 stays local, which means files 4398 BitBake's fetching process in step 3 stays local, which means files
@@ -4676,7 +4676,7 @@ needed.
4676 4676
4677For the most part, the Multilib class extension works automatically to 4677For the most part, the Multilib class extension works automatically to
4678extend the package name from ``${PN}`` to ``${MLPREFIX}${PN}``, where 4678extend the package name from ``${PN}`` to ``${MLPREFIX}${PN}``, where
4679``MLPREFIX`` is the particular multilib (e.g. "lib32-" or "lib64-"). 4679:term:`MLPREFIX` is the particular multilib (e.g. "lib32-" or "lib64-").
4680Standard variables such as 4680Standard variables such as
4681:term:`DEPENDS`, 4681:term:`DEPENDS`,
4682:term:`RDEPENDS`, 4682:term:`RDEPENDS`,
@@ -6258,7 +6258,7 @@ the following:
6258 software being packaged. Do not confuse :term:`PV` with the binary 6258 software being packaged. Do not confuse :term:`PV` with the binary
6259 package version. 6259 package version.
6260 6260
6261- ``PR``: The recipe revision. 6261- :term:`PR`: The recipe revision.
6262 6262
6263- :term:`SRCPV`: The OpenEmbedded 6263- :term:`SRCPV`: The OpenEmbedded
6264 build system uses this string to help define the value of :term:`PV` when 6264 build system uses this string to help define the value of :term:`PV` when
@@ -7946,8 +7946,8 @@ output from this command::
7946 Here are some notes on using the ``buildhistory-collect-srcrevs`` command: 7946 Here are some notes on using the ``buildhistory-collect-srcrevs`` command:
7947 7947
7948 - By default, only values where the :term:`SRCREV` was not hardcoded 7948 - By default, only values where the :term:`SRCREV` was not hardcoded
7949 (usually when ``AUTOREV`` is used) are reported. Use the ``-a`` 7949 (usually when :term:`AUTOREV` is used) are reported. Use the ``-a``
7950 option to see all ``SRCREV`` values. 7950 option to see all :term:`SRCREV` values.
7951 7951
7952 - The output statements might not have any effect if overrides are 7952 - The output statements might not have any effect if overrides are
7953 applied elsewhere in the build system configuration. Use the 7953 applied elsewhere in the build system configuration. Use the
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index de62df5b1f..a97140b0b9 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -81,7 +81,7 @@ section:
81 variable to include kernel modules. 81 variable to include kernel modules.
82 82
83 In this example we wish to build for qemux86 so we must set the 83 In this example we wish to build for qemux86 so we must set the
84 ``MACHINE`` variable to "qemux86" and also add the "kernel-modules". 84 :term:`MACHINE` variable to "qemux86" and also add the "kernel-modules".
85 As described we do this by appending to ``conf/local.conf``:: 85 As described we do this by appending to ``conf/local.conf``::
86 86
87 MACHINE = "qemux86" 87 MACHINE = "qemux86"
@@ -259,7 +259,7 @@ section:
259 variable to include kernel modules. 259 variable to include kernel modules.
260 260
261 In this example we wish to build for qemux86 so we must set the 261 In this example we wish to build for qemux86 so we must set the
262 ``MACHINE`` variable to "qemux86" and also add the "kernel-modules". 262 :term:`MACHINE` variable to "qemux86" and also add the "kernel-modules".
263 As described we do this by appending to ``conf/local.conf``:: 263 As described we do this by appending to ``conf/local.conf``::
264 264
265 MACHINE = "qemux86" 265 MACHINE = "qemux86"
@@ -588,7 +588,7 @@ recipe is processed.
588 added to the Yocto Project. 588 added to the Yocto Project.
589 589
590 In general, however, the Yocto Project maintainers take care of 590 In general, however, the Yocto Project maintainers take care of
591 moving the ``SRC_URI``-specified configuration options to the 591 moving the :term:`SRC_URI`-specified configuration options to the
592 kernel's ``meta`` branch. Not only is it easier for BSP developers 592 kernel's ``meta`` branch. Not only is it easier for BSP developers
593 not to have to put those configurations in the branch, 593 not to have to put those configurations in the branch,
594 but having the maintainers do it allows them to apply 'global' 594 but having the maintainers do it allows them to apply 'global'
@@ -730,7 +730,7 @@ a Raspberry Pi 2, which is based on the Broadcom 2708/2709 chipset::
730 730
731Aside from modifying your kernel recipe and providing your own 731Aside from modifying your kernel recipe and providing your own
732``defconfig`` file, you need to be sure no files or statements set 732``defconfig`` file, you need to be sure no files or statements set
733``SRC_URI`` to use a ``defconfig`` other than your "in-tree" file (e.g. 733:term:`SRC_URI` to use a ``defconfig`` other than your "in-tree" file (e.g.
734a kernel's ``linux-``\ `machine`\ ``.inc`` file). In other words, if the 734a kernel's ``linux-``\ `machine`\ ``.inc`` file). In other words, if the
735build system detects a statement that identifies an "out-of-tree" 735build system detects a statement that identifies an "out-of-tree"
736``defconfig`` file, that statement will override your 736``defconfig`` file, that statement will override your
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst
index e956d9fffa..e1ba4a9a13 100644
--- a/documentation/migration-guides/migration-1.5.rst
+++ b/documentation/migration-guides/migration-1.5.rst
@@ -124,7 +124,7 @@ The following directory changes exist:
124 need to refer to this directory. The ``runqemu`` script now uses this 124 need to refer to this directory. The ``runqemu`` script now uses this
125 variable to find images and kernel binaries and will use BitBake to 125 variable to find images and kernel binaries and will use BitBake to
126 determine the directory. Alternatively, you can set the 126 determine the directory. Alternatively, you can set the
127 ``DEPLOY_DIR_IMAGE`` variable in the external environment. 127 :term:`DEPLOY_DIR_IMAGE` variable in the external environment.
128 128
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
@@ -333,7 +333,7 @@ Following is a list of short entries describing other changes:
333 :term:`BAD_RECOMMENDATIONS` supports 333 :term:`BAD_RECOMMENDATIONS` supports
334 pre-renamed package names. 334 pre-renamed package names.
335 335
336- ``classes/rootfs_rpm``: Implement ``BAD_RECOMMENDATIONS`` for RPM. 336- ``classes/rootfs_rpm``: Implement :term:`BAD_RECOMMENDATIONS` for RPM.
337 337
338- ``systemd``: Remove ``systemd_unitdir`` if ``systemd`` is not in 338- ``systemd``: Remove ``systemd_unitdir`` if ``systemd`` is not in
339 :term:`DISTRO_FEATURES`. 339 :term:`DISTRO_FEATURES`.
diff --git a/documentation/migration-guides/migration-1.7.rst b/documentation/migration-guides/migration-1.7.rst
index c3a50eec88..8c642da202 100644
--- a/documentation/migration-guides/migration-1.7.rst
+++ b/documentation/migration-guides/migration-1.7.rst
@@ -13,7 +13,7 @@ The QEMU recipe now uses a number of
13:term:`PACKAGECONFIG` options to enable various 13:term:`PACKAGECONFIG` options to enable various
14optional features. The method used to set defaults for these options 14optional features. The method used to set defaults for these options
15means that existing ``local.conf`` files will need to be modified to 15means that existing ``local.conf`` files will need to be modified to
16append to ``PACKAGECONFIG`` for ``qemu-native`` and ``nativesdk-qemu`` 16append to :term:`PACKAGECONFIG` for ``qemu-native`` and ``nativesdk-qemu``
17instead of setting it. In other words, to enable graphical output for 17instead of setting it. In other words, to enable graphical output for
18QEMU, you should now have these lines in ``local.conf``:: 18QEMU, you should now have these lines in ``local.conf``::
19 19
diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst
index 6c5ed965dc..3135d69caa 100644
--- a/documentation/migration-guides/migration-2.1.rst
+++ b/documentation/migration-guides/migration-2.1.rst
@@ -62,12 +62,12 @@ Makefile Environment Changes
62---------------------------- 62----------------------------
63 63
64:term:`EXTRA_OEMAKE` now defaults to "" instead of 64:term:`EXTRA_OEMAKE` now defaults to "" instead of
65"-e MAKEFLAGS=". Setting ``EXTRA_OEMAKE`` to "-e MAKEFLAGS=" by default 65"-e MAKEFLAGS=". Setting :term:`EXTRA_OEMAKE` to "-e MAKEFLAGS=" by default
66was a historical accident that has required many classes (e.g. 66was a historical accident that has required many classes (e.g.
67``autotools``, ``module``) and recipes to override this default in order 67``autotools``, ``module``) and recipes to override this default in order
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:term:`EXTRA_OEMAKE` back to "-e MAKEFLAGS=" or by explicitly setting any
71required variable value overrides using :term:`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 "="
diff --git a/documentation/migration-guides/migration-2.2.rst b/documentation/migration-guides/migration-2.2.rst
index d6dacdf34a..cbdc6a739e 100644
--- a/documentation/migration-guides/migration-2.2.rst
+++ b/documentation/migration-guides/migration-2.2.rst
@@ -271,7 +271,7 @@ update the references to ensure they continue to work.
271The :term:`IMGDEPLOYDIR` variable was introduced to allow sstate caching of 271The :term:`IMGDEPLOYDIR` variable was introduced to allow sstate caching of
272image creation results. Image recipes defining custom :term:`IMAGE_CMD` or 272image creation results. Image recipes defining custom :term:`IMAGE_CMD` or
273doing postprocessing on the generated images need to be adapted to use 273doing postprocessing on the generated images need to be adapted to use
274``IMGDEPLOYDIR`` instead of :term:`DEPLOY_DIR_IMAGE`. ``IMAGE_MANIFEST`` 274:term:`IMGDEPLOYDIR` instead of :term:`DEPLOY_DIR_IMAGE`. :term:`IMAGE_MANIFEST`
275creation and symlinking of the most recent image file will fail otherwise. 275creation and symlinking of the most recent image file will fail otherwise.
276 276
277.. _migration-2.2-bitbake-changes: 277.. _migration-2.2-bitbake-changes:
@@ -292,7 +292,7 @@ The following changes took place for BitBake:
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 :term:`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 :term:`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
298 cache needed to be changed to support the new multi-configuration 298 cache needed to be changed to support the new multi-configuration
diff --git a/documentation/migration-guides/migration-2.3.rst b/documentation/migration-guides/migration-2.3.rst
index 886d579f9b..b79bc541c5 100644
--- a/documentation/migration-guides/migration-2.3.rst
+++ b/documentation/migration-guides/migration-2.3.rst
@@ -36,7 +36,7 @@ Consider the following:
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 :term:`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 :term:`DISTRO_FEATURES`.
40 40
41- Examine Recipes that Use ``SSTATEPOSTINSTFUNCS``: You need to 41- Examine Recipes that Use ``SSTATEPOSTINSTFUNCS``: You need to
42 examine any recipe that uses ``SSTATEPOSTINSTFUNCS`` and determine 42 examine any recipe that uses ``SSTATEPOSTINSTFUNCS`` and determine
diff --git a/documentation/migration-guides/migration-2.4.rst b/documentation/migration-guides/migration-2.4.rst
index 07f2bef623..cab81356d8 100644
--- a/documentation/migration-guides/migration-2.4.rst
+++ b/documentation/migration-guides/migration-2.4.rst
@@ -51,7 +51,7 @@ occurred:
51 ``su`` is normally provided through the shadow file format. The 51 ``su`` is normally provided through the shadow file format. The
52 main ``util-linux`` package has runtime dependencies (i.e. 52 main ``util-linux`` package has runtime dependencies (i.e.
53 :term:`RDEPENDS`) on the ``util-linux-su`` package 53 :term:`RDEPENDS`) on the ``util-linux-su`` package
54 when "pam" is in ``DISTRO_FEATURES``. 54 when "pam" is in :term:`DISTRO_FEATURES`.
55 55
56 - The ``switch_root`` program is now packaged in a separate 56 - The ``switch_root`` program is now packaged in a separate
57 "util-linux-switch-root" package for small initramfs images that 57 "util-linux-switch-root" package for small initramfs images that
@@ -72,10 +72,10 @@ occurred:
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. :term:`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 :term:`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
78 runtime dependency (i.e. ``RRECOMMENDS``) on the ``shared-mime-info`` 78 runtime dependency (i.e. :term:`RRECOMMENDS`) on the ``shared-mime-info``
79 package, since large portions of GIO are not useful without the MIME 79 package, since large portions of GIO are not useful without the MIME
80 database. You can remove the dependency by using the 80 database. You can remove the dependency by using the
81 :term:`BAD_RECOMMENDATIONS` variable if 81 :term:`BAD_RECOMMENDATIONS` variable if
diff --git a/documentation/migration-guides/migration-2.5.rst b/documentation/migration-guides/migration-2.5.rst
index d14580df21..79f804fa1d 100644
--- a/documentation/migration-guides/migration-2.5.rst
+++ b/documentation/migration-guides/migration-2.5.rst
@@ -278,12 +278,12 @@ The following are additional changes:
278 performance and compression. In order to build a live image with 278 performance and compression. In order to build a live image with
279 squashfs+lz4 compression enabled you should now set 279 squashfs+lz4 compression enabled you should now set
280 ``LIVE_ROOTFS_TYPE = "squashfs-lz4"`` and ensure that ``live`` is in 280 ``LIVE_ROOTFS_TYPE = "squashfs-lz4"`` and ensure that ``live`` is in
281 ``IMAGE_FSTYPES``. 281 :term:`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 :term:`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 :term:`DISTRO_FEATURES`.
287 287
288- For EFI-based machines, the bootloader (``grub-efi`` by default) is 288- For EFI-based machines, the bootloader (``grub-efi`` by default) is
289 installed into the image at /boot. Wic can be used to split the 289 installed into the image at /boot. Wic can be used to split the
diff --git a/documentation/migration-guides/migration-2.6.rst b/documentation/migration-guides/migration-2.6.rst
index 3216ed5ae3..a8c56ede72 100644
--- a/documentation/migration-guides/migration-2.6.rst
+++ b/documentation/migration-guides/migration-2.6.rst
@@ -430,7 +430,7 @@ The following miscellaneous changes occurred:
430 .. note:: 430 .. note::
431 431
432 ``genericx86`` and ``genericx86-64`` retain ``kernel-modules`` as part of 432 ``genericx86`` and ``genericx86-64`` retain ``kernel-modules`` as part of
433 the ``RRECOMMENDS`` variable setting. 433 the :term:`RRECOMMENDS` variable setting.
434 434
435- The ``LGPLv2_WHITELIST_GPL-3.0`` variable has been removed. If you 435- The ``LGPLv2_WHITELIST_GPL-3.0`` variable has been removed. If you
436 are setting this variable in your configuration, set or append it to 436 are setting this variable in your configuration, set or append it to
diff --git a/documentation/migration-guides/migration-2.7.rst b/documentation/migration-guides/migration-2.7.rst
index 25d92296cc..69bd390603 100644
--- a/documentation/migration-guides/migration-2.7.rst
+++ b/documentation/migration-guides/migration-2.7.rst
@@ -72,7 +72,7 @@ License Value Corrections
72The following corrections have been made to the 72The following corrections have been made to the
73:term:`LICENSE` values set by recipes: 73:term:`LICENSE` values set by recipes:
74 74
75- *socat*: Corrected ``LICENSE`` to be "GPLv2" rather than "GPLv2+". 75- *socat*: Corrected :term:`LICENSE` to be "GPLv2" rather than "GPLv2+".
76- *libgfortran*: Set license to "GPL-3.0-with-GCC-exception". 76- *libgfortran*: Set license to "GPL-3.0-with-GCC-exception".
77- *elfutils*: Removed "Elfutils-Exception" and set to "GPLv2" for shared libraries 77- *elfutils*: Removed "Elfutils-Exception" and set to "GPLv2" for shared libraries
78 78
diff --git a/documentation/migration-guides/migration-3.0.rst b/documentation/migration-guides/migration-3.0.rst
index 163c6201c5..20c7026e8d 100644
--- a/documentation/migration-guides/migration-3.0.rst
+++ b/documentation/migration-guides/migration-3.0.rst
@@ -243,7 +243,7 @@ The following sanity check changes occurred.
243- Setting ``DEPENDS_${PN}`` anywhere (i.e. typically in a recipe) now 243- Setting ``DEPENDS_${PN}`` anywhere (i.e. typically in a recipe) now
244 triggers an error. The error is triggered because 244 triggers an error. The error is triggered because
245 :term:`DEPENDS` is not a package-specific variable 245 :term:`DEPENDS` is not a package-specific variable
246 unlike RDEPENDS. You should set ``DEPENDS`` instead. 246 unlike RDEPENDS. You should set :term:`DEPENDS` instead.
247 247
248- systemd currently does not work well with the musl C library because 248- systemd currently does not work well with the musl C library because
249 only upstream officially supports linking the library with glibc. 249 only upstream officially supports linking the library with glibc.
diff --git a/documentation/overview-manual/concepts.rst b/documentation/overview-manual/concepts.rst
index 642ef15fe5..1e5f0f9039 100644
--- a/documentation/overview-manual/concepts.rst
+++ b/documentation/overview-manual/concepts.rst
@@ -774,7 +774,7 @@ Build Directory's hierarchy:
774 774
775 - :term:`BPN`: The name of the recipe 775 - :term:`BPN`: The name of the recipe
776 used to build the package. The :term:`BPN` variable is a version of 776 used to build the package. The :term:`BPN` variable is a version of
777 the ``PN`` variable but with common prefixes and suffixes removed. 777 the :term:`PN` variable but with common prefixes and suffixes removed.
778 778
779 - :term:`PV`: The version of the 779 - :term:`PV`: The version of the
780 recipe used to build the package. 780 recipe used to build the package.
@@ -1918,7 +1918,7 @@ shared state files. Here is an example::
1918 1918
1919.. note:: 1919.. note::
1920 1920
1921 The shared state directory (``SSTATE_DIR``) is organized into two-character 1921 The shared state directory (:term:`SSTATE_DIR`) is organized into two-character
1922 subdirectories, where the subdirectory names are based on the first two 1922 subdirectories, where the subdirectory names are based on the first two
1923 characters of the hash. 1923 characters of the hash.
1924 If the shared state directory structure for a mirror has the same structure 1924 If the shared state directory structure for a mirror has the same structure
@@ -2028,7 +2028,7 @@ dependencies, you must manually declare the dependencies.
2028 2028
2029 .. note:: 2029 .. note::
2030 2030
2031 By default, ``foo-dev`` also has an ``RDEPENDS``-style dependency on 2031 By default, ``foo-dev`` also has an :term:`RDEPENDS`-style dependency on
2032 ``foo``, because the default value of ``RDEPENDS_${PN}-dev`` (set in 2032 ``foo``, because the default value of ``RDEPENDS_${PN}-dev`` (set in
2033 bitbake.conf) includes "${PN}". 2033 bitbake.conf) includes "${PN}".
2034 2034
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 9b93807b6d..49905f2725 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -116,7 +116,7 @@ It's useful to have some idea of how the tasks defined by the
116 116
117- :ref:`ref-tasks-compile` - Runs ``make`` with 117- :ref:`ref-tasks-compile` - Runs ``make`` with
118 arguments that specify the compiler and linker. You can pass 118 arguments that specify the compiler and linker. You can pass
119 additional arguments through the ``EXTRA_OEMAKE`` variable. 119 additional arguments through the :term:`EXTRA_OEMAKE` variable.
120 120
121- :ref:`ref-tasks-install` - Runs ``make install`` and 121- :ref:`ref-tasks-install` - Runs ``make install`` and
122 passes in ``${``\ :term:`D`\ ``}`` as ``DESTDIR``. 122 passes in ``${``\ :term:`D`\ ``}`` as ``DESTDIR``.
@@ -981,7 +981,7 @@ are meant to detect real or potential problems in the packaged
981output. So exercise caution when disabling these checks. 981output. So exercise caution when disabling these checks.
982 982
983Here are the tests you can list with the :term:`WARN_QA` and 983Here are the tests you can list with the :term:`WARN_QA` and
984``ERROR_QA`` variables: 984:term:`ERROR_QA` variables:
985 985
986- ``already-stripped:`` Checks that produced binaries have not 986- ``already-stripped:`` Checks that produced binaries have not
987 already been stripped prior to the build system extracting debug 987 already been stripped prior to the build system extracting debug
@@ -1016,7 +1016,7 @@ Here are the tests you can list with the :term:`WARN_QA` and
1016 adds a dependency on the ``initscripts-functions`` package to 1016 adds a dependency on the ``initscripts-functions`` package to
1017 packages that install an initscript that refers to 1017 packages that install an initscript that refers to
1018 ``/etc/init.d/functions``. The recipe should really have an explicit 1018 ``/etc/init.d/functions``. The recipe should really have an explicit
1019 ``RDEPENDS`` for the package in question on ``initscripts-functions`` 1019 :term:`RDEPENDS` for the package in question on ``initscripts-functions``
1020 so that the OpenEmbedded build system is able to ensure that the 1020 so that the OpenEmbedded build system is able to ensure that the
1021 ``initscripts`` recipe is actually built and thus the 1021 ``initscripts`` recipe is actually built and thus the
1022 ``initscripts-functions`` package is made available. 1022 ``initscripts-functions`` package is made available.
@@ -1186,7 +1186,7 @@ Here are the tests you can list with the :term:`WARN_QA` and
1186 turn into ``FILES = "xyz"``. 1186 turn into ``FILES = "xyz"``.
1187 1187
1188- ``rpaths:`` Checks for rpaths in the binaries that contain build 1188- ``rpaths:`` Checks for rpaths in the binaries that contain build
1189 system paths such as ``TMPDIR``. If this test fails, bad ``-rpath`` 1189 system paths such as :term:`TMPDIR`. If this test fails, bad ``-rpath``
1190 options are being passed to the linker commands and your binaries 1190 options are being passed to the linker commands and your binaries
1191 have potential security issues. 1191 have potential security issues.
1192 1192
@@ -1259,7 +1259,7 @@ themselves.
1259 1259
1260The ``kernel`` class handles building Linux kernels. The class contains 1260The ``kernel`` class handles building Linux kernels. The class contains
1261code to build all kernel trees. All needed headers are staged into the 1261code to build all kernel trees. All needed headers are staged into the
1262``STAGING_KERNEL_DIR`` directory to allow out-of-tree module builds 1262:term:`STAGING_KERNEL_DIR` directory to allow out-of-tree module builds
1263using the :ref:`module <ref-classes-module>` class. 1263using the :ref:`module <ref-classes-module>` class.
1264 1264
1265This means that each built kernel module is packaged separately and 1265This means that each built kernel module is packaged separately and
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index 640ef77d03..c7322e7623 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -292,7 +292,7 @@ download directory. If that location fails, Poky tries
292:term:`MIRRORS` in that order. 292:term:`MIRRORS` in that order.
293 293
294Assuming your distribution is "poky", the OpenEmbedded build system uses 294Assuming your distribution is "poky", the OpenEmbedded build system uses
295the Yocto Project source ``PREMIRRORS`` by default for SCM-based 295the Yocto Project source :term:`PREMIRRORS` by default for SCM-based
296sources, upstreams for normal tarballs, and then falls back to a number 296sources, upstreams for normal tarballs, and then falls back to a number
297of other mirrors including the Yocto Project source mirror if those 297of other mirrors including the Yocto Project source mirror if those
298fail. 298fail.
diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst
index a7443f9ea3..fc723ccbe2 100644
--- a/documentation/ref-manual/kickstart.rst
+++ b/documentation/ref-manual/kickstart.rst
@@ -208,7 +208,7 @@ supports the following options:
208 bootloader times out and boots the default option. 208 bootloader times out and boots the default option.
209 209
210- ``--append``: Specifies kernel parameters. These parameters will be 210- ``--append``: Specifies kernel parameters. These parameters will be
211 added to the syslinux ``APPEND`` or ``grub`` kernel command line. 211 added to the syslinux :term:`APPEND` or ``grub`` kernel command line.
212 212
213- ``--configfile``: Specifies a user-defined configuration file for 213- ``--configfile``: Specifies a user-defined configuration file for
214 the bootloader. You can provide a full pathname for the file or a 214 the bootloader. You can provide a full pathname for the file or a
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index a105acc2c8..0ef203c70f 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -604,7 +604,7 @@ Errors and Warnings
604 so using ${:term:`BPN`} rather than ${:term:`PN`} as the latter will change 604 so using ${:term:`BPN`} rather than ${:term:`PN`} as the latter will change
605 for different variants of the same recipe e.g. when :term:`BBCLASSEXTEND` 605 for different variants of the same recipe e.g. when :term:`BBCLASSEXTEND`
606 or multilib are being used. This check will fail if a reference to ``${PN}`` 606 or multilib are being used. This check will fail if a reference to ``${PN}``
607 is found within the ``SRC_URI`` value - change it to ``${BPN}`` instead. 607 is found within the :term:`SRC_URI` value - change it to ``${BPN}`` instead.
608 608
609 609
610.. _qa-check-unhandled-features-check: 610.. _qa-check-unhandled-features-check:
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 00d45a79f0..354721d1a8 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -280,7 +280,7 @@ system and gives an overview of their function and contents.
280 S = "${WORKDIR}/${BP}" 280 S = "${WORKDIR}/${BP}"
281 281
282 You can separate the (:term:`S`) directory and the directory pointed to 282 You can separate the (:term:`S`) directory and the directory pointed to
283 by the ``B`` variable. Most Autotools-based recipes support 283 by the :term:`B` variable. Most Autotools-based recipes support
284 separating these directories. The build system defaults to using 284 separating these directories. The build system defaults to using
285 separate directories for ``gcc`` and some kernel recipes. 285 separate directories for ``gcc`` and some kernel recipes.
286 286
@@ -553,7 +553,7 @@ system and gives an overview of their function and contents.
553 BB_SERVER_TIMEOUT = "20" 553 BB_SERVER_TIMEOUT = "20"
554 554
555 If you want the server to never be unloaded, 555 If you want the server to never be unloaded,
556 set ``BB_SERVER_TIMEOUT`` to "-1". 556 set :term:`BB_SERVER_TIMEOUT` to "-1".
557 557
558 :term:`BBCLASSEXTEND` 558 :term:`BBCLASSEXTEND`
559 Allows you to extend a recipe so that it builds variants of the 559 Allows you to extend a recipe so that it builds variants of the
@@ -577,7 +577,7 @@ system and gives an overview of their function and contents.
577 variants by rewriting variable values and applying overrides such 577 variants by rewriting variable values and applying overrides such
578 as ``_class-native``. For example, to generate a native version of 578 as ``_class-native``. For example, to generate a native version of
579 a recipe, a :term:`DEPENDS` on "foo" is rewritten 579 a recipe, a :term:`DEPENDS` on "foo" is rewritten
580 to a ``DEPENDS`` on "foo-native". 580 to a :term:`DEPENDS` on "foo-native".
581 581
582 Even when using :term:`BBCLASSEXTEND`, the recipe is only parsed once. 582 Even when using :term:`BBCLASSEXTEND`, the recipe is only parsed once.
583 Parsing once adds some limitations. For example, it is not 583 Parsing once adds some limitations. For example, it is not
@@ -892,13 +892,13 @@ system and gives an overview of their function and contents.
892 the :term:`BUILD_CFLAGS` and 892 the :term:`BUILD_CFLAGS` and
893 :term:`BUILDSDK_CFLAGS` default values. 893 :term:`BUILDSDK_CFLAGS` default values.
894 894
895 The default value of the ``BUILD_OPTIMIZATION`` variable is "-O2 895 The default value of the :term:`BUILD_OPTIMIZATION` variable is "-O2
896 -pipe". 896 -pipe".
897 897
898 :term:`BUILD_OS` 898 :term:`BUILD_OS`
899 Specifies the operating system in use on the build host (e.g. 899 Specifies the operating system in use on the build host (e.g.
900 "linux"). The OpenEmbedded build system sets the value of 900 "linux"). The OpenEmbedded build system sets the value of
901 ``BUILD_OS`` from the OS reported by the ``uname`` command - the 901 :term:`BUILD_OS` from the OS reported by the ``uname`` command - the
902 first word, converted to lower-case characters. 902 first word, converted to lower-case characters.
903 903
904 :term:`BUILD_PREFIX` 904 :term:`BUILD_PREFIX`
@@ -1114,7 +1114,7 @@ system and gives an overview of their function and contents.
1114 1114
1115 .. note:: 1115 .. note::
1116 1116
1117 ``CLASSOVERRIDE`` gets its default "class-target" value from the 1117 :term:`CLASSOVERRIDE` gets its default "class-target" value from the
1118 ``bitbake.conf`` file. 1118 ``bitbake.conf`` file.
1119 1119
1120 As an example, the following override allows you to install extra 1120 As an example, the following override allows you to install extra
@@ -1205,7 +1205,7 @@ system and gives an overview of their function and contents.
1205 1205
1206 :term:`COMPONENTS_DIR` 1206 :term:`COMPONENTS_DIR`
1207 Stores sysroot components for each recipe. The OpenEmbedded build 1207 Stores sysroot components for each recipe. The OpenEmbedded build
1208 system uses ``COMPONENTS_DIR`` when constructing recipe-specific 1208 system uses :term:`COMPONENTS_DIR` when constructing recipe-specific
1209 sysroots for other recipes. 1209 sysroots for other recipes.
1210 1210
1211 The default is 1211 The default is
@@ -1611,7 +1611,7 @@ system and gives an overview of their function and contents.
1611 ":ref:`overview-manual/concepts:automatically added runtime dependencies`" 1611 ":ref:`overview-manual/concepts:automatically added runtime dependencies`"
1612 section in the Yocto Project Overview and Concepts Manual, 1612 section in the Yocto Project Overview and Concepts Manual,
1613 runtime dependencies will often be added automatically, meaning 1613 runtime dependencies will often be added automatically, meaning
1614 ``DEPENDS`` alone is sufficient for most recipes. 1614 :term:`DEPENDS` alone is sufficient for most recipes.
1615 1615
1616 - Counterintuitively, :term:`DEPENDS` is often necessary even for 1616 - Counterintuitively, :term:`DEPENDS` is often necessary even for
1617 recipes that install precompiled components. For example, if 1617 recipes that install precompiled components. For example, if
@@ -1652,7 +1652,7 @@ system and gives an overview of their function and contents.
1652 "package_deb". 1652 "package_deb".
1653 1653
1654 The BitBake configuration file initially defines the 1654 The BitBake configuration file initially defines the
1655 ``DEPLOY_DIR_DEB`` variable as a sub-folder of 1655 :term:`DEPLOY_DIR_DEB` variable as a sub-folder of
1656 :term:`DEPLOY_DIR`:: 1656 :term:`DEPLOY_DIR`::
1657 1657
1658 DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb" 1658 DEPLOY_DIR_DEB = "${DEPLOY_DIR}/deb"
@@ -2568,7 +2568,7 @@ system and gives an overview of their function and contents.
2568 :term:`FONT_EXTRA_RDEPENDS` 2568 :term:`FONT_EXTRA_RDEPENDS`
2569 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, 2569 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class,
2570 this variable specifies the runtime dependencies for font packages. 2570 this variable specifies the runtime dependencies for font packages.
2571 By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils". 2571 By default, the :term:`FONT_EXTRA_RDEPENDS` is set to "fontconfig-utils".
2572 2572
2573 :term:`FONT_PACKAGES` 2573 :term:`FONT_PACKAGES`
2574 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, 2574 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class,
@@ -3005,7 +3005,7 @@ system and gives an overview of their function and contents.
3005 3005
3006 - If an image recipe uses the "inherit image" line and you are 3006 - If an image recipe uses the "inherit image" line and you are
3007 setting :term:`IMAGE_FSTYPES` inside the recipe, you must set 3007 setting :term:`IMAGE_FSTYPES` inside the recipe, you must set
3008 ``IMAGE_FSTYPES`` prior to using the "inherit image" line. 3008 :term:`IMAGE_FSTYPES` prior to using the "inherit image" line.
3009 3009
3010 - Due to the way the OpenEmbedded build system processes this 3010 - Due to the way the OpenEmbedded build system processes this
3011 variable, you cannot update its contents by using ``_append`` 3011 variable, you cannot update its contents by using ``_append``
@@ -3334,13 +3334,13 @@ system and gives an overview of their function and contents.
3334 :term:`IMGDEPLOYDIR` 3334 :term:`IMGDEPLOYDIR`
3335 When inheriting the :ref:`image <ref-classes-image>` class directly or 3335 When inheriting the :ref:`image <ref-classes-image>` class directly or
3336 through the :ref:`core-image <ref-classes-core-image>` class, the 3336 through the :ref:`core-image <ref-classes-core-image>` class, the
3337 ``IMGDEPLOYDIR`` points to a temporary work area for deployed files 3337 :term:`IMGDEPLOYDIR` points to a temporary work area for deployed files
3338 that is set in the ``image`` class as follows:: 3338 that is set in the ``image`` class as follows::
3339 3339
3340 IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete" 3340 IMGDEPLOYDIR = "${WORKDIR}/deploy-${PN}-image-complete"
3341 3341
3342 Recipes inheriting the ``image`` class should copy files to be 3342 Recipes inheriting the ``image`` class should copy files to be
3343 deployed into ``IMGDEPLOYDIR``, and the class will take care of 3343 deployed into :term:`IMGDEPLOYDIR`, and the class will take care of
3344 copying them into :term:`DEPLOY_DIR_IMAGE` afterwards. 3344 copying them into :term:`DEPLOY_DIR_IMAGE` afterwards.
3345 3345
3346 :term:`INC_PR` 3346 :term:`INC_PR`
@@ -3698,7 +3698,7 @@ system and gives an overview of their function and contents.
3698 - qemu 3698 - qemu
3699 - mips 3699 - mips
3700 3700
3701 You define the ``KARCH`` variable in the :ref:`kernel-dev/advanced:bsp descriptions`. 3701 You define the :term:`KARCH` variable in the :ref:`kernel-dev/advanced:bsp descriptions`.
3702 3702
3703 :term:`KBRANCH` 3703 :term:`KBRANCH`
3704 A regular expression used by the build process to explicitly identify 3704 A regular expression used by the build process to explicitly identify
@@ -4653,7 +4653,7 @@ system and gives an overview of their function and contents.
4653 4653
4654 :term:`module_autoload` 4654 :term:`module_autoload`
4655 This variable has been replaced by the :term:`KERNEL_MODULE_AUTOLOAD` 4655 This variable has been replaced by the :term:`KERNEL_MODULE_AUTOLOAD`
4656 variable. You should replace all occurrences of ``module_autoload`` 4656 variable. You should replace all occurrences of :term:`module_autoload`
4657 with additions to :term:`KERNEL_MODULE_AUTOLOAD`, for example:: 4657 with additions to :term:`KERNEL_MODULE_AUTOLOAD`, for example::
4658 4658
4659 module_autoload_rfcomm = "rfcomm" 4659 module_autoload_rfcomm = "rfcomm"
@@ -4684,9 +4684,9 @@ system and gives an overview of their function and contents.
4684 You must use the kernel module name override. 4684 You must use the kernel module name override.
4685 4685
4686 Run ``man modprobe.d`` in the shell to find out more information on 4686 Run ``man modprobe.d`` in the shell to find out more information on
4687 the exact syntax you want to provide with ``module_conf``. 4687 the exact syntax you want to provide with :term:`module_conf`.
4688 4688
4689 Including ``module_conf`` causes the OpenEmbedded build system to 4689 Including :term:`module_conf` causes the OpenEmbedded build system to
4690 populate the ``/etc/modprobe.d/modname.conf`` file with 4690 populate the ``/etc/modprobe.d/modname.conf`` file with
4691 ``modprobe.d`` syntax lines. Here is an example that adds the options 4691 ``modprobe.d`` syntax lines. Here is an example that adds the options
4692 ``arg1`` and ``arg2`` to a module named ``mymodule``:: 4692 ``arg1`` and ``arg2`` to a module named ``mymodule``::
@@ -4876,7 +4876,7 @@ system and gives an overview of their function and contents.
4876 information, see the ":ref:`dev-manual/common-tasks:using a development shell`" section in 4876 information, see the ":ref:`dev-manual/common-tasks:using a development shell`" section in
4877 the Yocto Project Development Tasks Manual. 4877 the Yocto Project Development Tasks Manual.
4878 4878
4879 You can use the following values for the ``OE_TERMINAL`` variable: 4879 You can use the following values for the :term:`OE_TERMINAL` variable:
4880 4880
4881 - auto 4881 - auto
4882 - gnome 4882 - gnome
@@ -5260,7 +5260,7 @@ system and gives an overview of their function and contents.
5260 PACKAGECONFIG[f2] = "\ 5260 PACKAGECONFIG[f2] = "\
5261 ... and so on and so on ... 5261 ... and so on and so on ...
5262 5262
5263 The ``PACKAGECONFIG`` variable itself specifies a space-separated 5263 The :term:`PACKAGECONFIG` variable itself specifies a space-separated
5264 list of the features to enable. Following the features, you can 5264 list of the features to enable. Following the features, you can
5265 determine the behavior of each feature by providing up to six 5265 determine the behavior of each feature by providing up to six
5266 order-dependent arguments, which are separated by commas. You can 5266 order-dependent arguments, which are separated by commas. You can
@@ -5600,7 +5600,7 @@ system and gives an overview of their function and contents.
5600 5600
5601 If applicable, the :term:`PN` variable also contains any special suffix 5601 If applicable, the :term:`PN` variable also contains any special suffix
5602 or prefix. For example, using ``bash`` to build packages for the 5602 or prefix. For example, using ``bash`` to build packages for the
5603 native machine, ``PN`` is ``bash-native``. Using ``bash`` to build 5603 native machine, :term:`PN` is ``bash-native``. Using ``bash`` to build
5604 packages for the target and for Multilib, :term:`PN` would be ``bash`` 5604 packages for the target and for Multilib, :term:`PN` would be ``bash``
5605 and ``lib64-bash``, respectively. 5605 and ``lib64-bash``, respectively.
5606 5606
@@ -5670,7 +5670,7 @@ system and gives an overview of their function and contents.
5670 :term:`PR` does not need to be increased for changes that do not change the 5670 :term:`PR` does not need to be increased for changes that do not change the
5671 package contents or metadata. 5671 package contents or metadata.
5672 5672
5673 Because manually managing ``PR`` can be cumbersome and error-prone, 5673 Because manually managing :term:`PR` can be cumbersome and error-prone,
5674 an automated solution exists. See the 5674 an automated solution exists. See the
5675 ":ref:`dev-manual/common-tasks:working with a pr service`" section 5675 ":ref:`dev-manual/common-tasks:working with a pr service`" section
5676 in the Yocto Project Development Tasks Manual for more information. 5676 in the Yocto Project Development Tasks Manual for more information.
@@ -6042,7 +6042,7 @@ system and gives an overview of their function and contents.
6042 6042
6043 In the example, 6043 In the example,
6044 the development package depends on the ``perl`` package. Thus, the 6044 the development package depends on the ``perl`` package. Thus, the
6045 ``RDEPENDS`` variable has the ``${PN}-dev`` package name as part of 6045 :term:`RDEPENDS` variable has the ``${PN}-dev`` package name as part of
6046 the variable. 6046 the variable.
6047 6047
6048 .. note:: 6048 .. note::
@@ -7079,7 +7079,7 @@ system and gives an overview of their function and contents.
7079 7079
7080 :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` 7080 :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH`
7081 By default, the OpenEmbedded build system automatically detects 7081 By default, the OpenEmbedded build system automatically detects
7082 whether ``SRC_URI`` contains files that are machine-specific. If so, 7082 whether :term:`SRC_URI` contains files that are machine-specific. If so,
7083 the build system automatically changes :term:`PACKAGE_ARCH`. Setting this 7083 the build system automatically changes :term:`PACKAGE_ARCH`. Setting this
7084 variable to "0" disables this behavior. 7084 variable to "0" disables this behavior.
7085 7085
@@ -7292,7 +7292,7 @@ system and gives an overview of their function and contents.
7292 7292
7293 ``-native`` recipes are not installed into host paths like such 7293 ``-native`` recipes are not installed into host paths like such
7294 as ``/usr``. Rather, these recipes are installed into 7294 as ``/usr``. Rather, these recipes are installed into
7295 ``STAGING_DIR_NATIVE``. When compiling ``-native`` recipes, 7295 :term:`STAGING_DIR_NATIVE`. When compiling ``-native`` recipes,
7296 standard build environment variables such as 7296 standard build environment variables such as
7297 :term:`CPPFLAGS` and 7297 :term:`CPPFLAGS` and
7298 :term:`CFLAGS` are set up so that both host paths 7298 :term:`CFLAGS` are set up so that both host paths
@@ -7726,13 +7726,13 @@ system and gives an overview of their function and contents.
7726 Specifies the prefix used for the toolchain binary target tools. 7726 Specifies the prefix used for the toolchain binary target tools.
7727 7727
7728 Depending on the type of recipe and the build target, 7728 Depending on the type of recipe and the build target,
7729 ``TARGET_PREFIX`` is set as follows: 7729 :term:`TARGET_PREFIX` is set as follows:
7730 7730
7731 - For recipes building for the target machine, the value is 7731 - For recipes building for the target machine, the value is
7732 "${:term:`TARGET_SYS`}-". 7732 "${:term:`TARGET_SYS`}-".
7733 7733
7734 - For native recipes, the build system sets the variable to the 7734 - For native recipes, the build system sets the variable to the
7735 value of ``BUILD_PREFIX``. 7735 value of :term:`BUILD_PREFIX`.
7736 7736
7737 - For native SDK recipes (``nativesdk``), the build system sets the 7737 - For native SDK recipes (``nativesdk``), the build system sets the
7738 variable to the value of :term:`SDK_PREFIX`. 7738 variable to the value of :term:`SDK_PREFIX`.
@@ -7778,7 +7778,7 @@ system and gives an overview of their function and contents.
7778 separate to avoid potential conflicts. 7778 separate to avoid potential conflicts.
7779 7779
7780 In the ``defaultsetup.conf`` file, the default value of 7780 In the ``defaultsetup.conf`` file, the default value of
7781 ``TCLIBCAPPEND`` is "-${TCLIBC}". However, distros such as poky, 7781 :term:`TCLIBCAPPEND` is "-${TCLIBC}". However, distros such as poky,
7782 which normally only support one ``libc`` variant, set 7782 which normally only support one ``libc`` variant, set
7783 :term:`TCLIBCAPPEND` to "" in their distro configuration file resulting 7783 :term:`TCLIBCAPPEND` to "" in their distro configuration file resulting
7784 in no suffix being applied. 7784 in no suffix being applied.
@@ -7960,7 +7960,7 @@ system and gives an overview of their function and contents.
7960 ``BaseTarget`` class, which is an abstract class that cannot be used 7960 ``BaseTarget`` class, which is an abstract class that cannot be used
7961 as a value of :term:`TEST_TARGET`. 7961 as a value of :term:`TEST_TARGET`.
7962 7962
7963 You can provide the following arguments with ``TEST_TARGET``: 7963 You can provide the following arguments with :term:`TEST_TARGET`:
7964 7964
7965 - *"qemu":* Boots a QEMU image and runs the tests. See the 7965 - *"qemu":* Boots a QEMU image and runs the tests. See the
7966 ":ref:`dev-manual/common-tasks:enabling runtime tests on qemu`" section 7966 ":ref:`dev-manual/common-tasks:enabling runtime tests on qemu`" section
@@ -8298,7 +8298,7 @@ system and gives an overview of their function and contents.
8298 In this example, "sd" is selected as the configuration of the possible four for the 8298 In this example, "sd" is selected as the configuration of the possible four for the
8299 :term:`UBOOT_MACHINE`. The "sd" configuration defines 8299 :term:`UBOOT_MACHINE`. The "sd" configuration defines
8300 "mx6qsabreauto_config" as the value for :term:`UBOOT_MACHINE`, while the 8300 "mx6qsabreauto_config" as the value for :term:`UBOOT_MACHINE`, while the
8301 "sdcard" specifies the ``IMAGE_FSTYPES`` to use for the U-Boot image. 8301 "sdcard" specifies the :term:`IMAGE_FSTYPES` to use for the U-Boot image.
8302 8302
8303 For more information on how the :term:`UBOOT_CONFIG` is handled, see the 8303 For more information on how the :term:`UBOOT_CONFIG` is handled, see the
8304 :ref:`uboot-config <ref-classes-uboot-config>` 8304 :ref:`uboot-config <ref-classes-uboot-config>`
@@ -8357,7 +8357,7 @@ system and gives an overview of their function and contents.
8357 :term:`UBOOT_MKIMAGE_DTCOPTS` 8357 :term:`UBOOT_MKIMAGE_DTCOPTS`
8358 Options for the device tree compiler passed to mkimage '-D' 8358 Options for the device tree compiler passed to mkimage '-D'
8359 feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. 8359 feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class.
8360 If ``UBOOT_MKIMAGE_DTCOPTS`` is not set then kernel-fitimage will not 8360 If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then kernel-fitimage will not
8361 pass the ``-D`` option to mkimage. 8361 pass the ``-D`` option to mkimage.
8362 8362
8363 :term:`UBOOT_MKIMAGE_SIGN` 8363 :term:`UBOOT_MKIMAGE_SIGN`