summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-05-12 11:29:20 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-05-22 12:16:40 +0100
commit4db4e4ca46e8b23d5042d925ce5ad3073de4c3ed (patch)
tree6c0f58527ff6d5929ce0e948092357efb69fc659 /documentation
parent68ee5b4bcc1098cb5a66098e65bec6c1cf69f4c2 (diff)
downloadpoky-4db4e4ca46e8b23d5042d925ce5ad3073de4c3ed.tar.gz
ref-manual: simplify style
(From yocto-docs rev: 657a7f54856afd6fec7f2cb0b5f12b4b2d24adb7) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/classes.rst12
-rw-r--r--documentation/ref-manual/devtool-reference.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.rst8
-rw-r--r--documentation/ref-manual/release-process.rst4
-rw-r--r--documentation/ref-manual/resources.rst12
-rw-r--r--documentation/ref-manual/structure.rst8
-rw-r--r--documentation/ref-manual/system-requirements.rst8
-rw-r--r--documentation/ref-manual/tasks.rst3
-rw-r--r--documentation/ref-manual/variables.rst76
11 files changed, 69 insertions, 76 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index ffa17139fe..6dd0cbbd41 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1006,7 +1006,7 @@ package name override, in this example ``${PN}``, must be used::
1006 INSANE_SKIP_${PN} += "dev-so" 1006 INSANE_SKIP_${PN} += "dev-so"
1007 1007
1008Please keep in mind that the QA checks 1008Please keep in mind that the QA checks
1009exist in order to detect real or potential problems in the packaged 1009are meant to detect real or potential problems in the packaged
1010output. So exercise caution when disabling these checks. 1010output. So exercise caution when disabling these checks.
1011 1011
1012Here are the tests you can list with the ``WARN_QA`` and 1012Here are the tests you can list with the ``WARN_QA`` and
@@ -1085,8 +1085,8 @@ Here are the tests you can list with the ``WARN_QA`` and
1085- ``dev-so:`` Checks that the ``.so`` symbolic links are in the 1085- ``dev-so:`` Checks that the ``.so`` symbolic links are in the
1086 ``-dev`` package and not in any of the other packages. In general, 1086 ``-dev`` package and not in any of the other packages. In general,
1087 these symlinks are only useful for development purposes. Thus, the 1087 these symlinks are only useful for development purposes. Thus, the
1088 ``-dev`` package is the correct location for them. Some very rare 1088 ``-dev`` package is the correct location for them. In very rare
1089 cases do exist for dynamically loaded modules where these symlinks 1089 cases, such as dynamically loaded modules, these symlinks
1090 are needed instead in the main package. 1090 are needed instead in the main package.
1091 1091
1092- ``file-rdeps:`` Checks that file-level dependencies identified by 1092- ``file-rdeps:`` Checks that file-level dependencies identified by
@@ -1676,7 +1676,7 @@ couple different ways:
1676 nativesdk-myrecipe.bb 1676 nativesdk-myrecipe.bb
1677 1677
1678 1678
1679 Not doing so can lead to subtle problems because code exists that 1679 Not doing so can lead to subtle problems because there is code that
1680 depends on the naming convention. 1680 depends on the naming convention.
1681 1681
1682Although applied differently, the ``nativesdk`` class is used with both 1682Although applied differently, the ``nativesdk`` class is used with both
@@ -1714,10 +1714,10 @@ section in the Yocto Project Development Tasks Manual.
1714``oelint.bbclass`` 1714``oelint.bbclass``
1715================== 1715==================
1716 1716
1717The ``oelint`` class is an obsolete lint checking tool that exists in 1717The ``oelint`` class is an obsolete lint checking tool available in
1718``meta/classes`` in the :term:`Source Directory`. 1718``meta/classes`` in the :term:`Source Directory`.
1719 1719
1720A number of classes exist that could be generally useful in OE-Core but 1720There are some classes that could be generally useful in OE-Core but
1721are never actually used within OE-Core itself. The ``oelint`` class is 1721are never actually used within OE-Core itself. The ``oelint`` class is
1722one such example. However, being aware of this class can reduce the 1722one such example. However, being aware of this class can reduce the
1723proliferation of different versions of similar classes across multiple 1723proliferation of different versions of similar classes across multiple
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst
index 0ce3219831..1862c481df 100644
--- a/documentation/ref-manual/devtool-reference.rst
+++ b/documentation/ref-manual/devtool-reference.rst
@@ -403,8 +403,8 @@ Upgrading a Recipe
403 403
404As software matures, upstream recipes are upgraded to newer versions. As 404As software matures, upstream recipes are upgraded to newer versions. As
405a developer, you need to keep your local recipes up-to-date with the 405a developer, you need to keep your local recipes up-to-date with the
406upstream version releases. Several methods exist by which you can 406upstream version releases. There are several ways of upgrading recipes.
407upgrade recipes. You can read about them in the ":ref:`dev-manual/common-tasks:upgrading recipes`" 407You can read about them in the ":ref:`dev-manual/common-tasks:upgrading recipes`"
408section of the Yocto Project Development Tasks Manual. This section 408section of the Yocto Project Development Tasks Manual. This section
409overviews the ``devtool upgrade`` command. 409overviews the ``devtool upgrade`` command.
410 410
@@ -516,8 +516,8 @@ you do, the package manager is bypassed.
516 should never use it to update an image that will be used in 516 should never use it to update an image that will be used in
517 production. 517 production.
518 518
519Some conditions exist that could prevent a deployed application from 519Some conditions could prevent a deployed application from
520behaving as expected. When both of the following conditions exist, your 520behaving as expected. When both of the following conditions are met, your
521application has the potential to not behave correctly when run on the 521application has the potential to not behave correctly when run on the
522target: 522target:
523 523
@@ -528,7 +528,7 @@ target:
528- The target does not physically have the packages on which the 528- The target does not physically have the packages on which the
529 application depends installed. 529 application depends installed.
530 530
531If both of these conditions exist, your application will not behave as 531If both of these conditions are met, your application will not behave as
532expected. The reason for this misbehavior is because the 532expected. The reason for this misbehavior is because the
533``devtool deploy-target`` command does not deploy the packages (e.g. 533``devtool deploy-target`` command does not deploy the packages (e.g.
534libraries) on which your new application depends. The assumption is that 534libraries) on which your new application depends. The assumption is that
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index e7bca829a3..f1b564a60e 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -312,7 +312,7 @@ HTTPS requests and direct them to the ``http://`` sources mirror. You
312can use ``file://`` URLs to point to local directories or network shares 312can use ``file://`` URLs to point to local directories or network shares
313as well. 313as well.
314 314
315Aside from the previous technique, these options also exist:: 315Here are other options::
316 316
317 BB_NO_NETWORK = "1" 317 BB_NO_NETWORK = "1"
318 318
diff --git a/documentation/ref-manual/kickstart.rst b/documentation/ref-manual/kickstart.rst
index 843292b528..8308ffff5b 100644
--- a/documentation/ref-manual/kickstart.rst
+++ b/documentation/ref-manual/kickstart.rst
@@ -210,5 +210,5 @@ supports the following options:
210 210
211- ``--configfile``: Specifies a user-defined configuration file for 211- ``--configfile``: Specifies a user-defined configuration file for
212 the bootloader. You can provide a full pathname for the file or a 212 the bootloader. You can provide a full pathname for the file or a
213 file that exists in the ``canned-wks`` folder. This option overrides 213 file located in the ``canned-wks`` folder. This option overrides
214 all other bootloader options. 214 all other bootloader options.
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index 9cc4c577c7..2e98713a27 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -97,7 +97,7 @@ Errors and Warnings
97 97
98- ``<packagename1> rdepends on <packagename2>, but it isn't a build dependency? [build-deps]`` 98- ``<packagename1> rdepends on <packagename2>, but it isn't a build dependency? [build-deps]``
99 99
100 A runtime dependency exists between the two specified packages, but 100 There is a runtime dependency between the two specified packages, but
101 there is nothing explicit within the recipe to enable the 101 there is nothing explicit within the recipe to enable the
102 OpenEmbedded build system to ensure that dependency is satisfied. 102 OpenEmbedded build system to ensure that dependency is satisfied.
103 This condition is usually triggered by an 103 This condition is usually triggered by an
@@ -303,7 +303,7 @@ Errors and Warnings
303 303
304- ``<packagename> rdepends on <debug_packagename> [debug-deps]`` 304- ``<packagename> rdepends on <debug_packagename> [debug-deps]``
305 305
306 A dependency exists between the specified non-dbg package (i.e. a 306 There is a dependency between the specified non-dbg package (i.e. a
307 package whose name does not end in ``-dbg``) and a package that is a 307 package whose name does not end in ``-dbg``) and a package that is a
308 ``dbg`` package. The ``dbg`` packages contain debug symbols and are 308 ``dbg`` package. The ``dbg`` packages contain debug symbols and are
309 brought in using several different methods: 309 brought in using several different methods:
@@ -326,7 +326,7 @@ Errors and Warnings
326 326
327- ``<packagename> rdepends on <dev_packagename> [dev-deps]`` 327- ``<packagename> rdepends on <dev_packagename> [dev-deps]``
328 328
329 A dependency exists between the specified non-dev package (a package 329 There is a dependency between the specified non-dev package (a package
330 whose name does not end in ``-dev``) and a package that is a ``dev`` 330 whose name does not end in ``-dev``) and a package that is a ``dev``
331 package. The ``dev`` packages contain development headers and are 331 package. The ``dev`` packages contain development headers and are
332 usually brought in using several different methods: 332 usually brought in using several different methods:
@@ -753,6 +753,6 @@ how to work with the QA checks, see the
753 753
754.. note:: 754.. note::
755 755
756 Please keep in mind that the QA checks exist in order to detect real 756 Please keep in mind that the QA checks are meant to detect real
757 or potential problems in the packaged output. So exercise caution 757 or potential problems in the packaged output. So exercise caution
758 when disabling these checks. 758 when disabling these checks.
diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst
index 93ab6ed08a..935a2e39bb 100644
--- a/documentation/ref-manual/release-process.rst
+++ b/documentation/ref-manual/release-process.rst
@@ -82,14 +82,14 @@ stable release.
82 bug fixes and security fixes only. Policy dictates that features are 82 bug fixes and security fixes only. Policy dictates that features are
83 not backported to a stable release. This policy means generic recipe 83 not backported to a stable release. This policy means generic recipe
84 version upgrades are unlikely to be accepted for backporting. The 84 version upgrades are unlikely to be accepted for backporting. The
85 exception to this policy occurs when a strong reason exists such as 85 exception to this policy occurs when there is a strong reason such as
86 the fix happens to also be the preferred upstream approach. 86 the fix happens to also be the preferred upstream approach.
87 87
88Stable release branches have strong maintenance for about a year after 88Stable release branches have strong maintenance for about a year after
89their initial release. Should significant issues be found for any 89their initial release. Should significant issues be found for any
90release regardless of its age, fixes could be backported to older 90release regardless of its age, fixes could be backported to older
91releases. For issues that are not backported given an older release, 91releases. For issues that are not backported given an older release,
92Community LTS trees and branches exist where community members share 92Community LTS trees and branches allow community members to share
93patches for older releases. However, these types of patches do not go 93patches for older releases. However, these types of patches do not go
94through the same release process as do point releases. You can find more 94through the same release process as do point releases. You can find more
95information about stable branch maintenance at 95information about stable branch maintenance at
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index 663f0d96d5..5ffd2b3991 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -10,7 +10,7 @@ Introduction
10============ 10============
11 11
12The Yocto Project team is happy for people to experiment with the Yocto 12The Yocto Project team is happy for people to experiment with the Yocto
13Project. A number of places exist to find help if you run into 13Project. There is a number of places where you can find help if you run into
14difficulties or find bugs. This presents information about contributing 14difficulties or find bugs. This presents information about contributing
15and participating in the Yocto Project. 15and participating in the Yocto Project.
16 16
@@ -43,8 +43,7 @@ the Yocto Project itself (e.g. when discovering an issue with some
43component of the build system that acts contrary to the documentation or 43component of the build system that acts contrary to the documentation or
44your expectations). 44your expectations).
45 45
46A general procedure and guidelines exist for when you use Bugzilla to 46For a general procedure and guidelines on how to use Bugzilla to submit a bug
47submit a bug. For information on how to use Bugzilla to submit a bug
48against the Yocto Project, see the following: 47against the Yocto Project, see the following:
49 48
50- The ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`" 49- The ":ref:`dev-manual/common-tasks:submitting a defect against the yocto project`"
@@ -59,7 +58,7 @@ For information on Bugzilla in general, see https://www.bugzilla.org/about/.
59Mailing lists 58Mailing lists
60============= 59=============
61 60
62A number of mailing lists maintained by the Yocto Project exist as well 61There are multiple mailing lists maintained by the Yocto Project as well
63as related OpenEmbedded mailing lists for discussion, patch submission 62as related OpenEmbedded mailing lists for discussion, patch submission
64and announcements. To subscribe to one of the following mailing lists, 63and announcements. To subscribe to one of the following mailing lists,
65click on the appropriate URL in the following list and follow the 64click on the appropriate URL in the following list and follow the
@@ -156,9 +155,8 @@ Here is a list of resources you might find helpful:
156 155
157- :yocto_docs:`Yocto Project Mega-Manual </singleindex.html>`\ *:* This manual 156- :yocto_docs:`Yocto Project Mega-Manual </singleindex.html>`\ *:* This manual
158 is simply a single HTML file comprised of the bulk of the Yocto 157 is simply a single HTML file comprised of the bulk of the Yocto
159 Project manuals. The Mega-Manual primarily exists as a vehicle by 158 Project manuals. It makes it easy to search for phrases and terms used
160 which you can easily search for phrases and terms used in the Yocto 159 in the Yocto Project documentation set.
161 Project documentation set.
162 160
163- :doc:`/profile-manual/index` *:* This manual presents a set of 161- :doc:`/profile-manual/index` *:* This manual presents a set of
164 common and generally useful tracing and profiling schemes along with 162 common and generally useful tracing and profiling schemes along with
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst
index 2106a8083b..36c9efc1e2 100644
--- a/documentation/ref-manual/structure.rst
+++ b/documentation/ref-manual/structure.rst
@@ -510,8 +510,8 @@ should be automatic, and recipes should not directly reference
510----------------------- 510-----------------------
511 511
512Previous versions of the OpenEmbedded build system used to create a 512Previous versions of the OpenEmbedded build system used to create a
513global shared sysroot per machine along with a native sysroot. Beginning 513global shared sysroot per machine along with a native sysroot. Since
514with the 2.3 version of the Yocto Project, sysroots exist in 514the 2.3 version of the Yocto Project, there are sysroots in
515recipe-specific :term:`WORKDIR` directories. Thus, the 515recipe-specific :term:`WORKDIR` directories. Thus, the
516``build/tmp/sysroots/`` directory is unused. 516``build/tmp/sysroots/`` directory is unused.
517 517
@@ -601,7 +601,7 @@ constructed using the architecture of the given build (e.g.
601name, and the version of the recipe (i.e. 601name, and the version of the recipe (i.e.
602:term:`PE`\ ``:``\ :term:`PV`\ ``-``\ :term:`PR`). 602:term:`PE`\ ``:``\ :term:`PV`\ ``-``\ :term:`PR`).
603 603
604A number of key subdirectories exist within each recipe work directory: 604Here are key subdirectories within each recipe work directory:
605 605
606- ``${WORKDIR}/temp``: Contains the log files of each task executed for 606- ``${WORKDIR}/temp``: Contains the log files of each task executed for
607 this recipe, the "run" files for each executed task, which contain 607 this recipe, the "run" files for each executed task, which contain
@@ -624,7 +624,7 @@ A number of key subdirectories exist within each recipe work directory:
624 624
625- ``${WORKDIR}/packages-split``: Contains the output of the 625- ``${WORKDIR}/packages-split``: Contains the output of the
626 ``do_package`` task after the output has been split into individual 626 ``do_package`` task after the output has been split into individual
627 packages. Subdirectories exist for each individual package created by 627 packages. There are subdirectories for each individual package created by
628 the recipe. 628 the recipe.
629 629
630- ``${WORKDIR}/recipe-sysroot``: A directory populated with the target 630- ``${WORKDIR}/recipe-sysroot``: A directory populated with the target
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 9b4afc043e..e9d995c61b 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -66,9 +66,8 @@ distributions:
66 66
67 - While the Yocto Project Team attempts to ensure all Yocto Project 67 - While the Yocto Project Team attempts to ensure all Yocto Project
68 releases are one hundred percent compatible with each officially 68 releases are one hundred percent compatible with each officially
69 supported Linux distribution, instances might exist where you 69 supported Linux distribution, you may still encounter problems
70 encounter a problem while using the Yocto Project on a specific 70 that happen only with a specific distribution.
71 distribution.
72 71
73 - Yocto Project releases are tested against the stable Linux 72 - Yocto Project releases are tested against the stable Linux
74 distributions in the above list. The Yocto Project should work 73 distributions in the above list. The Yocto Project should work
@@ -119,8 +118,7 @@ supported Ubuntu or Debian Linux distribution:
119 - If your build system has the ``oss4-dev`` package installed, you 118 - If your build system has the ``oss4-dev`` package installed, you
120 might experience QEMU build failures due to the package installing 119 might experience QEMU build failures due to the package installing
121 its own custom ``/usr/include/linux/soundcard.h`` on the Debian 120 its own custom ``/usr/include/linux/soundcard.h`` on the Debian
122 system. If you run into this situation, either of the following 121 system. If you run into this situation, try either of these solutions::
123 solutions exist::
124 122
125 $ sudo apt-get build-dep qemu 123 $ sudo apt-get build-dep qemu
126 $ sudo apt-get remove oss4-dev 124 $ sudo apt-get remove oss4-dev
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 001edf6bb3..5bceb79b8d 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -823,6 +823,5 @@ sections from a size-sensitive configuration.
823After the kernel is unpacked but before it is patched, this task makes 823After the kernel is unpacked but before it is patched, this task makes
824sure that the machine and metadata branches as specified by the 824sure that the machine and metadata branches as specified by the
825:term:`SRCREV` variables actually exist on the specified 825:term:`SRCREV` variables actually exist on the specified
826branches. If these branches do not exist and 826branches. Otherwise, if :term:`AUTOREV` is not being used, the
827:term:`AUTOREV` is not being used, the
828``do_validate_branches`` task fails during the build. 827``do_validate_branches`` task fails during the build.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 0b61f77cb4..a3401a4f1b 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -49,10 +49,9 @@ system and gives an overview of their function and contents.
49 alternatives system to create a different binary naming scheme so the 49 alternatives system to create a different binary naming scheme so the
50 commands can co-exist. 50 commands can co-exist.
51 51
52 To use the variable, list out the package's commands that also exist 52 To use the variable, list out the package's commands that are also
53 as part of another package. For example, if the ``busybox`` package 53 provided by another package. For example, if the ``busybox`` package
54 has four commands that also exist as part of another package, you 54 has four such commands, you identify them as follows::
55 identify them as follows::
56 55
57 ALTERNATIVE_busybox = "sh sed test bracket" 56 ALTERNATIVE_busybox = "sh sed test bracket"
58 57
@@ -306,8 +305,8 @@ system and gives an overview of their function and contents.
306 variable), the OpenEmbedded build system ignores your request and 305 variable), the OpenEmbedded build system ignores your request and
307 will install the packages to avoid dependency errors. 306 will install the packages to avoid dependency errors.
308 307
309 Support for this variable exists only when using the IPK and RPM 308 This variable is supported only when using the IPK and RPM
310 packaging backend. Support does not exist for DEB. 309 packaging backends. DEB is not supported.
311 310
312 See the :term:`NO_RECOMMENDATIONS` and the 311 See the :term:`NO_RECOMMENDATIONS` and the
313 :term:`PACKAGE_EXCLUDE` variables for related 312 :term:`PACKAGE_EXCLUDE` variables for related
@@ -336,8 +335,8 @@ system and gives an overview of their function and contents.
336 - This host list is only used if ``BB_NO_NETWORK`` is either not set 335 - This host list is only used if ``BB_NO_NETWORK`` is either not set
337 or set to "0". 336 or set to "0".
338 337
339 - Limited support for wildcard matching against the beginning of 338 - There is limited support for wildcard matching against the beginning of
340 host names exists. For example, the following setting matches 339 host names. For example, the following setting matches
341 ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``. 340 ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``.
342 :: 341 ::
343 342
@@ -558,7 +557,7 @@ system and gives an overview of their function and contents.
558 557
559 :term:`BBCLASSEXTEND` 558 :term:`BBCLASSEXTEND`
560 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
561 software. Common variants for recipes exist such as "natives" like 560 software. There are common variants for recipes as "natives" like
562 ``quilt-native``, which is a copy of Quilt built to run on the build 561 ``quilt-native``, which is a copy of Quilt built to run on the build
563 system; "crosses" such as ``gcc-cross``, which is a compiler built to 562 system; "crosses" such as ``gcc-cross``, which is a compiler built to
564 run on the build machine but produces binaries that run on the target 563 run on the build machine but produces binaries that run on the target
@@ -1237,7 +1236,7 @@ system and gives an overview of their function and contents.
1237 CONFFILES_${PN} += "${sysconfdir}/file1 \ 1236 CONFFILES_${PN} += "${sysconfdir}/file1 \
1238 ${sysconfdir}/file2 ${sysconfdir}/file3" 1237 ${sysconfdir}/file2 ${sysconfdir}/file3"
1239 1238
1240 A relationship exists between the ``CONFFILES`` and ``FILES`` 1239 There is a relationship between the ``CONFFILES`` and ``FILES``
1241 variables. The files listed within ``CONFFILES`` must be a subset of 1240 variables. The files listed within ``CONFFILES`` must be a subset of
1242 the files listed within ``FILES``. Because the configuration files 1241 the files listed within ``FILES``. Because the configuration files
1243 you provide with ``CONFFILES`` are simply being identified so that 1242 you provide with ``CONFFILES`` are simply being identified so that
@@ -1417,8 +1416,8 @@ system and gives an overview of their function and contents.
1417 :term:`COREBASE_FILES` 1416 :term:`COREBASE_FILES`
1418 Lists files from the :term:`COREBASE` directory that 1417 Lists files from the :term:`COREBASE` directory that
1419 should be copied other than the layers listed in the 1418 should be copied other than the layers listed in the
1420 ``bblayers.conf`` file. The ``COREBASE_FILES`` variable exists for 1419 ``bblayers.conf`` file. The ``COREBASE_FILES`` variable allows
1421 the purpose of copying metadata from the OpenEmbedded build system 1420 to copy metadata from the OpenEmbedded build system
1422 into the extensible SDK. 1421 into the extensible SDK.
1423 1422
1424 Explicitly listing files in ``COREBASE`` is needed because it 1423 Explicitly listing files in ``COREBASE`` is needed because it
@@ -2460,8 +2459,8 @@ system and gives an overview of their function and contents.
2460 ``FILESEXTRAPATHS`` variable. 2459 ``FILESEXTRAPATHS`` variable.
2461 2460
2462 You can take advantage of this searching behavior in useful ways. For 2461 You can take advantage of this searching behavior in useful ways. For
2463 example, consider a case where the following directory structure 2462 example, consider a case where there is the following directory structure
2464 exists for general and machine-specific configurations:: 2463 for general and machine-specific configurations::
2465 2464
2466 files/defconfig 2465 files/defconfig
2467 files/MACHINEA/defconfig 2466 files/MACHINEA/defconfig
@@ -3013,8 +3012,8 @@ system and gives an overview of their function and contents.
3013 3012
3014 Image recipes set ``IMAGE_INSTALL`` to specify the packages to 3013 Image recipes set ``IMAGE_INSTALL`` to specify the packages to
3015 install into an image through ``image.bbclass``. Additionally, 3014 install into an image through ``image.bbclass``. Additionally,
3016 "helper" classes such as the 3015 there are "helper" classes such as the
3017 :ref:`core-image <ref-classes-core-image>` class exist that can 3016 :ref:`core-image <ref-classes-core-image>` class which can
3018 take lists used with ``IMAGE_FEATURES`` and turn them into 3017 take lists used with ``IMAGE_FEATURES`` and turn them into
3019 auto-generated entries in ``IMAGE_INSTALL`` in addition to its 3018 auto-generated entries in ``IMAGE_INSTALL`` in addition to its
3020 default contents. 3019 default contents.
@@ -3465,8 +3464,8 @@ system and gives an overview of their function and contents.
3465 Use of the ``INHIBIT_SYSROOT_STRIP`` variable occurs in rare and 3464 Use of the ``INHIBIT_SYSROOT_STRIP`` variable occurs in rare and
3466 special circumstances. For example, suppose you are building 3465 special circumstances. For example, suppose you are building
3467 bare-metal firmware by using an external GCC toolchain. Furthermore, 3466 bare-metal firmware by using an external GCC toolchain. Furthermore,
3468 even if the toolchain's binaries are strippable, other files exist 3467 even if the toolchain's binaries are strippable, there are other files
3469 that are needed for the build that are not strippable. 3468 needed for the build that are not strippable.
3470 3469
3471 :term:`INITRAMFS_FSTYPES` 3470 :term:`INITRAMFS_FSTYPES`
3472 Defines the format for the output image of an initial RAM filesystem 3471 Defines the format for the output image of an initial RAM filesystem
@@ -3817,7 +3816,7 @@ system and gives an overview of their function and contents.
3817 3816
3818 .. note:: 3817 .. note::
3819 3818
3820 Legacy support exists for specifying the full path to the device 3819 There is legacy support for specifying the full path to the device
3821 tree. However, providing just the ``.dtb`` file is preferred. 3820 tree. However, providing just the ``.dtb`` file is preferred.
3822 3821
3823 In order to use this variable, the 3822 In order to use this variable, the
@@ -4042,7 +4041,7 @@ system and gives an overview of their function and contents.
4042 4041
4043 :term:`KERNELDEPMODDEPEND` 4042 :term:`KERNELDEPMODDEPEND`
4044 Specifies whether the data referenced through 4043 Specifies whether the data referenced through
4045 :term:`PKGDATA_DIR` is needed or not. The 4044 :term:`PKGDATA_DIR` is needed or not.
4046 ``KERNELDEPMODDEPEND`` does not control whether or not that data 4045 ``KERNELDEPMODDEPEND`` does not control whether or not that data
4047 exists, but simply whether or not it is used. If you do not need to 4046 exists, but simply whether or not it is used. If you do not need to
4048 use the data, set the ``KERNELDEPMODDEPEND`` variable in your 4047 use the data, set the ``KERNELDEPMODDEPEND`` variable in your
@@ -4227,8 +4226,8 @@ system and gives an overview of their function and contents.
4227 - Separate license names using \| (pipe) when there is a choice 4226 - Separate license names using \| (pipe) when there is a choice
4228 between licenses. 4227 between licenses.
4229 4228
4230 - Separate license names using & (ampersand) when multiple licenses 4229 - Separate license names using & (ampersand) when there are
4231 exist that cover different parts of the source. 4230 multiple licenses for different parts of the source.
4232 4231
4233 - You can use spaces between license names. 4232 - You can use spaces between license names.
4234 4233
@@ -4376,8 +4375,8 @@ system and gives an overview of their function and contents.
4376 4375
4377 The variable corresponds to a machine configuration file of the same 4376 The variable corresponds to a machine configuration file of the same
4378 name, through which machine-specific configurations are set. Thus, 4377 name, through which machine-specific configurations are set. Thus,
4379 when ``MACHINE`` is set to "qemux86" there exists the corresponding 4378 when ``MACHINE`` is set to "qemux86", the corresponding
4380 ``qemux86.conf`` machine configuration file, which can be found in 4379 ``qemux86.conf`` machine configuration file can be found in
4381 the :term:`Source Directory` in 4380 the :term:`Source Directory` in
4382 ``meta/conf/machine``. 4381 ``meta/conf/machine``.
4383 4382
@@ -4742,7 +4741,7 @@ system and gives an overview of their function and contents.
4742 4741
4743 :term:`NO_GENERIC_LICENSE` 4742 :term:`NO_GENERIC_LICENSE`
4744 Avoids QA errors when you use a non-common, non-CLOSED license in a 4743 Avoids QA errors when you use a non-common, non-CLOSED license in a
4745 recipe. Packages exist, such as the linux-firmware package, with many 4744 recipe. There are packages, such as the linux-firmware package, with many
4746 licenses that are not in any way common. Also, new licenses are added 4745 licenses that are not in any way common. Also, new licenses are added
4747 occasionally to avoid introducing a lot of common license files, 4746 occasionally to avoid introducing a lot of common license files,
4748 which are only applicable to a specific package. 4747 which are only applicable to a specific package.
@@ -4786,8 +4785,8 @@ system and gives an overview of their function and contents.
4786 functionality, such as kernel modules. It is up to you to add 4785 functionality, such as kernel modules. It is up to you to add
4787 packages with the :term:`IMAGE_INSTALL` variable. 4786 packages with the :term:`IMAGE_INSTALL` variable.
4788 4787
4789 Support for this variable exists only when using the IPK and RPM 4788 This variable is only supported when using the IPK and RPM
4790 packaging backend. Support does not exist for DEB. 4789 packaging backends. DEB is not supported.
4791 4790
4792 See the :term:`BAD_RECOMMENDATIONS` and 4791 See the :term:`BAD_RECOMMENDATIONS` and
4793 the :term:`PACKAGE_EXCLUDE` variables for 4792 the :term:`PACKAGE_EXCLUDE` variables for
@@ -5064,8 +5063,8 @@ system and gives an overview of their function and contents.
5064 an iterative development process to remove specific components from a 5063 an iterative development process to remove specific components from a
5065 system. 5064 system.
5066 5065
5067 Support for this variable exists only when using the IPK and RPM 5066 This variable is supported only when using the IPK and RPM
5068 packaging backend. Support does not exist for DEB. 5067 packaging backends. DEB is not supported.
5069 5068
5070 See the :term:`NO_RECOMMENDATIONS` and the 5069 See the :term:`NO_RECOMMENDATIONS` and the
5071 :term:`BAD_RECOMMENDATIONS` variables for 5070 :term:`BAD_RECOMMENDATIONS` variables for
@@ -6211,7 +6210,7 @@ system and gives an overview of their function and contents.
6211 :term:`PACKAGE_EXCLUDE` variables. 6210 :term:`PACKAGE_EXCLUDE` variables.
6212 6211
6213 Packages specified in ``RRECOMMENDS`` need not actually be produced. 6212 Packages specified in ``RRECOMMENDS`` need not actually be produced.
6214 However, a recipe must exist that provides each package, either 6213 However, there must be a recipe providing each package, either
6215 through the :term:`PACKAGES` or 6214 through the :term:`PACKAGES` or
6216 :term:`PACKAGES_DYNAMIC` variables or the 6215 :term:`PACKAGES_DYNAMIC` variables or the
6217 :term:`RPROVIDES` variable, or an error will occur 6216 :term:`RPROVIDES` variable, or an error will occur
@@ -6979,8 +6978,8 @@ system and gives an overview of their function and contents.
6979 6978
6980 - ``az://`` - Fetches files from an Azure Storage account. 6979 - ``az://`` - Fetches files from an Azure Storage account.
6981 6980
6982 Standard and recipe-specific options for ``SRC_URI`` exist. Here are 6981 There are standard and recipe-specific options for ``SRC_URI``. Here are
6983 standard options: 6982 standard ones:
6984 6983
6985 - ``apply`` - Whether to apply the patch or not. The default 6984 - ``apply`` - Whether to apply the patch or not. The default
6986 action is to apply the patch. 6985 action is to apply the patch.
@@ -7667,8 +7666,8 @@ system and gives an overview of their function and contents.
7667 :term:`TARGET_OS` 7666 :term:`TARGET_OS`
7668 Specifies the target's operating system. The variable can be set to 7667 Specifies the target's operating system. The variable can be set to
7669 "linux" for glibc-based systems (GNU C Library) and to "linux-musl" 7668 "linux" for glibc-based systems (GNU C Library) and to "linux-musl"
7670 for musl libc. For ARM/EABI targets, "linux-gnueabi" and 7669 for musl libc. For ARM/EABI targets, the possible values are
7671 "linux-musleabi" possible values exist. 7670 "linux-gnueabi" and "linux-musleabi".
7672 7671
7673 :term:`TARGET_PREFIX` 7672 :term:`TARGET_PREFIX`
7674 Specifies the prefix used for the toolchain binary target tools. 7673 Specifies the prefix used for the toolchain binary target tools.
@@ -8369,11 +8368,10 @@ system and gives an overview of their function and contents.
8369 configure options are simply not passed to the configure script (e.g. 8368 configure options are simply not passed to the configure script (e.g.
8370 should be removed from :term:`EXTRA_OECONF` or 8369 should be removed from :term:`EXTRA_OECONF` or
8371 :term:`PACKAGECONFIG_CONFARGS`). 8370 :term:`PACKAGECONFIG_CONFARGS`).
8372 However, common options, for example, exist that are passed to all 8371 However, there are common options that are passed to all
8373 configure scripts at a class level that might not be valid for some 8372 configure scripts at a class level, but might not be valid for some
8374 configure scripts. It follows that no benefit exists in seeing a 8373 configure scripts. Therefore warnings about these options are useless.
8375 warning about these options. For these cases, the options are added 8374 For these cases, the options are added to ``UNKNOWN_CONFIGURE_WHITELIST``.
8376 to ``UNKNOWN_CONFIGURE_WHITELIST``.
8377 8375
8378 The configure arguments check that uses 8376 The configure arguments check that uses
8379 ``UNKNOWN_CONFIGURE_WHITELIST`` is part of the 8377 ``UNKNOWN_CONFIGURE_WHITELIST`` is part of the