summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/faq.rst24
-rw-r--r--documentation/ref-manual/migration-1.3.rst10
-rw-r--r--documentation/ref-manual/migration-1.4.rst6
-rw-r--r--documentation/ref-manual/migration-1.5.rst16
-rw-r--r--documentation/ref-manual/migration-1.6.rst21
-rw-r--r--documentation/ref-manual/migration-1.7.rst12
-rw-r--r--documentation/ref-manual/migration-2.0.rst4
-rw-r--r--documentation/ref-manual/migration-2.1.rst22
-rw-r--r--documentation/ref-manual/migration-2.2.rst15
-rw-r--r--documentation/ref-manual/migration-2.3.rst31
-rw-r--r--documentation/ref-manual/migration-2.5.rst4
-rw-r--r--documentation/ref-manual/migration-2.6.rst49
-rw-r--r--documentation/ref-manual/migration-3.0.rst3
-rw-r--r--documentation/ref-manual/ref-classes.rst143
-rw-r--r--documentation/ref-manual/ref-devtool-reference.rst26
-rw-r--r--documentation/ref-manual/ref-features.rst7
-rw-r--r--documentation/ref-manual/ref-images.rst3
-rw-r--r--documentation/ref-manual/ref-kickstart.rst13
-rw-r--r--documentation/ref-manual/ref-qa-checks.rst5
-rw-r--r--documentation/ref-manual/ref-release-process.rst14
-rw-r--r--documentation/ref-manual/ref-structure.rst55
-rw-r--r--documentation/ref-manual/ref-system-requirements.rst29
-rw-r--r--documentation/ref-manual/ref-tasks.rst63
-rw-r--r--documentation/ref-manual/ref-terms.rst21
-rw-r--r--documentation/ref-manual/ref-variables.rst724
-rw-r--r--documentation/ref-manual/resources.rst26
26 files changed, 509 insertions, 837 deletions
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index 69852824a9..7a1614028a 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -4,7 +4,7 @@
4FAQ 4FAQ
5*** 5***
6 6
7**Q:** How does Poky differ from `OpenEmbedded <http://www.openembedded.org/>`__? 7**Q:** How does Poky differ from :oe_home:`OpenEmbedded <>`?
8 8
9**A:** The term ``Poky`` refers to the specific reference build 9**A:** The term ``Poky`` refers to the specific reference build
10system that the Yocto Project provides. Poky is based on 10system that the Yocto Project provides. Poky is based on
@@ -21,9 +21,9 @@ Can I still use the Yocto Project?
21 21
22**A:** You can get the required tools on your host development system a 22**A:** You can get the required tools on your host development system a
23couple different ways (i.e. building a tarball or downloading a 23couple different ways (i.e. building a tarball or downloading a
24tarball). See the "`Required Git, tar, Python and gcc 24tarball). See the
25Versions <#required-git-tar-python-and-gcc-versions>`__" section for 25":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`"
26steps on how to update your build tools. 26section for steps on how to update your build tools.
27 27
28**Q:** How can you claim Poky / OpenEmbedded-Core is stable? 28**Q:** How can you claim Poky / OpenEmbedded-Core is stable?
29 29
@@ -370,7 +370,7 @@ redirect requests through proxy servers.
370**A:** Yes - you can easily do this. When you use BitBake to build an 370**A:** Yes - you can easily do this. When you use BitBake to build an
371image, all the build output goes into the directory created when you run 371image, all the build output goes into the directory created when you run
372the build environment setup script (i.e. 372the build environment setup script (i.e.
373````` <#structure-core-script>`__). By default, this :term:`Build Directory` 373:ref:`structure-core-script`). By default, this :term:`Build Directory`
374is named ``build`` but can be named 374is named ``build`` but can be named
375anything you want. 375anything you want.
376 376
@@ -414,7 +414,14 @@ that program is never installed directly to the build machine's root
414file system. Consequently, the build system uses paths within the Build 414file system. Consequently, the build system uses paths within the Build
415Directory for ``DESTDIR``, ``bindir`` and related variables. To better 415Directory for ``DESTDIR``, ``bindir`` and related variables. To better
416understand this, consider the following two paths where the first is 416understand this, consider the following two paths where the first is
417relatively normal and the second is not: :: 417relatively normal and the second is not:
418
419.. note::
420
421 Due to these lengthy examples, the paths are artificially broken
422 across lines for readability.
423
424::
418 425
419 /home/maxtothemax/poky-bootchart2/build/tmp/work/i586-poky-linux/zlib/ 426 /home/maxtothemax/poky-bootchart2/build/tmp/work/i586-poky-linux/zlib/
420 1.2.8-r0/sysroot-destdir/usr/bin 427 1.2.8-r0/sysroot-destdir/usr/bin
@@ -423,11 +430,6 @@ relatively normal and the second is not: ::
423 zlib-native/1.2.8-r0/sysroot-destdir/home/maxtothemax/poky-bootchart2/ 430 zlib-native/1.2.8-r0/sysroot-destdir/home/maxtothemax/poky-bootchart2/
424 build/tmp/sysroots/x86_64-linux/usr/bin 431 build/tmp/sysroots/x86_64-linux/usr/bin
425 432
426.. note::
427
428 Due to these lengthy examples, the paths are artificially broken
429 across lines for readability.
430
431Even if the paths look unusual, 433Even if the paths look unusual,
432they both are correct - the first for a target and the second for a 434they both are correct - the first for a target and the second for a
433native recipe. These paths are a consequence of the ``DESTDIR`` 435native recipe. These paths are a consequence of the ``DESTDIR``
diff --git a/documentation/ref-manual/migration-1.3.rst b/documentation/ref-manual/migration-1.3.rst
index 5793f9b6e6..5f975850ba 100644
--- a/documentation/ref-manual/migration-1.3.rst
+++ b/documentation/ref-manual/migration-1.3.rst
@@ -121,11 +121,11 @@ further details.
121IMAGE_FEATURES 121IMAGE_FEATURES
122~~~~~~~~~~~~~~ 122~~~~~~~~~~~~~~
123 123
124Image recipes that previously included "apps-console-core" in 124Image recipes that previously included ``apps-console-core`` in
125:term:`IMAGE_FEATURES` should now include "splash" 125:term:`IMAGE_FEATURES` should now include ``splash``
126instead to enable the boot-up splash screen. Retaining 126instead to enable the boot-up splash screen. Retaining
127"apps-console-core" will still include the splash screen but generates a 127``apps-console-core`` will still include the splash screen but generates a
128warning. The "apps-x11-core" and "apps-x11-games" ``IMAGE_FEATURES`` 128warning. The ``apps-x11-core`` and ``apps-x11-games`` ``IMAGE_FEATURES``
129features have been removed. 129features have been removed.
130 130
131.. _migration-1.3-removed-recipes: 131.. _migration-1.3-removed-recipes:
@@ -173,7 +173,7 @@ the OpenEmbedded community layers such as ``meta-oe`` and
173``meta-gnome``. For the remainder, you can now find them in the 173``meta-gnome``. For the remainder, you can now find them in the
174``meta-extras`` repository, which is in the 174``meta-extras`` repository, which is in the
175:yocto_git:`Source Repositories <>` at 175:yocto_git:`Source Repositories <>` at
176http://git.yoctoproject.org/cgit/cgit.cgi/meta-extras/. 176:yocto_git:`/cgit/cgit.cgi/meta-extras/`.
177 177
178.. _1.3-linux-kernel-naming: 178.. _1.3-linux-kernel-naming:
179 179
diff --git a/documentation/ref-manual/migration-1.4.rst b/documentation/ref-manual/migration-1.4.rst
index a658bdff68..231fc95dac 100644
--- a/documentation/ref-manual/migration-1.4.rst
+++ b/documentation/ref-manual/migration-1.4.rst
@@ -61,7 +61,7 @@ Differences include the following:
61 the :term:`MACHINEOVERRIDES` or 61 the :term:`MACHINEOVERRIDES` or
62 :term:`DISTROOVERRIDES` variables, as 62 :term:`DISTROOVERRIDES` variables, as
63 appropriate. For more related changes, see the 63 appropriate. For more related changes, see the
64 "`Variables <#migration-1.4-variables>`__" section. 64 ":ref:`ref-manual/migration-1.4:variables`" section.
65 65
66.. _migration-1.4-proxies-and-fetching-source: 66.. _migration-1.4-proxies-and-fetching-source:
67 67
@@ -124,8 +124,8 @@ The following variables have changed:
124 :term:`SRC_URI`. If you have a recipe that relied upon 124 :term:`SRC_URI`. If you have a recipe that relied upon
125 these directories, which would be unusual, then you will need to add 125 these directories, which would be unusual, then you will need to add
126 the appropriate paths within the recipe or, alternatively, rearrange 126 the appropriate paths within the recipe or, alternatively, rearrange
127 the files. The most common locations are still covered by ``${BP}``, 127 the files. The most common locations are still covered by ``${``\ :term:`BP`\ ``}``,
128 ``${BPN}``, and "files", which all remain in the default value of 128 ``${``\ :term:`BPN`\ ``}``, and "files", which all remain in the default value of
129 :term:`FILESPATH`. 129 :term:`FILESPATH`.
130 130
131.. _migration-target-package-management-with-rpm: 131.. _migration-target-package-management-with-rpm:
diff --git a/documentation/ref-manual/migration-1.5.rst b/documentation/ref-manual/migration-1.5.rst
index fa6ff92f10..fc7aface9e 100644
--- a/documentation/ref-manual/migration-1.5.rst
+++ b/documentation/ref-manual/migration-1.5.rst
@@ -25,8 +25,8 @@ If the Linux distribution you are using on your build host does not
25provide packages for these, you can install and use the Buildtools 25provide packages for these, you can install and use the Buildtools
26tarball, which provides an SDK-like environment containing them. 26tarball, which provides an SDK-like environment containing them.
27 27
28For more information on this requirement, see the "`Required Git, tar, 28For more information on this requirement, see the
29Python and gcc Versions <#required-git-tar-python-and-gcc-versions>`__" 29":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`"
30section. 30section.
31 31
32.. _migration-1.5-atom-pc-bsp: 32.. _migration-1.5-atom-pc-bsp:
@@ -41,9 +41,8 @@ all x86 hardware, but it will run on a wider range of systems than the
41 41
42.. note:: 42.. note::
43 43
44 Additionally, a 44 Additionally, a ``genericx86-64`` BSP has been added for 64-bit Atom
45 genericx86-64 45 systems.
46 BSP has been added for 64-bit Atom systems.
47 46
48.. _migration-1.5-bitbake: 47.. _migration-1.5-bitbake:
49 48
@@ -96,7 +95,7 @@ The following changes have been made to the package QA checks:
96 this file within :ref:`ref-tasks-install` if "make 95 this file within :ref:`ref-tasks-install` if "make
97 install" is installing it. 96 install" is installing it.
98 97
99- If you are using the buildhistory class, the check for the package 98- If you are using the ``buildhistory`` class, the check for the package
100 version going backwards is now controlled using a standard QA check. 99 version going backwards is now controlled using a standard QA check.
101 Thus, if you have customized your ``ERROR_QA`` or ``WARN_QA`` values 100 Thus, if you have customized your ``ERROR_QA`` or ``WARN_QA`` values
102 and still wish to have this check performed, you should add 101 and still wish to have this check performed, you should add
@@ -299,7 +298,7 @@ Removed and Renamed Recipes
299- ``libtool-nativesdk`` has been renamed to ``nativesdk-libtool``. 298- ``libtool-nativesdk`` has been renamed to ``nativesdk-libtool``.
300 299
301- ``tinylogin`` has been removed. It has been replaced by a suid 300- ``tinylogin`` has been removed. It has been replaced by a suid
302 portion of Busybox. See the "`BusyBox <#migration-1.5-busybox>`__" 301 portion of Busybox. See the "`BusyBox <#busybox>`__"
303 section for more information. 302 section for more information.
304 303
305- ``external-python-tarball`` has been renamed to 304- ``external-python-tarball`` has been renamed to
@@ -345,8 +344,7 @@ Following is a list of short entries describing other changes:
345- ``libpam``: Deny all services for the ``OTHER`` entries. 344- ``libpam``: Deny all services for the ``OTHER`` entries.
346 345
347- ``image.bbclass``: Move ``runtime_mapping_rename`` to avoid conflict 346- ``image.bbclass``: Move ``runtime_mapping_rename`` to avoid conflict
348 with ``multilib``. See 347 with ``multilib``. See :yocto_bugs:`YOCTO #4993 </show_bug.cgi?id=4993>`
349 `YOCTO #4993 <https://bugzilla.yoctoproject.org/show_bug.cgi?id=4993>`_
350 in Bugzilla for more information. 348 in Bugzilla for more information.
351 349
352- ``linux-dtb``: Use kernel build system to generate the ``dtb`` files. 350- ``linux-dtb``: Use kernel build system to generate the ``dtb`` files.
diff --git a/documentation/ref-manual/migration-1.6.rst b/documentation/ref-manual/migration-1.6.rst
index b55be46e55..a6c4c8a93a 100644
--- a/documentation/ref-manual/migration-1.6.rst
+++ b/documentation/ref-manual/migration-1.6.rst
@@ -53,9 +53,12 @@ Matching Branch Requirement for Git Fetching
53When fetching source from a Git repository using 53When fetching source from a Git repository using
54:term:`SRC_URI`, BitBake will now validate the 54:term:`SRC_URI`, BitBake will now validate the
55:term:`SRCREV` value against the branch. You can specify 55:term:`SRCREV` value against the branch. You can specify
56the branch using the following form: SRC_URI = 56the branch using the following form:
57"git://server.name/repository;branch=branchname" If you do not specify a 57::
58branch, BitBake looks in the default "master" branch. 58
59 SRC_URI = "git://server.name/repository;branch=branchname"
60
61If you do not specify a branch, BitBake looks in the default "master" branch.
59 62
60Alternatively, if you need to bypass this check (e.g. if you are 63Alternatively, if you need to bypass this check (e.g. if you are
61fetching a revision corresponding to a tag that is not on any branch), 64fetching a revision corresponding to a tag that is not on any branch),
@@ -123,8 +126,7 @@ Changes to Variables
123-------------------- 126--------------------
124 127
125The following variables have changed. For information on the 128The following variables have changed. For information on the
126OpenEmbedded build system variables, see the "`Variables 129OpenEmbedded build system variables, see the ":doc:`ref-variables`" Chapter.
127Glossary <#ref-variables-glos>`__" Chapter.
128 130
129.. _migration-1.6-variable-changes-TMPDIR: 131.. _migration-1.6-variable-changes-TMPDIR:
130 132
@@ -254,11 +256,8 @@ default. The following additional lines are needed in your
254 256
255.. note:: 257.. note::
256 258
257 The default 259 The default ``local.conf`` contains these statements. Consequently, if you
258 local.conf 260 are building a headless system and using a default ``local.conf``
259 contains these statements. Consequently, if you are building a
260 headless system and using a default
261 local.conf
262 file, you will need comment these two lines out. 261 file, you will need comment these two lines out.
263 262
264.. _migration-1.6-core-image-basic: 263.. _migration-1.6-core-image-basic:
@@ -412,6 +411,6 @@ The previous reference BSPs for the ``beagleboard`` and
412``routerstationpro`` machines are still available in a new 411``routerstationpro`` machines are still available in a new
413``meta-yocto-bsp-old`` layer in the 412``meta-yocto-bsp-old`` layer in the
414:yocto_git:`Source Repositories <>` at 413:yocto_git:`Source Repositories <>` at
415http://git.yoctoproject.org/cgit/cgit.cgi/meta-yocto-bsp-old/. 414:yocto_git:`/cgit/cgit.cgi/meta-yocto-bsp-old/`.
416 415
417 416
diff --git a/documentation/ref-manual/migration-1.7.rst b/documentation/ref-manual/migration-1.7.rst
index 82fd37d3a9..5a5151ec1c 100644
--- a/documentation/ref-manual/migration-1.7.rst
+++ b/documentation/ref-manual/migration-1.7.rst
@@ -31,9 +31,9 @@ version required on the
31build host is now 1.7.8 because the ``--list`` option is now required by 31build host is now 1.7.8 because the ``--list`` option is now required by
32BitBake's Git fetcher. As always, if your host distribution does not 32BitBake's Git fetcher. As always, if your host distribution does not
33provide a version of Git that meets this requirement, you can use the 33provide a version of Git that meets this requirement, you can use the
34``buildtools-tarball`` that does. See the "`Required Git, tar, Python 34``buildtools-tarball`` that does. See the
35and gcc Versions <#required-git-tar-python-and-gcc-versions>`__" section 35":ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`"
36for more information. 36section for more information.
37 37
38.. _migration-1.7-autotools-class-changes: 38.. _migration-1.7-autotools-class-changes:
39 39
@@ -157,7 +157,7 @@ The following changes have occurred to the QA check process:
157 added in order to verify that file dependencies are satisfied (e.g. 157 added in order to verify that file dependencies are satisfied (e.g.
158 package contains a script requiring ``/bin/bash``) and build-time 158 package contains a script requiring ``/bin/bash``) and build-time
159 dependencies are declared, respectively. For more information, please 159 dependencies are declared, respectively. For more information, please
160 see the "`QA Error and Warning Messages <#ref-qa-checks>`__" chapter. 160 see the ":doc:`ref-qa-checks`" chapter.
161 161
162- Package QA checks are now performed during a new 162- Package QA checks are now performed during a new
163 :ref:`ref-tasks-package_qa` task rather than being 163 :ref:`ref-tasks-package_qa` task rather than being
@@ -202,9 +202,7 @@ The following recipes have been removed:
202 for version 3.17 has been added. 202 for version 3.17 has been added.
203 203
204- ``eglibc`` has been removed in favor of ``glibc``. See the 204- ``eglibc`` has been removed in favor of ``glibc``. See the
205 "```eglibc 2.19`` Replaced with 205 ":ref:`migration-1.7-glibc-replaces-eglibc`" section for more information.
206 ``glibc 2.20`` <#migration-1.7-glibc-replaces-eglibc>`__" section for
207 more information.
208 206
209.. _migration-1.7-miscellaneous-changes: 207.. _migration-1.7-miscellaneous-changes:
210 208
diff --git a/documentation/ref-manual/migration-2.0.rst b/documentation/ref-manual/migration-2.0.rst
index 570486ba00..4eea94887b 100644
--- a/documentation/ref-manual/migration-2.0.rst
+++ b/documentation/ref-manual/migration-2.0.rst
@@ -96,8 +96,8 @@ changes in behavior exist:
96 96
97 $ bitbake -e 97 $ bitbake -e
98 98
99- ``d.delVar('``\ VARNAME\ ``')`` and 99- ``d.delVar('VARNAME')`` and
100 ``d.setVar('``\ VARNAME\ ``', None)`` result in the variable and all 100 ``d.setVar('VARNAME', None)`` result in the variable and all
101 of its overrides being cleared out. Before the change, only the 101 of its overrides being cleared out. Before the change, only the
102 non-overridden values were cleared. 102 non-overridden values were cleared.
103 103
diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst
index a1fd3ea81d..0220221e01 100644
--- a/documentation/ref-manual/migration-2.1.rst
+++ b/documentation/ref-manual/migration-2.1.rst
@@ -9,7 +9,7 @@ Project 2.1 Release from the prior release.
9Variable Expansion in Python Functions 9Variable Expansion in Python Functions
10-------------------------------------- 10--------------------------------------
11 11
12Variable expressions, such as ``${``\ VARNAME\ ``}`` no longer expand 12Variable expressions, such as ``${VARNAME}`` no longer expand
13automatically within Python functions. Suppressing expansion was done to 13automatically within Python functions. Suppressing expansion was done to
14allow Python functions to construct shell scripts or other code for 14allow Python functions to construct shell scripts or other code for
15situations in which you do not want such expressions expanded. For any 15situations in which you do not want such expressions expanded. For any
@@ -125,7 +125,7 @@ Image Generation is Now Split Out from Filesystem Generation
125Previously, for image recipes the :ref:`ref-tasks-rootfs` 125Previously, for image recipes the :ref:`ref-tasks-rootfs`
126task assembled the filesystem and then from that filesystem generated 126task assembled the filesystem and then from that filesystem generated
127images. With this Yocto Project release, image generation is split into 127images. With this Yocto Project release, image generation is split into
128separate ```do_image_*`` <#ref-tasks-image>`__ tasks for clarity both in 128separate :ref:`ref-tasks-image` tasks for clarity both in
129operation and in the code. 129operation and in the code.
130 130
131For most cases, this change does not present any problems. However, if 131For most cases, this change does not present any problems. However, if
@@ -133,7 +133,7 @@ you have made customizations that directly modify the ``do_rootfs`` task
133or that mention ``do_rootfs``, you might need to update those changes. 133or that mention ``do_rootfs``, you might need to update those changes.
134In particular, if you had added any tasks after ``do_rootfs``, you 134In particular, if you had added any tasks after ``do_rootfs``, you
135should make edits so that those tasks are after the 135should make edits so that those tasks are after the
136```do_image_complete`` <#ref-tasks-image-complete>`__ task rather than 136:ref:`ref-tasks-image-complete` task rather than
137after ``do_rootfs`` so that the your added tasks run at the correct 137after ``do_rootfs`` so that the your added tasks run at the correct
138time. 138time.
139 139
@@ -180,7 +180,7 @@ The following recipes have been removed in the 2.1 release:
180- ``python-pygtk``: Recipe became obsolete. 180- ``python-pygtk``: Recipe became obsolete.
181 181
182- ``adt-installer``: Recipe became obsolete. See the "`ADT 182- ``adt-installer``: Recipe became obsolete. See the "`ADT
183 Removed <#migration-2.1-adt-removed>`__" section for more 183 Removed <#adt-removed>`__" section for more
184 information. 184 information.
185 185
186.. _migration-2.1-class-changes: 186.. _migration-2.1-class-changes:
@@ -287,7 +287,9 @@ The following changes have been made for the Poky distribution:
287 option specified on the configure command line either because it is 287 option specified on the configure command line either because it is
288 not a supported option for the configure script or because static 288 not a supported option for the configure script or because static
289 libraries are needed should set the following variable: 289 libraries are needed should set the following variable:
290 DISABLE_STATIC = "" 290 ::
291
292 DISABLE_STATIC = ""
291 293
292- The separate ``poky-tiny`` distribution now uses the musl C library 294- The separate ``poky-tiny`` distribution now uses the musl C library
293 instead of a heavily pared down ``glibc``. Using musl results in a 295 instead of a heavily pared down ``glibc``. Using musl results in a
@@ -357,10 +359,9 @@ These additional changes exist:
357 359
358- The minimum Git version has been increased to 1.8.3.1. If your host 360- The minimum Git version has been increased to 1.8.3.1. If your host
359 distribution does not provide a sufficiently recent version, you can 361 distribution does not provide a sufficiently recent version, you can
360 install the buildtools, which will provide it. See the "`Required 362 install the buildtools, which will provide it. See the
361 Git, tar, Python and gcc 363 :ref:`ref-manual/ref-system-requirements:required git, tar, python and gcc versions`
362 Versions <#required-git-tar-python-and-gcc-versions>`__" section for 364 section for more information on the buildtools tarball.
363 more information on the buildtools tarball.
364 365
365- The buggy and incomplete support for the RPM version 4 package 366- The buggy and incomplete support for the RPM version 4 package
366 manager has been removed. The well-tested and maintained support for 367 manager has been removed. The well-tested and maintained support for
@@ -376,8 +377,9 @@ These additional changes exist:
376 base-passwd 377 base-passwd
377 shadow 378 shadow
378 update-alternatives 379 update-alternatives
380 run-postinsts
379 381
380 run-postinsts With the Yocto Project 2.1 release, these packages are 382 With the Yocto Project 2.1 release, these packages are
381 only removed if "read-only-rootfs" is in ``IMAGE_FEATURES``, since 383 only removed if "read-only-rootfs" is in ``IMAGE_FEATURES``, since
382 they might still be needed for a read-write image even in the absence 384 they might still be needed for a read-write image even in the absence
383 of a package manager (e.g. if users need to be added, modified, or 385 of a package manager (e.g. if users need to be added, modified, or
diff --git a/documentation/ref-manual/migration-2.2.rst b/documentation/ref-manual/migration-2.2.rst
index 59d0eeeb9d..8afa8ffdda 100644
--- a/documentation/ref-manual/migration-2.2.rst
+++ b/documentation/ref-manual/migration-2.2.rst
@@ -16,8 +16,7 @@ the minimum kernel version is 3.19.
16 16
17.. note:: 17.. note::
18 18
19 For x86 and x86_64, you can reset 19 For x86 and x86_64, you can reset :term:`OLDEST_KERNEL`
20 OLDEST_KERNEL
21 to anything down to 2.6.32 if desired. 20 to anything down to 2.6.32 if desired.
22 21
23.. _migration-2.2-staging-directories-in-sysroot-simplified: 22.. _migration-2.2-staging-directories-in-sysroot-simplified:
@@ -79,7 +78,9 @@ particular areas of interest:
79 78
80 - the syntax for octal values changed 79 - the syntax for octal values changed
81 80
82 - the ``iter*()`` functions changed name \* iterators now return views, not lists 81 - the ``iter*()`` functions changed name
82
83 - iterators now return views, not lists
83 84
84 - changed names for Python modules 85 - changed names for Python modules
85 86
@@ -224,9 +225,7 @@ follows and run ``runqemu``:
224 225
225.. note:: 226.. note::
226 227
227 For command-line syntax, use 228 For command-line syntax, use ``runqemu help``.
228 runqemu help
229 .
230 229
231:: 230::
232 231
@@ -369,7 +368,7 @@ The following recipes have been removed:
369- ``sato-icon-theme``: Became obsolete. 368- ``sato-icon-theme``: Became obsolete.
370 369
371- ``swabber-native``: Swabber has been removed. See the `entry on 370- ``swabber-native``: Swabber has been removed. See the `entry on
372 Swabber <#migration-2.2-swabber-has-been-removed>`__. 371 Swabber <#swabber-has-been-removed>`__.
373 372
374- ``tslib``: No longer needed and has been moved to ``meta-oe``. 373- ``tslib``: No longer needed and has been moved to ``meta-oe``.
375 374
@@ -395,7 +394,7 @@ The following classes have been removed:
395- ``sip``: Mostly unused. 394- ``sip``: Mostly unused.
396 395
397- ``swabber``: See the `entry on 396- ``swabber``: See the `entry on
398 Swabber <#migration-2.2-swabber-has-been-removed>`__. 397 Swabber <#swabber-has-been-removed>`__.
399 398
400.. _migration-2.2-minor-packaging-changes: 399.. _migration-2.2-minor-packaging-changes:
401 400
diff --git a/documentation/ref-manual/migration-2.3.rst b/documentation/ref-manual/migration-2.3.rst
index 7f34f0cd75..60e4b2e453 100644
--- a/documentation/ref-manual/migration-2.3.rst
+++ b/documentation/ref-manual/migration-2.3.rst
@@ -76,9 +76,7 @@ Consider the following:
76.. note:: 76.. note::
77 77
78 You can find more information on how recipe-specific sysroots work in 78 You can find more information on how recipe-specific sysroots work in
79 the " 79 the ":ref:`ref-classes-staging`" section.
80 staging.bbclass
81 " section.
82 80
83.. _migration-2.3-path-variable: 81.. _migration-2.3-path-variable:
84 82
@@ -104,9 +102,8 @@ value.
104.. note:: 102.. note::
105 103
106 PATH 104 PATH
107 is not sanitized in the same way within 105 is not sanitized in the same way within ``devshell``.
108 devshell 106 If it were, you would have difficulty running host tools for
109 . If it were, you would have difficulty running host tools for
110 development and debugging within the shell. 107 development and debugging within the shell.
111 108
112.. _migration-2.3-scripts: 109.. _migration-2.3-scripts:
@@ -240,10 +237,8 @@ to substitute a GPLv2 version of a GPLv3 recipe, then you must add the
240 237
241.. note:: 238.. note::
242 239
243 You can find 240 You can ``find meta-gplv2`` layer in the OpenEmbedded layer index at
244 meta-gplv2 241 https://layers.openembedded.org/layerindex/branch/master/layer/meta-gplv2/.
245 layer in the OpenEmbedded layer index at
246 .
247 242
248These relocated GPLv2 recipes do not receive the same level of 243These relocated GPLv2 recipes do not receive the same level of
249maintenance as other core recipes. The recipes do not get security fixes 244maintenance as other core recipes. The recipes do not get security fixes
@@ -316,8 +311,7 @@ The following package management changes took place:
316 311
317- Signing of remote package feeds using ``PACKAGE_FEED_SIGN`` is not 312- Signing of remote package feeds using ``PACKAGE_FEED_SIGN`` is not
318 currently supported. This issue will be fully addressed in a future 313 currently supported. This issue will be fully addressed in a future
319 Yocto Project release. See `defect 314 Yocto Project release. See :yocto_bugs:`defect 11209 </show_bug.cgi?id=11209>`
320 11209 <https://bugzilla.yoctoproject.org/show_bug.cgi?id=11209>`__
321 for more information on a solution to package feed signing with RPM 315 for more information on a solution to package feed signing with RPM
322 in the Yocto Project 2.3 release. 316 in the Yocto Project 2.3 release.
323 317
@@ -329,8 +323,7 @@ The following package management changes took place:
329 .. note:: 323 .. note::
330 324
331 For further details on this change, see the 325 For further details on this change, see the
332 commit message 326 :yocto_git:`commit message </cgit/cgit.cgi/poky/commit/?id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81>`.
333 .
334 327
335.. _migration-2.3-removed-recipes: 328.. _migration-2.3-removed-recipes:
336 329
@@ -372,9 +365,9 @@ The following changes have been made to Wic:
372 365
373.. note:: 366.. note::
374 367
375 For more information on Wic, see the " 368 For more information on Wic, see the
376 Creating Partitioned Images Using Wic 369 ":ref:`dev-manual/dev-manual-common-tasks:creating partitioned images using wic`"
377 " section in the Yocto Project Development Tasks Manual. 370 section in the Yocto Project Development Tasks Manual.
378 371
379- *Default Output Directory Changed:* Wic's default output directory is 372- *Default Output Directory Changed:* Wic's default output directory is
380 now the current directory by default instead of the unusual 373 now the current directory by default instead of the unusual
@@ -410,8 +403,8 @@ The following QA checks have changed:
410 warning, you need to address missing runtime dependencies. 403 warning, you need to address missing runtime dependencies.
411 404
412 For additional information, see the 405 For additional information, see the
413 :ref:`insane <ref-classes-insane>` class and the "`Errors and 406 :ref:`insane <ref-classes-insane>` class and the
414 Warnings <#qa-errors-and-warnings>`__" section. 407 ":ref:`ref-manual/ref-qa-checks:errors and warnings`" section.
415 408
416.. _migration-2.3-miscellaneous-changes: 409.. _migration-2.3-miscellaneous-changes:
417 410
diff --git a/documentation/ref-manual/migration-2.5.rst b/documentation/ref-manual/migration-2.5.rst
index a2adc17757..1aeddc81c3 100644
--- a/documentation/ref-manual/migration-2.5.rst
+++ b/documentation/ref-manual/migration-2.5.rst
@@ -179,8 +179,8 @@ or ::
179 179
180The earlier build-time provides behavior was a quirk of the 180The earlier build-time provides behavior was a quirk of the
181way the Python manifest file was created. For more information on this 181way the Python manifest file was created. For more information on this
182change please see `this 182change please see :yocto_git:`this commit
183commit <http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=8d94b9db221d1def42f091b991903faa2d1651ce>`__. 183</cgit/cgit.cgi/poky/commit/?id=8d94b9db221d1def42f091b991903faa2d1651ce>`.
184 184
185.. _migration-2.5-miscellaneous-changes: 185.. _migration-2.5-miscellaneous-changes:
186 186
diff --git a/documentation/ref-manual/migration-2.6.rst b/documentation/ref-manual/migration-2.6.rst
index f16aaaa975..2f0da48ab6 100644
--- a/documentation/ref-manual/migration-2.6.rst
+++ b/documentation/ref-manual/migration-2.6.rst
@@ -110,7 +110,7 @@ upon the older ``*proto`` recipes need to be changed to depend on the
110newer ``xorgproto`` recipe instead. 110newer ``xorgproto`` recipe instead.
111 111
112For names of recipes removed because of this repository change, see the 112For names of recipes removed because of this repository change, see the
113`Removed Recipes <#migration-2.6-removed-recipes>`__ section. 113`Removed Recipes <#removed-recipes>`__ section.
114 114
115.. _migration-2.6-distutils-distutils3-fetching-dependencies: 115.. _migration-2.6-distutils-distutils3-fetching-dependencies:
116 116
@@ -128,18 +128,9 @@ missing from :term:`DEPENDS`).
128.. note:: 128.. note::
129 129
130 This change affects classes beyond just the two mentioned (i.e. 130 This change affects classes beyond just the two mentioned (i.e.
131 distutils 131 ``distutils`` and ``distutils3``). Any recipe that inherits ``distutils*``
132 and 132 classes are affected. For example, the ``setuptools`` and ``setuptools3``
133 distutils3 133 recipes are affected since they inherit the ``distutils*`` classes.
134 ). Any recipe that inherits
135 distutils\*
136 classes are affected. For example, the
137 setuptools
138 and
139 setuptools3
140 recipes are affected since they inherit the
141 distutils\*
142 classes.
143 134
144Fetching these types of dependencies that are not provided in the 135Fetching these types of dependencies that are not provided in the
145sysroot negatively affects the ability to reproduce builds. This type of 136sysroot negatively affects the ability to reproduce builds. This type of
@@ -178,13 +169,13 @@ The following changes have been made:
178- Several variables have changed names for consistency: 169- Several variables have changed names for consistency:
179 :: 170 ::
180 171
181 Old Variable Name New Variable Name 172 Old Variable Name New Variable Name
182 ======================================================== 173 ========================================================
183 KERNEL_IMAGE_BASE_NAME :term:`KERNEL_IMAGE_NAME` 174 KERNEL_IMAGE_BASE_NAME KERNEL_IMAGE_NAME
184 KERNEL_IMAGE_SYMLINK_NAME :term:`KERNEL_IMAGE_LINK_NAME` 175 KERNEL_IMAGE_SYMLINK_NAME KERNEL_IMAGE_LINK_NAME
185 MODULE_TARBALL_BASE_NAME :term:`MODULE_TARBALL_NAME` 176 MODULE_TARBALL_BASE_NAME MODULE_TARBALL_NAME
186 MODULE_TARBALL_SYMLINK_NAME :term:`MODULE_TARBALL_LINK_NAME` 177 MODULE_TARBALL_SYMLINK_NAME MODULE_TARBALL_LINK_NAME
187 INITRAMFS_BASE_NAME :term:`INITRAMFS_NAME` 178 INITRAMFS_BASE_NAME INITRAMFS_NAME
188 179
189- The ``MODULE_IMAGE_BASE_NAME`` variable has been removed. The module 180- The ``MODULE_IMAGE_BASE_NAME`` variable has been removed. The module
190 tarball name is now controlled directly with the 181 tarball name is now controlled directly with the
@@ -233,11 +224,9 @@ you replace all instances of ``SERIAL_CONSOLE`` with
233 224
234.. note:: 225.. note::
235 226
236 The only difference in usage is that 227 The only difference in usage is that ``SERIAL_CONSOLES``
237 SERIAL_CONSOLES
238 expects entries to be separated using semicolons as compared to 228 expects entries to be separated using semicolons as compared to
239 SERIAL_CONSOLE 229 ``SERIAL_CONSOLE``, which expects spaces.
240 , which expects spaces.
241 230
242.. _migration-2.6-poky-sets-unknown-configure-option-to-qa-error: 231.. _migration-2.6-poky-sets-unknown-configure-option-to-qa-error:
243 232
@@ -263,9 +252,7 @@ The following changes have occurred:
263 252
264 .. note:: 253 .. note::
265 254
266 The 255 The ``virtclass-multilib-`` overrides for multilib are still valid.
267 virtclass-multilib-
268 overrides for multilib are still valid.
269 256
270- The ``forcevariable`` Override Now Has a Higher Priority Than 257- The ``forcevariable`` Override Now Has a Higher Priority Than
271 ``libc`` Overrides: The ``forcevariable`` override is documented to 258 ``libc`` Overrides: The ``forcevariable`` override is documented to
@@ -447,14 +434,8 @@ The following miscellaneous changes occurred:
447 434
448 .. note:: 435 .. note::
449 436
450 genericx86 437 ``genericx86`` and ``genericx86-64`` retain ``kernel-modules`` as part of
451 and 438 the ``RRECOMMENDS`` variable setting.
452 genericx86-64
453 retain
454 kernel-modules
455 as part of the
456 RRECOMMENDS
457 variable setting.
458 439
459- The ``LGPLv2_WHITELIST_GPL-3.0`` variable has been removed. If you 440- The ``LGPLv2_WHITELIST_GPL-3.0`` variable has been removed. If you
460 are setting this variable in your configuration, set or append it to 441 are setting this variable in your configuration, set or append it to
diff --git a/documentation/ref-manual/migration-3.0.rst b/documentation/ref-manual/migration-3.0.rst
index e1305dfccf..047b75526f 100644
--- a/documentation/ref-manual/migration-3.0.rst
+++ b/documentation/ref-manual/migration-3.0.rst
@@ -197,8 +197,7 @@ The following BitBake changes have occurred.
197- The arguments passed to functions used with 197- The arguments passed to functions used with
198 :term:`bitbake:BB_HASHCHECK_FUNCTION` 198 :term:`bitbake:BB_HASHCHECK_FUNCTION`
199 have changed. If you are using your own custom hash check function, 199 have changed. If you are using your own custom hash check function,
200 see 200 see :yocto_git:`/cgit/cgit.cgi/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725`
201 http://git.yoctoproject.org/cgit/cgit.cgi/poky/commit/?id=40a5e193c4ba45c928fccd899415ea56b5417725
202 for details. 201 for details.
203 202
204- Task specifications in ``BB_TASKDEPDATA`` and class implementations 203- Task specifications in ``BB_TASKDEPDATA`` and class implementations
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst
index 7277c6bb9d..21c7aab118 100644
--- a/documentation/ref-manual/ref-classes.rst
+++ b/documentation/ref-manual/ref-classes.rst
@@ -47,7 +47,7 @@ splitting out of debug symbols during packaging).
47 even if the recipes do not produce architecture-specific output. 47 even if the recipes do not produce architecture-specific output.
48 48
49 Configuring such recipes for all architectures causes the 49 Configuring such recipes for all architectures causes the
50 ```do_package_write_*`` tasks to 50 ``do_package_write_*`` tasks to
51 have different signatures for the machines with different tunings. 51 have different signatures for the machines with different tunings.
52 Additionally, unnecessary rebuilds occur every time an image for a 52 Additionally, unnecessary rebuilds occur every time an image for a
53 different ``MACHINE`` is built even when the recipe never changes. 53 different ``MACHINE`` is built even when the recipe never changes.
@@ -164,24 +164,18 @@ example use for this class.
164 164
165 For RPMs and other packages that do not contain a subdirectory, you 165 For RPMs and other packages that do not contain a subdirectory, you
166 should specify an appropriate fetcher parameter to point to the 166 should specify an appropriate fetcher parameter to point to the
167 subdirectory. For example, if BitBake is using the Git fetcher ( 167 subdirectory. For example, if BitBake is using the Git fetcher (``git://``),
168 git:// 168 the "subpath" parameter limits the checkout to a specific subpath
169 ), the "subpath" parameter limits the checkout to a specific subpath 169 of the tree. Here is an example where ``${BP}`` is used so that the files
170 of the tree. Here is an example where 170 are extracted into the subdirectory expected by the default value of
171 ${BP} 171 ``S``:
172 is used so that the files are extracted into the subdirectory
173 expected by the default value of
174 S
175 :
176 :: 172 ::
177 173
178 SRC_URI = "git://example.com/downloads/somepackage.rpm;subpath=${BP}" 174 SRC_URI = "git://example.com/downloads/somepackage.rpm;subpath=${BP}"
179 175
180 176
181 See the " 177 See the ":ref:`bitbake-user-manual/bitbake-user-manual-fetching:fetchers`" section in the BitBake User Manual for
182 Fetchers 178 more information on supported BitBake Fetchers.
183 " section in the BitBake User Manual for more information on
184 supported BitBake Fetchers.
185 179
186.. _ref-classes-binconfig: 180.. _ref-classes-binconfig:
187 181
@@ -736,11 +730,8 @@ introspection. This functionality is only enabled if the
736.. note:: 730.. note::
737 731
738 This functionality is backfilled by default and, if not applicable, 732 This functionality is backfilled by default and, if not applicable,
739 should be disabled through 733 should be disabled through ``DISTRO_FEATURES_BACKFILL_CONSIDERED`` or
740 DISTRO_FEATURES_BACKFILL_CONSIDERED 734 ``MACHINE_FEATURES_BACKFILL_CONSIDERED``, respectively.
741 or
742 MACHINE_FEATURES_BACKFILL_CONSIDERED
743 , respectively.
744 735
745.. _ref-classes-grub-efi: 736.. _ref-classes-grub-efi:
746 737
@@ -969,9 +960,8 @@ The ``image_types`` class also handles conversion and compression of images.
969.. note:: 960.. note::
970 961
971 To build a VMware VMDK image, you need to add "wic.vmdk" to 962 To build a VMware VMDK image, you need to add "wic.vmdk" to
972 IMAGE_FSTYPES 963 ``IMAGE_FSTYPES``. This would also be similar for Virtual Box Virtual Disk
973 . This would also be similar for Virtual Box Virtual Disk Image 964 Image ("vdi") and QEMU Copy On Write Version 2 ("qcow2") images.
974 ("vdi") and QEMU Copy On Write Version 2 ("qcow2") images.
975 965
976.. _ref-classes-image-live: 966.. _ref-classes-image-live:
977 967
@@ -1032,9 +1022,8 @@ You can configure the sanity checks so that specific test failures
1032either raise a warning or an error message. Typically, failures for new 1022either raise a warning or an error message. Typically, failures for new
1033tests generate a warning. Subsequent failures for the same test would 1023tests generate a warning. Subsequent failures for the same test would
1034then generate an error message once the metadata is in a known and good 1024then generate an error message once the metadata is in a known and good
1035condition. See the "`QA Error and Warning Messages <#ref-qa-checks>`__" 1025condition. See the ":doc:`ref-qa-checks`" Chapter for a list of all the warning
1036Chapter for a list of all the warning and error messages you might 1026and error messages you might encounter using a default configuration.
1037encounter using a default configuration.
1038 1027
1039Use the :term:`WARN_QA` and 1028Use the :term:`WARN_QA` and
1040:term:`ERROR_QA` variables to control the behavior of 1029:term:`ERROR_QA` variables to control the behavior of
@@ -1275,9 +1264,9 @@ The following list shows the tests you can list with the ``WARN_QA`` and
1275 1264
1276- ``textrel:`` Checks for ELF binaries that contain relocations in 1265- ``textrel:`` Checks for ELF binaries that contain relocations in
1277 their ``.text`` sections, which can result in a performance impact at 1266 their ``.text`` sections, which can result in a performance impact at
1278 runtime. See the explanation for the 1267 runtime. See the explanation for the ``ELF binary`` message in
1279 ```ELF binary`` <#qa-issue-textrel>`__ message for more information 1268 ":doc:`ref-qa-checks`" for more information regarding runtime performance
1280 regarding runtime performance issues. 1269 issues.
1281 1270
1282- ``unlisted-pkg-lics:`` Checks that all declared licenses applying 1271- ``unlisted-pkg-lics:`` Checks that all declared licenses applying
1283 for a package are also declared on the recipe level (i.e. any license 1272 for a package are also declared on the recipe level (i.e. any license
@@ -1629,8 +1618,8 @@ section in the Yocto Project Development Tasks Manual.
1629================== 1618==================
1630 1619
1631The ``native`` class provides common functionality for recipes that 1620The ``native`` class provides common functionality for recipes that
1632build tools to run on the `build host <#hardware-build-system-term>`__ 1621build tools to run on the :term:`Build Host` (i.e. tools that use the compiler
1633(i.e. tools that use the compiler or other tools from the build host). 1622or other tools from the build host).
1634 1623
1635You can create a recipe that builds tools that run natively on the host 1624You can create a recipe that builds tools that run natively on the host
1636a couple different ways: 1625a couple different ways:
@@ -1728,8 +1717,7 @@ package manager (NPM) <https://en.wikipedia.org/wiki/Npm_(software)>`__.
1728 1717
1729.. note:: 1718.. note::
1730 1719
1731 Currently, recipes inheriting this class must use the 1720 Currently, recipes inheriting this class must use the ``npm://``
1732 npm://
1733 fetcher to have dependencies fetched and packaged automatically. 1721 fetcher to have dependencies fetched and packaged automatically.
1734 1722
1735For information on how to create NPM packages, see the 1723For information on how to create NPM packages, see the
@@ -1833,9 +1821,9 @@ consider some further things about using RPM:
1833You can find additional information on the effects of the package class 1821You can find additional information on the effects of the package class
1834at these two Yocto Project mailing list links: 1822at these two Yocto Project mailing list links:
1835 1823
1836- https://lists.yoctoproject.org/pipermail/poky/2011-May/006362.html 1824- :yocto_lists:`/pipermail/poky/2011-May/006362.html`
1837 1825
1838- https://lists.yoctoproject.org/pipermail/poky/2011-May/006363.html 1826- :yocto_lists:`/pipermail/poky/2011-May/006363.html`
1839 1827
1840.. _ref-classes-package_deb: 1828.. _ref-classes-package_deb:
1841 1829
@@ -1894,16 +1882,8 @@ variable in the ``local.conf`` file.
1894 1882
1895.. note:: 1883.. note::
1896 1884
1897 You cannot specify the 1885 You cannot specify the ``package_tar`` class first using the
1898 package_tar 1886 ``PACKAGE_CLASSES`` variable. You must use ``.deb``, ``.ipk``, or ``.rpm``
1899 class first using the
1900 PACKAGE_CLASSES
1901 variable. You must use
1902 .deb
1903 ,
1904 .ipk
1905 , or
1906 .rpm
1907 file formats for your image or SDK. 1887 file formats for your image or SDK.
1908 1888
1909.. _ref-classes-packagedata: 1889.. _ref-classes-packagedata:
@@ -2068,9 +2048,7 @@ The ``prexport`` class provides functionality for exporting
2068.. note:: 2048.. note::
2069 2049
2070 This class is not intended to be used directly. Rather, it is enabled 2050 This class is not intended to be used directly. Rather, it is enabled
2071 when using " 2051 when using "``bitbake-prserv-tool export``".
2072 bitbake-prserv-tool export
2073 ".
2074 2052
2075.. _ref-classes-primport: 2053.. _ref-classes-primport:
2076 2054
@@ -2083,9 +2061,7 @@ The ``primport`` class provides functionality for importing
2083.. note:: 2061.. note::
2084 2062
2085 This class is not intended to be used directly. Rather, it is enabled 2063 This class is not intended to be used directly. Rather, it is enabled
2086 when using " 2064 when using "``bitbake-prserv-tool import``".
2087 bitbake-prserv-tool import
2088 ".
2089 2065
2090.. _ref-classes-prserv: 2066.. _ref-classes-prserv:
2091 2067
@@ -2204,9 +2180,7 @@ override the removal by setting ``REMOVE_LIBTOOL_LA`` to "0" as follows:
2204 2180
2205.. note:: 2181.. note::
2206 2182
2207 The 2183 The ``remove-libtool`` class is not enabled by default.
2208 remove-libtool
2209 class is not enabled by default.
2210 2184
2211.. _ref-classes-report-error: 2185.. _ref-classes-report-error:
2212 2186
@@ -2429,13 +2403,12 @@ stages:
2429 .. note:: 2403 .. note::
2430 2404
2431 Additionally, a recipe can customize the files further by 2405 Additionally, a recipe can customize the files further by
2432 declaring a processing function in the 2406 declaring a processing function in the ``SYSROOT_PREPROCESS_FUNCS``
2433 SYSROOT_PREPROCESS_FUNCS
2434 variable. 2407 variable.
2435 2408
2436 A shared state (sstate) object is built from these files and the 2409 A shared state (sstate) object is built from these files and the
2437 files are placed into a subdirectory of 2410 files are placed into a subdirectory of
2438 ```tmp/sysroots-components/`` <#structure-build-tmp-sysroots-components>`__. 2411 :ref:`structure-build-tmp-sysroots-components`.
2439 The files are scanned for hardcoded paths to the original 2412 The files are scanned for hardcoded paths to the original
2440 installation location. If the location is found in text files, the 2413 installation location. If the location is found in text files, the
2441 hardcoded locations are replaced by tokens and a list of the files 2414 hardcoded locations are replaced by tokens and a list of the files
@@ -2584,13 +2557,8 @@ internal class and is not intended to be used directly.
2584 2557
2585.. note:: 2558.. note::
2586 2559
2587 The 2560 The ``systemd-boot`` class is a result from merging the ``gummiboot`` class
2588 systemd-boot 2561 used in previous Yocto Project releases with the ``systemd`` project.
2589 class is a result from merging the
2590 gummiboot
2591 class used in previous Yocto Project releases with the
2592 systemd
2593 project.
2594 2562
2595Set the :term:`EFI_PROVIDER` variable to 2563Set the :term:`EFI_PROVIDER` variable to
2596"systemd-boot" to use this class. Doing so creates a standalone EFI 2564"systemd-boot" to use this class. Doing so creates a standalone EFI
@@ -2634,13 +2602,9 @@ steps to set up the environment.
2634 2602
2635.. note:: 2603.. note::
2636 2604
2637 Best practices include using 2605 Best practices include using :term:`IMAGE_CLASSES` rather than
2638 IMAGE_CLASSES 2606 :term:`INHERIT` to inherit the ``testimage`` class for automated image
2639 rather than 2607 testing.
2640 INHERIT
2641 to inherit the
2642 testimage
2643 class for automated image testing.
2644 2608
2645The tests are commands that run on the target system over ``ssh``. Each 2609The tests are commands that run on the target system over ``ssh``. Each
2646test is written in Python and makes use of the ``unittest`` module. 2610test is written in Python and makes use of the ``unittest`` module.
@@ -2673,13 +2637,9 @@ using the following:
2673 2637
2674.. note:: 2638.. note::
2675 2639
2676 Best practices include using 2640 Best practices include using :term:`IMAGE_CLASSES` rather than
2677 IMAGE_CLASSES 2641 :term:`INHERIT` to inherit the ``testsdk`` class for automated SDK
2678 rather than 2642 testing.
2679 INHERIT
2680 to inherit the
2681 testsdk
2682 class for automated SDK testing.
2683 2643
2684.. _ref-classes-texinfo: 2644.. _ref-classes-texinfo:
2685 2645
@@ -2696,11 +2656,8 @@ host system.
2696.. note:: 2656.. note::
2697 2657
2698 If you want to use the Texinfo recipe shipped with the build system, 2658 If you want to use the Texinfo recipe shipped with the build system,
2699 you can remove "texinfo-native" from 2659 you can remove "texinfo-native" from :term:`ASSUME_PROVIDED` and makeinfo
2700 ASSUME_PROVIDED 2660 from :term:`SANITY_REQUIRED_UTILITIES`.
2701 and makeinfo from
2702 SANITY_REQUIRED_UTILITIES
2703 .
2704 2661
2705.. _ref-classes-tinderclient: 2662.. _ref-classes-tinderclient:
2706 2663
@@ -2823,10 +2780,8 @@ file.
2823 2780
2824.. note:: 2781.. note::
2825 2782
2826 You can use the 2783 You can use the ``update-alternatives`` command directly in your recipes.
2827 update-alternatives 2784 However, this class simplifies things in most cases.
2828 command directly in your recipes. However, this class simplifies
2829 things in most cases.
2830 2785
2831.. _ref-classes-update-rc.d: 2786.. _ref-classes-update-rc.d:
2832 2787
@@ -2892,18 +2847,10 @@ additional information.
2892 2847
2893.. note:: 2848.. note::
2894 2849
2895 You do not use the 2850 You do not use the ``useradd-staticids`` class directly. You either enable
2896 useradd-staticids 2851 or disable the class by setting the ``USERADDEXTENSION`` variable. If you
2897 class directly. You either enable or disable the class by setting the 2852 enable or disable the class in a configured system, :term:`TMPDIR` might
2898 USERADDEXTENSION 2853 contain incorrect ``uid`` and ``gid`` values. Deleting the ``TMPDIR``
2899 variable. If you enable or disable the class in a configured system,
2900 TMPDIR
2901 might contain incorrect
2902 uid
2903 and
2904 gid
2905 values. Deleting the
2906 TMPDIR
2907 directory will correct this condition. 2854 directory will correct this condition.
2908 2855
2909.. _ref-classes-utility-tasks: 2856.. _ref-classes-utility-tasks:
diff --git a/documentation/ref-manual/ref-devtool-reference.rst b/documentation/ref-manual/ref-devtool-reference.rst
index 1fe8997f55..9b9ddf53f5 100644
--- a/documentation/ref-manual/ref-devtool-reference.rst
+++ b/documentation/ref-manual/ref-devtool-reference.rst
@@ -131,7 +131,7 @@ The following figure shows the workspace structure:
131 :align: center 131 :align: center
132 :scale: 70% 132 :scale: 70%
133 133
134:: 134.. code-block:: none
135 135
136 attic - A directory created if devtool believes it must preserve 136 attic - A directory created if devtool believes it must preserve
137 anything when you run "devtool reset". For example, if you 137 anything when you run "devtool reset". For example, if you
@@ -223,7 +223,7 @@ specify these options when using the ``devtool add`` command:
223.. note:: 223.. note::
224 224
225 If you prefer to use the latest revision every time the recipe is 225 If you prefer to use the latest revision every time the recipe is
226 built, use the options --autorev or -a. 226 built, use the options ``--autorev`` or ``-a``.
227 227
228.. _devtool-extracting-the-source-for-an-existing-recipe: 228.. _devtool-extracting-the-source-for-an-existing-recipe:
229 229
@@ -261,7 +261,7 @@ Modifying an Existing Recipe
261 261
262Use the ``devtool modify`` command to begin modifying the source of an 262Use the ``devtool modify`` command to begin modifying the source of an
263existing recipe. This command is very similar to the 263existing recipe. This command is very similar to the
264```add`` <#devtool-adding-a-new-recipe-to-the-workspace>`__ command 264:ref:`add <devtool-adding-a-new-recipe-to-the-workspace>` command
265except that it does not physically create the recipe in the workspace 265except that it does not physically create the recipe in the workspace
266layer because the recipe already exists in an another layer. 266layer because the recipe already exists in an another layer.
267 267
@@ -303,7 +303,7 @@ Updating a Recipe
303Use the ``devtool update-recipe`` command to update your recipe with 303Use the ``devtool update-recipe`` command to update your recipe with
304patches that reflect changes you make to the source files. For example, 304patches that reflect changes you make to the source files. For example,
305if you know you are going to work on some code, you could first use the 305if you know you are going to work on some code, you could first use the
306```devtool modify`` <#devtool-modifying-a-recipe>`__ command to extract 306:ref:`devtool modify <devtool-modifying-a-recipe>` command to extract
307the code and set up the workspace. After which, you could modify, 307the code and set up the workspace. After which, you could modify,
308compile, and test the code. 308compile, and test the code.
309 309
@@ -386,15 +386,21 @@ satisfied.
386.. note:: 386.. note::
387 387
388 When a reason for not upgrading displays, the reason is usually 388 When a reason for not upgrading displays, the reason is usually
389 written into the recipe using the RECIPE_NO_UPDATE_REASON 389 written into the recipe using the ``RECIPE_NO_UPDATE_REASON``
390 variable. See the base-passwd.bb recipe for an example. 390 variable. See the
391 :yocto_git:`base-passwd.bb </cgit/cgit.cgi/poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>`
392 recipe for an example.
391 393
392:: 394::
393 395
394 $ devtool check-upgrade-status ... 396 $ devtool check-upgrade-status
397 ...
395 NOTE: acpid 2.0.30 2.0.31 Ross Burton <ross.burton@intel.com> 398 NOTE: acpid 2.0.30 2.0.31 Ross Burton <ross.burton@intel.com>
396 NOTE: u-boot-fw-utils 2018.11 2019.01 Marek Vasut <marek.vasut@gmail.com> d3689267f92c5956e09cc7d1baa4700141662bff 399 NOTE: u-boot-fw-utils 2018.11 2019.01 Marek Vasut <marek.vasut@gmail.com> d3689267f92c5956e09cc7d1baa4700141662bff
397 NOTE: u-boot-tools 2018.11 2019.01 Marek Vasut <marek.vasut@gmail.com> d3689267f92c5956e09cc7d1baa4700141662bff . . . 400 NOTE: u-boot-tools 2018.11 2019.01 Marek Vasut <marek.vasut@gmail.com> d3689267f92c5956e09cc7d1baa4700141662bff
401 .
402 .
403 .
398 NOTE: base-passwd 3.5.29 3.5.45 Anuj Mittal <anuj.mittal@intel.com> cannot be updated due to: Version 3.5.38 requires cdebconf for update-passwd utility 404 NOTE: base-passwd 3.5.29 3.5.45 Anuj Mittal <anuj.mittal@intel.com> cannot be updated due to: Version 3.5.38 requires cdebconf for update-passwd utility
399 NOTE: busybox 1.29.2 1.30.0 Andrej Valek <andrej.valek@siemens.com> 405 NOTE: busybox 1.29.2 1.30.0 Andrej Valek <andrej.valek@siemens.com>
400 NOTE: dbus-test 1.12.10 1.12.12 Chen Qi <Qi.Chen@windriver.com> 406 NOTE: dbus-test 1.12.10 1.12.12 Chen Qi <Qi.Chen@windriver.com>
@@ -607,8 +613,8 @@ Following is sample output after using
607to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory: 613to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory:
608:: 614::
609 615
610 $ devtool status mtr 616 $ devtool status
611 :/home/scottrif/poky/build/workspace/sources/mtr (/home/scottrif/poky/build/workspace/recipes/mtr/mtr_0.86.bb) 617 mtr:/home/scottrif/poky/build/workspace/sources/mtr (/home/scottrif/poky/build/workspace/recipes/mtr/mtr_0.86.bb)
612 $ 618 $
613 619
614.. _devtool-search-for-available-target-recipes: 620.. _devtool-search-for-available-target-recipes:
diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst
index 60d905d055..f28ad2bb4c 100644
--- a/documentation/ref-manual/ref-features.rst
+++ b/documentation/ref-manual/ref-features.rst
@@ -229,11 +229,8 @@ The following image features are available for all images:
229 229
230 .. note:: 230 .. note::
231 231
232 To make the 232 To make the ``/var/log`` directory on the target persistent, use the
233 /var/log 233 :term:`VOLATILE_LOG_DIR` variable by setting it to "no".
234 directory on the target persistent, use the
235 VOLATILE_LOG_DIR
236 variable by setting it to "no".
237 234
238- *ptest-pkgs:* Installs ptest packages for all ptest-enabled recipes. 235- *ptest-pkgs:* Installs ptest packages for all ptest-enabled recipes.
239 236
diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/ref-images.rst
index eaa6c49499..56ec8562f8 100644
--- a/documentation/ref-manual/ref-images.rst
+++ b/documentation/ref-manual/ref-images.rst
@@ -16,8 +16,7 @@ image you want.
16 the GNU Affero General Public License Version 3 (AGPL-3.0) components 16 the GNU Affero General Public License Version 3 (AGPL-3.0) components
17 is only supported for minimal and base images. Furthermore, if you 17 is only supported for minimal and base images. Furthermore, if you
18 are going to build an image using non-GPLv3 and similarly licensed 18 are going to build an image using non-GPLv3 and similarly licensed
19 components, you must make the following changes in the 19 components, you must make the following changes in the ``local.conf``
20 local.conf
21 file before using the BitBake command to build the minimal or base 20 file before using the BitBake command to build the minimal or base
22 image: 21 image:
23 :: 22 ::
diff --git a/documentation/ref-manual/ref-kickstart.rst b/documentation/ref-manual/ref-kickstart.rst
index c031ef2874..33d579c5d1 100644
--- a/documentation/ref-manual/ref-kickstart.rst
+++ b/documentation/ref-manual/ref-kickstart.rst
@@ -55,15 +55,14 @@ must also provide one of the ``--ondrive``, ``--ondisk``, or
55.. note:: 55.. note::
56 56
57 The mount program must understand the PARTUUID syntax you use with 57 The mount program must understand the PARTUUID syntax you use with
58 --use-uuid 58 ``--use-uuid`` and non-root *mountpoint*, including swap. The busybox
59 and non-root 59 versions of these application are currently excluded.
60 mountpoint
61 , including swap. The busybox versions of these application are
62 currently excluded.
63 60
64Here is an example that uses "/" as the mountpoint. The command uses 61Here is an example that uses "/" as the mountpoint. The command uses
65``--ondisk`` to force the partition onto the ``sdb`` disk: part / 62``--ondisk`` to force the partition onto the ``sdb`` disk:
66--source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024 63::
64
65 part / --source rootfs --ondisk sdb --fstype=ext3 --label platform --align 1024
67 66
68Here is a list that describes other supported options you can use with 67Here is a list that describes other supported options you can use with
69the ``part`` and ``partition`` commands: 68the ``part`` and ``partition`` commands:
diff --git a/documentation/ref-manual/ref-qa-checks.rst b/documentation/ref-manual/ref-qa-checks.rst
index 4ac65c0f8b..5b9f92d35e 100644
--- a/documentation/ref-manual/ref-qa-checks.rst
+++ b/documentation/ref-manual/ref-qa-checks.rst
@@ -454,9 +454,8 @@ Errors and Warnings
454 454
455 Disabling stripping here does not mean that the final packaged 455 Disabling stripping here does not mean that the final packaged
456 binaries will be unstripped. Once the OpenEmbedded build system 456 binaries will be unstripped. Once the OpenEmbedded build system
457 splits out debug symbols to the 457 splits out debug symbols to the ``-dbg`` package, it will then
458 -dbg 458 strip the symbols from the binaries.
459 package, it will then strip the symbols from the binaries.
460 459
461   460  
462 461
diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst
index 172385ca4e..a6d9ff60ec 100644
--- a/documentation/ref-manual/ref-release-process.rst
+++ b/documentation/ref-manual/ref-release-process.rst
@@ -64,7 +64,7 @@ codename are likely to be compatible and thus work together.
64Releases are given a nominal release version as well but the codename is 64Releases are given a nominal release version as well but the codename is
65used in repositories for this reason. You can find information on Yocto 65used in repositories for this reason. You can find information on Yocto
66Project releases and codenames at 66Project releases and codenames at
67https://wiki.yoctoproject.org/wiki/Releases. 67:yocto_wiki:`/wiki/Releases`.
68 68
69Stable Release Process 69Stable Release Process
70====================== 70======================
@@ -94,7 +94,7 @@ Community LTS trees and branches exist where community members share
94patches for older releases. However, these types of patches do not go 94patches for older releases. However, these types of patches do not go
95through the same release process as do point releases. You can find more 95through the same release process as do point releases. You can find more
96information about stable branch maintenance at 96information about stable branch maintenance at
97https://wiki.yoctoproject.org/wiki/Stable_branch_maintenance. 97:yocto_wiki:`/wiki/Stable_branch_maintenance`.
98 98
99Testing and Quality Assurance 99Testing and Quality Assurance
100============================= 100=============================
@@ -145,18 +145,16 @@ consists of the following pieces:
145 145
146 .. note:: 146 .. note::
147 147
148 Running 148 Running ``oe-selftest`` requires host packages beyond the "Essential"
149 oe-selftest 149 grouping. See the :ref:`ref-manual/ref-system-requirements:required packages for the build host`
150 requires host packages beyond the "Essential" grouping. See the " 150 section for more information.
151 Required Packages for the Build Host
152 " section for more information.
153 151
154Originally, much of this testing was done manually. However, significant 152Originally, much of this testing was done manually. However, significant
155effort has been made to automate the tests so that more people can use 153effort has been made to automate the tests so that more people can use
156them and the Yocto Project development team can run them faster and more 154them and the Yocto Project development team can run them faster and more
157efficiently. 155efficiently.
158 156
159The Yocto Project's main Autobuilder (https://autobuilder.yoctoproject.org/) 157The Yocto Project's main Autobuilder (&YOCTO_AB_URL;)
160publicly tests each Yocto Project release's code in the 158publicly tests each Yocto Project release's code in the
161:term:`OpenEmbedded-Core (OE-Core)`, Poky, and BitBake repositories. The testing 159:term:`OpenEmbedded-Core (OE-Core)`, Poky, and BitBake repositories. The testing
162occurs for both the current state of the "master" branch and also for 160occurs for both the current state of the "master" branch and also for
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
index ef07354ec1..ff5d863736 100644
--- a/documentation/ref-manual/ref-structure.rst
+++ b/documentation/ref-manual/ref-structure.rst
@@ -282,17 +282,10 @@ file, it uses ``sed`` to substitute final
282 282
283.. note:: 283.. note::
284 284
285 You can see how the 285 You can see how the ``TEMPLATECONF`` variable is used by looking at the
286 TEMPLATECONF 286 ``scripts/oe-setup-builddir``` script in the :term:`Source Directory`.
287 variable is used by looking at the 287 You can find the Yocto Project version of the ``local.conf.sample`` file in
288 scripts/oe-setup-builddir 288 the ``meta-poky/conf`` directory.
289 script in the
290 Source Directory
291 . You can find the Yocto Project version of the
292 local.conf.sample
293 file in the
294 meta-poky/conf
295 directory.
296 289
297.. _structure-build-conf-bblayers.conf: 290.. _structure-build-conf-bblayers.conf:
298 291
@@ -327,16 +320,9 @@ Once the build process gets the sample file, it uses ``sed`` to substitute final
327 320
328.. note:: 321.. note::
329 322
330 You can see how the 323 You can see how the ``TEMPLATECONF`` variable ``scripts/oe-setup-builddir``
331 TEMPLATECONF 324 script in the :term:`Source Directory`. You can find the Yocto Project
332 variable 325 version of the ``bblayers.conf.sample`` file in the ``meta-poky/conf/``
333 scripts/oe-setup-builddir
334 script in the
335 Source Directory
336 . You can find the Yocto Project version of the
337 bblayers.conf.sample
338 file in the
339 meta-poky/conf/
340 directory. 326 directory.
341 327
342.. _structure-build-conf-sanity_info: 328.. _structure-build-conf-sanity_info:
@@ -531,19 +517,16 @@ should be automatic, and recipes should not directly reference
531 517
532Previous versions of the OpenEmbedded build system used to create a 518Previous versions of the OpenEmbedded build system used to create a
533global shared sysroot per machine along with a native sysroot. Beginning 519global shared sysroot per machine along with a native sysroot. Beginning
534with the DISTRO version of the Yocto Project, sysroots exist in 520with the 2.3 version of the Yocto Project, sysroots exist in
535recipe-specific :term:`WORKDIR` directories. Thus, the 521recipe-specific :term:`WORKDIR` directories. Thus, the
536``build/tmp/sysroots/`` directory is unused. 522``build/tmp/sysroots/`` directory is unused.
537 523
538.. note:: 524.. note::
539 525
540 The 526 The ``build/tmp/sysroots/`` directory can still be populated using the
541 build/tmp/sysroots/ 527 ``bitbake build-sysroots`` command and can be used for compatibility in some
542 directory can still be populated using the 528 cases. However, in general it is not recommended to populate this directory.
543 bitbake build-sysroots 529 Individual recipe-specific sysroots should be used.
544 command and can be used for compatibility in some cases. However, in
545 general it is not recommended to populate this directory. Individual
546 recipe-specific sysroots should be used.
547 530
548.. _structure-build-tmp-stamps: 531.. _structure-build-tmp-stamps:
549 532
@@ -554,8 +537,11 @@ This directory holds information that BitBake uses for accounting
554purposes to track what tasks have run and when they have run. The 537purposes to track what tasks have run and when they have run. The
555directory is sub-divided by architecture, package name, and version. 538directory is sub-divided by architecture, package name, and version.
556Following is an example: 539Following is an example:
557stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do Although 540::
558the files in the directory are empty of data, BitBake uses the filenames 541
542 stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do
543
544Although the files in the directory are empty of data, BitBake uses the filenames
559and timestamps for tracking purposes. 545and timestamps for tracking purposes.
560 546
561For information on how BitBake uses stamp files to determine if a task 547For information on how BitBake uses stamp files to determine if a task
@@ -613,13 +599,12 @@ install" places its output that is then split into sub-packages within
613The recipe work directory - ``${WORKDIR}``. 599The recipe work directory - ``${WORKDIR}``.
614 600
615As described earlier in the 601As described earlier in the
616"```build/tmp/sysroots/`` <#structure-build-tmp-sysroots>`__" section, 602":ref:`structure-build-tmp-sysroots`" section,
617beginning with the DISTRO release of the Yocto Project, the OpenEmbedded 603beginning with the 2.3 release of the Yocto Project, the OpenEmbedded
618build system builds each recipe in its own work directory (i.e. 604build system builds each recipe in its own work directory (i.e.
619:term:`WORKDIR`). The path to the work directory is 605:term:`WORKDIR`). The path to the work directory is
620constructed using the architecture of the given build (e.g. 606constructed using the architecture of the given build (e.g.
621:term:`TUNE_PKGARCH`, 607:term:`TUNE_PKGARCH`, :term:`MACHINE_ARCH`, or "allarch"), the recipe
622:term:`MACHINE_ARCH`, or "allarch"), the recipe
623name, and the version of the recipe (i.e. 608name, and the version of the recipe (i.e.
624:term:`PE`\ ``:``\ :term:`PV`\ ``-``\ :term:`PR`). 609:term:`PE`\ ``:``\ :term:`PV`\ ``-``\ :term:`PR`).
625 610
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst
index 54f38f6d3e..9f5db26d4d 100644
--- a/documentation/ref-manual/ref-system-requirements.rst
+++ b/documentation/ref-manual/ref-system-requirements.rst
@@ -27,9 +27,7 @@ and conceptual information in the :doc:`../overview-manual/overview-manual`.
27.. note:: 27.. note::
28 28
29 For more information about the Yocto Project Documentation set, see 29 For more information about the Yocto Project Documentation set, see
30 the " 30 the :ref:`ref-manual/resources:links and related documentation` section.
31 Links and Related Documentation
32 " section.
33 31
34.. _detailed-supported-distros: 32.. _detailed-supported-distros:
35 33
@@ -91,8 +89,8 @@ distributions:
91 compatible but not officially supported nor validated with 89 compatible but not officially supported nor validated with
92 WSLv2, if you still decide to use WSL please upgrade to WSLv2. 90 WSLv2, if you still decide to use WSL please upgrade to WSLv2.
93 91
94 - If you encounter problems, please go to `Yocto Project 92 - If you encounter problems, please go to :yocto_bugs:`Yocto Project
95 Bugzilla <http://bugzilla.yoctoproject.org>`__ and submit a bug. We are 93 Bugzilla <>` and submit a bug. We are
96 interested in hearing about your experience. For information on 94 interested in hearing about your experience. For information on
97 how to submit a bug, see the Yocto Project 95 how to submit a bug, see the Yocto Project
98 :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>` 96 :yocto_wiki:`Bugzilla wiki page </wiki/Bugzilla_Configuration_and_Bug_Tracking>`
@@ -177,8 +175,11 @@ supported openSUSE Linux distribution:
177 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; 175 $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL;
178 176
179- *Documentation:* Packages needed if you are going to build out the 177- *Documentation:* Packages needed if you are going to build out the
180 Yocto Project documentation manuals: $ sudo zypper install dblatex 178 Yocto Project documentation manuals:
181 xmlto 179 ::
180
181 $ sudo zypper install dblatex xmlto
182
182 183
183CentOS-7 Packages 184CentOS-7 Packages
184----------------- 185-----------------
@@ -279,7 +280,7 @@ installer and automatically installs the tools for you:
279 280
280 $ cd poky 281 $ cd poky
281 $ scripts/install-buildtools --without-extended-buildtools \ 282 $ scripts/install-buildtools --without-extended-buildtools \
282 --base-url https://downloads.yoctoproject.org/releases/yocto \ 283 --base-url &YOCTO_DL_URL;/releases/yocto \
283 --release yocto-&DISTRO; \ 284 --release yocto-&DISTRO; \
284 --installer-version &DISTRO; 285 --installer-version &DISTRO;
285 286
@@ -340,7 +341,7 @@ of the two methods by which you can get these tools:
340 341
341 During execution, a prompt appears that allows you to choose the 342 During execution, a prompt appears that allows you to choose the
342 installation directory. For example, you could choose the following: 343 installation directory. For example, you could choose the following:
343 /home/your-username/buildtools 344 ``/home/your-username/buildtools``
344 345
3453. Source the tools environment setup script by using a command like the 3463. Source the tools environment setup script by using a command like the
346 following: 347 following:
@@ -388,12 +389,8 @@ installer:
388 389
389 .. note:: 390 .. note::
390 391
391 The 392 The :term:`SDKMACHINE` variable in your ``local.conf`` file determines
392 SDKMACHINE 393 whether you build tools for a 32-bit or 64-bit system.
393 variable in your
394 local.conf
395 file determines whether you build tools for a 32-bit or 64-bit
396 system.
397 394
398 Once the build completes, you can find the ``.sh`` file that installs 395 Once the build completes, you can find the ``.sh`` file that installs
399 the tools in the ``tmp/deploy/sdk`` subdirectory of the 396 the tools in the ``tmp/deploy/sdk`` subdirectory of the
@@ -417,7 +414,7 @@ installer:
417 414
418 During execution, a prompt appears that allows you to choose the 415 During execution, a prompt appears that allows you to choose the
419 installation directory. For example, you could choose the following: 416 installation directory. For example, you could choose the following:
420 /home/your_username/buildtools 417 ``/home/your_username/buildtools``
421 418
4225. Source the tools environment setup script by using a command like the 4195. Source the tools environment setup script by using a command like the
423 following: 420 following:
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index ea145644f7..12320b7ef9 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -87,33 +87,30 @@ output from ``${DEPLOYDIR}`` to ``${DEPLOY_DIR_IMAGE}``.
87 87
88.. note:: 88.. note::
89 89
90 Do not write the output directly to 90 Do not write the output directly to ``${DEPLOY_DIR_IMAGE}``, as this causes
91 ${DEPLOY_DIR_IMAGE} 91 the sstate mechanism to malfunction.
92 , as this causes the sstate mechanism to malfunction.
93 92
94The ``do_deploy`` task is not added as a task by default and 93The ``do_deploy`` task is not added as a task by default and
95consequently needs to be added manually. If you want the task to run 94consequently needs to be added manually. If you want the task to run
96after :ref:`ref-tasks-compile`, you can add it by doing 95after :ref:`ref-tasks-compile`, you can add it by doing
97the following: addtask deploy after do_compile Adding ``do_deploy`` 96the following:
98after other tasks works the same way. 97::
98
99 addtask deploy after do_compile
100
101Adding ``do_deploy`` after other tasks works the same way.
99 102
100.. note:: 103.. note::
101 104
102 You do not need to add 105 You do not need to add ``before do_build`` to the ``addtask`` command
103 before do_build 106 (though it is harmless), because the ``base`` class contains the following:
104 to the
105 addtask
106 command (though it is harmless), because the
107 base
108 class contains the following:
109 :: 107 ::
110 108
111 do_build[recrdeptask] += "do_deploy" 109 do_build[recrdeptask] += "do_deploy"
112 110
113 111
114 See the " 112 See the ":ref:`bitbake-user-manual/bitbake-user-manual-execution:dependencies`"
115 Dependencies 113 section in the BitBake User Manual for more information.
116 " section in the BitBake User Manual for more information.
117 114
118If the ``do_deploy`` task re-executes, any previous output is removed 115If the ``do_deploy`` task re-executes, any previous output is removed
119(i.e. "cleaned"). 116(i.e. "cleaned").
@@ -298,10 +295,8 @@ to locate and apply patch files to the source code.
298 295
299.. note:: 296.. note::
300 297
301 The build system uses the 298 The build system uses the :term:`FILESPATH` variable to determine the
302 FILESPATH 299 default set of directories when searching for patches.
303 variable to determine the default set of directories when searching
304 for patches.
305 300
306Patch files, by default, are ``*.patch`` and ``*.diff`` files created 301Patch files, by default, are ``*.patch`` and ``*.diff`` files created
307and kept in a subdirectory of the directory holding the recipe file. For 302and kept in a subdirectory of the directory holding the recipe file. For
@@ -322,13 +317,8 @@ and patch files needed to build the package.
322 317
323.. note:: 318.. note::
324 319
325 In the case for the 320 In the case for the ``bluez5_5.48.bb`` recipe, the ``SRC_URI`` statements
326 bluez5_5.48.bb 321 are from an include file ``bluez5.inc``.
327 recipe, the
328 SRC_URI
329 statements are from an include file
330 bluez5.inc
331 .
332 322
333As mentioned earlier, the build system treats files whose file types are 323As mentioned earlier, the build system treats files whose file types are
334``.patch`` and ``.diff`` as patch files. However, you can use the 324``.patch`` and ``.diff`` as patch files. However, you can use the
@@ -356,7 +346,7 @@ the patch phase, you can use the "apply=no" parameter with the
356In the 346In the
357previous example, assuming all the files in the directory holding the 347previous example, assuming all the files in the directory holding the
358patch files end with either ``.patch`` or ``.diff``, every file would be 348patch files end with either ``.patch`` or ``.diff``, every file would be
359applied as a patch by default except for the patch_file5 patch. 349applied as a patch by default except for the ``patch_file5`` patch.
360 350
361You can find out more about the patching process in the 351You can find out more about the patching process in the
362":ref:`patching-dev-environment`" section in 352":ref:`patching-dev-environment`" section in
@@ -561,11 +551,9 @@ scratch is guaranteed.
561 551
562.. note:: 552.. note::
563 553
564 The 554 The ``do_cleansstate`` task cannot remove sstate from a remote sstate
565 do_cleansstate 555 mirror. If you need to build a target from scratch using remote mirrors, use
566 task cannot remove sstate from a remote sstate mirror. If you need to 556 the "-f" option as follows:
567 build a target from scratch using remote mirrors, use the "-f" option
568 as follows:
569 :: 557 ::
570 558
571 $ bitbake -f -c do_cleansstate target 559 $ bitbake -f -c do_cleansstate target
@@ -609,14 +597,9 @@ Creates or updates the index in the `:ref:`package-feeds-dev-environment` area.
609 597
610.. note:: 598.. note::
611 599
612 This task is not triggered with the 600 This task is not triggered with the ``bitbake -c`` command-line option as
613 bitbake -c 601 are the other tasks in this section. Because this task is specifically for
614 command-line option as are the other tasks in this section. Because 602 the ``package-index`` recipe, you run it using ``bitbake package-index``.
615 this task is specifically for the
616 package-index
617 recipe, you run it using
618 bitbake package-index
619 .
620 603
621Image-Related Tasks 604Image-Related Tasks
622=================== 605===================
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst
index 556bc6b197..24d0fe6e42 100644
--- a/documentation/ref-manual/ref-terms.rst
+++ b/documentation/ref-manual/ref-terms.rst
@@ -101,12 +101,12 @@ universal, the list includes them just in case:
101 101
102 .. note:: 102 .. note::
103 103
104 By default, the Build Directory contains :term:`TMPDIR` , which is a 104 By default, the Build Directory contains :term:`TMPDIR`, which is a
105 temporary directory the build system uses for its work. TMPDIR cannot 105 temporary directory the build system uses for its work. ``TMPDIR`` cannot
106 be under NFS. Thus, by default, the Build Directory cannot be under 106 be under NFS. Thus, by default, the Build Directory cannot be under
107 NFS. However, if you need the Build Directory to be under NFS, you can 107 NFS. However, if you need the Build Directory to be under NFS, you can
108 set this up by setting TMPDIR in your local.conf file to use a local 108 set this up by setting ``TMPDIR`` in your ``local.conf`` file to use a local
109 drive. Doing so effectively separates TMPDIR from TOPDIR , which is the 109 drive. Doing so effectively separates ``TMPDIR`` from :term:`TOPDIR`, which is the
110 Build Directory. 110 Build Directory.
111 111
112 Build Host 112 Build Host
@@ -232,7 +232,7 @@ universal, the list includes them just in case:
232 core set of recipes. 232 core set of recipes.
233 233
234 You can see the Metadata in the ``meta`` directory of the Yocto 234 You can see the Metadata in the ``meta`` directory of the Yocto
235 Project :yocto_git:`Source Repositories <>`. 235 Project :yocto_git:`Source Repositories </cgit/cgit.cgi/poky>`.
236 236
237 OpenEmbedded Build System 237 OpenEmbedded Build System
238 The build system specific to the Yocto 238 The build system specific to the Yocto
@@ -246,9 +246,7 @@ universal, the list includes them just in case:
246 246
247 .. note:: 247 .. note::
248 248
249 For some historical information about Poky, see the 249 For some historical information about Poky, see the :term:`Poky` term.
250 Poky
251 term.
252 250
253 Package 251 Package
254 In the context of the Yocto Project, this term refers to a 252 In the context of the Yocto Project, this term refers to a
@@ -258,10 +256,9 @@ universal, the list includes them just in case:
258 256
259 It is worth noting that the term "package" can, in general, have 257 It is worth noting that the term "package" can, in general, have
260 subtle meanings. For example, the packages referred to in the 258 subtle meanings. For example, the packages referred to in the
261 "`Required Packages for the Build 259 ":ref:`ref-manual/ref-system-requirements:required packages for the build host`"
262 Host <#required-packages-for-the-build-host>`__" section are compiled 260 section are compiled binaries that, when installed, add functionality to
263 binaries that, when installed, add functionality to your Linux 261 your Linux distribution.
264 distribution.
265 262
266 Another point worth noting is that historically within the Yocto 263 Another point worth noting is that historically within the Yocto
267 Project, recipes were referred to as packages - thus, the existence 264 Project, recipes were referred to as packages - thus, the existence
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 94e839926d..b271d97c15 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -78,7 +78,7 @@ system and gives an overview of their function and contents.
78 78
79 .. note:: 79 .. note::
80 80
81 If ALTERNATIVE_LINK_NAME is not defined, it defaults to ${bindir}/ name. 81 If ``ALTERNATIVE_LINK_NAME`` is not defined, it defaults to ``${bindir}/name``.
82 82
83 For more information on the alternatives system, see the 83 For more information on the alternatives system, see the
84 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" 84 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
@@ -237,15 +237,9 @@ system and gives an overview of their function and contents.
237 237
238 .. note:: 238 .. note::
239 239
240 It is assumed that all changes to 240 It is assumed that all changes to ``COMMON_LICENSE_DIR`` and
241 COMMON_LICENSE_DIR 241 ``LICENSE_PATH`` have been done before ``AVAILABLE_LICENSES``
242 and 242 is defined (in :ref:`ref-classes-license`).
243 LICENSE_PATH
244 have been done before
245 AVAILABLE_LICENSES
246 is defined (in
247 license.bbclass
248 ).
249 243
250 :term:`AVAILTUNES` 244 :term:`AVAILTUNES`
251 The list of defined CPU and Application Binary Interface (ABI) 245 The list of defined CPU and Application Binary Interface (ABI)
@@ -389,7 +383,8 @@ system and gives an overview of their function and contents.
389 add the ``BB_DISKMON_DIRS`` variable to your ``conf/local.conf`` file 383 add the ``BB_DISKMON_DIRS`` variable to your ``conf/local.conf`` file
390 found in the :term:`Build Directory`. Use the 384 found in the :term:`Build Directory`. Use the
391 following form: 385 following form:
392 :: 386
387 .. code-block:: none
393 388
394 BB_DISKMON_DIRS = "action,dir,threshold [...]" 389 BB_DISKMON_DIRS = "action,dir,threshold [...]"
395 390
@@ -473,7 +468,8 @@ system and gives an overview of their function and contents.
473 468
474 When specifying the variable in your configuration file, use the 469 When specifying the variable in your configuration file, use the
475 following form: 470 following form:
476 :: 471
472 .. code-block:: none
477 473
478 BB_DISKMON_WARNINTERVAL = "disk_space_interval,disk_inode_interval" 474 BB_DISKMON_WARNINTERVAL = "disk_space_interval,disk_inode_interval"
479 475
@@ -619,8 +615,7 @@ system and gives an overview of their function and contents.
619 615
620 .. tip:: 616 .. tip::
621 617
622 You can use the command 618 You can use the command ``bitbake-layers show-layers``
623 bitbake-layers show-layers
624 to list all configured layers along with their priorities. 619 to list all configured layers along with their priorities.
625 620
626 :term:`BBFILES` 621 :term:`BBFILES`
@@ -653,7 +648,8 @@ system and gives an overview of their function and contents.
653 648
654 This next example shows an error message that occurs because invalid 649 This next example shows an error message that occurs because invalid
655 entries are found, which cause parsing to abort: 650 entries are found, which cause parsing to abort:
656 :: 651
652 .. code-block:: none
657 653
658 ERROR: BBFILES_DYNAMIC entries must be of the form <collection name>:<filename pattern>, not: 654 ERROR: BBFILES_DYNAMIC entries must be of the form <collection name>:<filename pattern>, not:
659 /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend 655 /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend
@@ -675,7 +671,8 @@ system and gives an overview of their function and contents.
675 :: 671 ::
676 672
677 BBLAYERS = " \ 673 BBLAYERS = " \
678 /home/scottrif/poky/meta \ /home/scottrif/poky/meta-poky \ 674 /home/scottrif/poky/meta \
675 /home/scottrif/poky/meta-poky \
679 /home/scottrif/poky/meta-yocto-bsp \ 676 /home/scottrif/poky/meta-yocto-bsp \
680 /home/scottrif/poky/meta-mykernel \ 677 /home/scottrif/poky/meta-mykernel \
681 " 678 "
@@ -799,16 +796,12 @@ system and gives an overview of their function and contents.
799 796
800 .. note:: 797 .. note::
801 798
802 The 799 The ``BINCONFIG_GLOB`` variable uses
803 BINCONFIG_GLOB 800 `shell globbing <https://tldp.org/LDP/abs/html/globbingref.html>`__,
804 variable uses 801 which is recognition and expansion of wildcards during pattern
805 shell globbing
806 , which is recognition and expansion of wildcards during pattern
807 matching. Shell globbing is very similar to 802 matching. Shell globbing is very similar to
808 fnmatch 803 `fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__
809 and 804 and `glob <https://docs.python.org/3/library/glob.html>`__.
810 glob
811 .
812 805
813 For more information on how this variable works, see 806 For more information on how this variable works, see
814 ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`. 807 ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`.
@@ -944,7 +937,7 @@ system and gives an overview of their function and contents.
944 :term:`BUILDDIR` 937 :term:`BUILDDIR`
945 Points to the location of the :term:`Build Directory`. 938 Points to the location of the :term:`Build Directory`.
946 You can define this directory indirectly through the 939 You can define this directory indirectly through the
947 ````` <#structure-core-script>`__ script by passing in a Build 940 :ref:`structure-core-script` script by passing in a Build
948 Directory path when you run the script. If you run the script and do 941 Directory path when you run the script. If you run the script and do
949 not provide a Build Directory path, the ``BUILDDIR`` defaults to 942 not provide a Build Directory path, the ``BUILDDIR`` defaults to
950 ``build`` in the current directory. 943 ``build`` in the current directory.
@@ -1133,10 +1126,8 @@ system and gives an overview of their function and contents.
1133 1126
1134 .. note:: 1127 .. note::
1135 1128
1136 CLASSOVERRIDE 1129 ``CLASSOVERRIDE`` gets its default "class-target" value from the
1137 gets its default "class-target" value from the 1130 ``bitbake.conf`` file.
1138 bitbake.conf
1139 file.
1140 1131
1141 As an example, the following override allows you to install extra 1132 As an example, the following override allows you to install extra
1142 files, but only when building for the target: 1133 files, but only when building for the target:
@@ -1208,13 +1199,10 @@ system and gives an overview of their function and contents.
1208 1199
1209 .. note:: 1200 .. note::
1210 1201
1211 The 1202 The ``COMPLEMENTARY_GLOB`` variable uses Unix filename pattern matching
1212 COMPLEMENTARY_GLOB 1203 (`fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__),
1213 variable uses Unix filename pattern matching ( 1204 which is similar to the Unix style pathname pattern expansion
1214 fnmatch 1205 (`glob <https://docs.python.org/3/library/glob.html>`__).
1215 ), which is similar to the Unix style pathname pattern expansion (
1216 glob
1217 ).
1218 1206
1219 The resulting list of complementary packages is associated with an 1207 The resulting list of complementary packages is associated with an
1220 item that can be added to 1208 item that can be added to
@@ -1274,22 +1262,12 @@ system and gives an overview of their function and contents.
1274 1262
1275 .. note:: 1263 .. note::
1276 1264
1277 When specifying paths as part of the 1265 When specifying paths as part of the ``CONFFILES`` variable, it is
1278 CONFFILES 1266 good practice to use appropriate path variables.
1279 variable, it is good practice to use appropriate path variables. 1267 For example, ``${sysconfdir}`` rather than ``/etc`` or ``${bindir}``
1280 For example, 1268 rather than ``/usr/bin``. You can find a list of these variables at
1281 ${sysconfdir} 1269 the top of the ``meta/conf/bitbake.conf`` file in the
1282 rather than 1270 :term:`Source Directory`.
1283 /etc
1284 or
1285 ${bindir}
1286 rather than
1287 /usr/bin
1288 . You can find a list of these variables at the top of the
1289 meta/conf/bitbake.conf
1290 file in the
1291 Source Directory
1292 .
1293 1271
1294 :term:`CONFIG_INITRAMFS_SOURCE` 1272 :term:`CONFIG_INITRAMFS_SOURCE`
1295 Identifies the initial RAM filesystem (initramfs) source files. The 1273 Identifies the initial RAM filesystem (initramfs) source files. The
@@ -1339,11 +1317,8 @@ system and gives an overview of their function and contents.
1339 1317
1340 .. note:: 1318 .. note::
1341 1319
1342 The 1320 The ``COPYLEFT_LICENSE_EXCLUDE`` variable takes precedence over the
1343 COPYLEFT_LICENSE_EXCLUDE 1321 :term:`COPYLEFT_LICENSE_INCLUDE` variable.
1344 variable takes precedence over the
1345 COPYLEFT_LICENSE_INCLUDE
1346 variable.
1347 1322
1348 The default value, which is "CLOSED Proprietary", for 1323 The default value, which is "CLOSED Proprietary", for
1349 ``COPYLEFT_LICENSE_EXCLUDE`` is set by the 1324 ``COPYLEFT_LICENSE_EXCLUDE`` is set by the
@@ -1410,15 +1385,12 @@ system and gives an overview of their function and contents.
1410 1385
1411 .. note:: 1386 .. note::
1412 1387
1413 The 1388 The ``COPY_LIC_DIRS`` does not offer a path for adding licenses for
1414 COPY_LIC_DIRS 1389 newly installed packages to an image, which might be most suitable for
1415 does not offer a path for adding licenses for newly installed 1390 read-only filesystems that cannot be upgraded. See the
1416 packages to an image, which might be most suitable for read-only 1391 :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
1417 filesystems that cannot be upgraded. See the 1392 You can also reference the ":ref:`dev-manual/dev-manual-common-tasks:providing license text`"
1418 LICENSE_CREATE_PACKAGE 1393 section in the Yocto Project Development Tasks Manual for
1419 variable for additional information. You can also reference the "
1420 Providing License Text
1421 " section in the Yocto Project Development Tasks Manual for
1422 information on providing license text. 1394 information on providing license text.
1423 1395
1424 :term:`COPY_LIC_MANIFEST` 1396 :term:`COPY_LIC_MANIFEST`
@@ -1429,15 +1401,12 @@ system and gives an overview of their function and contents.
1429 1401
1430 .. note:: 1402 .. note::
1431 1403
1432 The 1404 The ``COPY_LIC_MANIFEST`` does not offer a path for adding licenses for
1433 COPY_LIC_MANIFEST 1405 newly installed packages to an image, which might be most suitable for
1434 does not offer a path for adding licenses for newly installed 1406 read-only filesystems that cannot be upgraded. See the
1435 packages to an image, which might be most suitable for read-only 1407 :term:`LICENSE_CREATE_PACKAGE` variable for additional information.
1436 filesystems that cannot be upgraded. See the 1408 You can also reference the ":ref:`dev-manual/dev-manual-common-tasks:providing license text`"
1437 LICENSE_CREATE_PACKAGE 1409 section in the Yocto Project Development Tasks Manual for
1438 variable for additional information. You can also reference the "
1439 Providing License Text
1440 " section in the Yocto Project Development Tasks Manual for
1441 information on providing license text. 1410 information on providing license text.
1442 1411
1443 :term:`CORE_IMAGE_EXTRA_INSTALL` 1412 :term:`CORE_IMAGE_EXTRA_INSTALL`
@@ -1500,8 +1469,7 @@ system and gives an overview of their function and contents.
1500 1469
1501 .. note:: 1470 .. note::
1502 1471
1503 The OpenEmbedded build system sets the 1472 The OpenEmbedded build system sets the ``CROSS_COMPILE``
1504 CROSS_COMPILE
1505 variable only in certain contexts (e.g. when building for kernel 1473 variable only in certain contexts (e.g. when building for kernel
1506 and kernel module recipes). 1474 and kernel module recipes).
1507 1475
@@ -1541,8 +1509,7 @@ system and gives an overview of their function and contents.
1541 .. note:: 1509 .. note::
1542 1510
1543 Tasks that read from or write to this directory should run under 1511 Tasks that read from or write to this directory should run under
1544 fakeroot 1512 :ref:`fakeroot <overview-manual/overview-manual-concepts:fakeroot and pseudo>`.
1545 .
1546 1513
1547 :term:`DATE` 1514 :term:`DATE`
1548 The date the build was started. Dates appear using the year, month, 1515 The date the build was started. Dates appear using the year, month,
@@ -1593,12 +1560,9 @@ system and gives an overview of their function and contents.
1593 1560
1594 .. note:: 1561 .. note::
1595 1562
1596 The bias provided by 1563 The bias provided by ``DEFAULT_PREFERENCE`` is weak and is overridden
1597 DEFAULT_PREFERENCE 1564 by :term:`BBFILE_PRIORITY` if that variable is different between two
1598 is weak and is overridden by 1565 layers that contain different versions of the same recipe.
1599 BBFILE_PRIORITY
1600 if that variable is different between two layers that contain
1601 different versions of the same recipe.
1602 1566
1603 :term:`DEFAULTTUNE` 1567 :term:`DEFAULTTUNE`
1604 The default CPU and Application Binary Interface (ABI) tunings (i.e. 1568 The default CPU and Application Binary Interface (ABI) tunings (i.e.
@@ -1635,8 +1599,7 @@ system and gives an overview of their function and contents.
1635 1599
1636 .. note:: 1600 .. note::
1637 1601
1638 It seldom is necessary to reference, for example, 1602 It seldom is necessary to reference, for example, ``STAGING_DIR_HOST``
1639 STAGING_DIR_HOST
1640 explicitly. The standard classes and build-related variables are 1603 explicitly. The standard classes and build-related variables are
1641 configured to automatically use the appropriate staging sysroots. 1604 configured to automatically use the appropriate staging sysroots.
1642 1605
@@ -1807,7 +1770,7 @@ system and gives an overview of their function and contents.
1807 is set in the ``deploy`` class as follows: 1770 is set in the ``deploy`` class as follows:
1808 :: 1771 ::
1809 1772
1810 DEPLOYDIR = "${WORKDIR}/deploy-${:term:`PN`}" 1773 DEPLOYDIR = "${WORKDIR}/deploy-${PN}"
1811 1774
1812 Recipes inheriting the ``deploy`` class should copy files to be 1775 Recipes inheriting the ``deploy`` class should copy files to be
1813 deployed into ``DEPLOYDIR``, and the class will take care of copying 1776 deployed into ``DEPLOYDIR``, and the class will take care of copying
@@ -1844,12 +1807,9 @@ system and gives an overview of their function and contents.
1844 1807
1845 .. note:: 1808 .. note::
1846 1809
1847 If the 1810 If the ``DISTRO`` variable is blank, a set of default configurations
1848 DISTRO 1811 are used, which are specified within
1849 variable is blank, a set of default configurations are used, which 1812 ``meta/conf/distro/defaultsetup.conf`` also in the Source Directory.
1850 are specified within
1851 meta/conf/distro/defaultsetup.conf
1852 also in the Source Directory.
1853 1813
1854 :term:`DISTRO_CODENAME` 1814 :term:`DISTRO_CODENAME`
1855 Specifies a codename for the distribution being built. 1815 Specifies a codename for the distribution being built.
@@ -1884,8 +1844,7 @@ system and gives an overview of their function and contents.
1884 1844
1885 Two more examples are Bluetooth and NFS support. For a more complete 1845 Two more examples are Bluetooth and NFS support. For a more complete
1886 list of features that ships with the Yocto Project and that you can 1846 list of features that ships with the Yocto Project and that you can
1887 provide with this variable, see the "`Distro 1847 provide with this variable, see the ":ref:`ref-features-distro`" section.
1888 Features <#ref-features-distro>`__" section.
1889 1848
1890 :term:`DISTRO_FEATURES_BACKFILL` 1849 :term:`DISTRO_FEATURES_BACKFILL`
1891 Features to be added to ``DISTRO_FEATURES`` if not also present in 1850 Features to be added to ``DISTRO_FEATURES`` if not also present in
@@ -1894,15 +1853,13 @@ system and gives an overview of their function and contents.
1894 This variable is set in the ``meta/conf/bitbake.conf`` file. It is 1853 This variable is set in the ``meta/conf/bitbake.conf`` file. It is
1895 not intended to be user-configurable. It is best to just reference 1854 not intended to be user-configurable. It is best to just reference
1896 the variable to see which distro features are being backfilled for 1855 the variable to see which distro features are being backfilled for
1897 all distro configurations. See the "`Feature 1856 all distro configurations. See the ":ref:`ref-features-backfill`" section
1898 Backfilling <#ref-features-backfill>`__" section for more 1857 for more information.
1899 information.
1900 1858
1901 :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` 1859 :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
1902 Features from ``DISTRO_FEATURES_BACKFILL`` that should not be 1860 Features from ``DISTRO_FEATURES_BACKFILL`` that should not be
1903 backfilled (i.e. added to ``DISTRO_FEATURES``) during the build. See 1861 backfilled (i.e. added to ``DISTRO_FEATURES``) during the build. See
1904 the "`Feature Backfilling <#ref-features-backfill>`__" section for 1862 the ":ref:`ref-features-backfill`" section for more information.
1905 more information.
1906 1863
1907 :term:`DISTRO_FEATURES_DEFAULT` 1864 :term:`DISTRO_FEATURES_DEFAULT`
1908 A convenience variable that gives you the default list of distro 1865 A convenience variable that gives you the default list of distro
@@ -1973,12 +1930,9 @@ system and gives an overview of their function and contents.
1973 1930
1974 .. note:: 1931 .. note::
1975 1932
1976 If the 1933 If the ``DISTRO_NAME`` variable is blank, a set of default
1977 DISTRO_NAME 1934 configurations are used, which are specified within
1978 variable is blank, a set of default configurations are used, which 1935 ``meta/conf/distro/defaultsetup.conf`` also in the Source Directory.
1979 are specified within
1980 meta/conf/distro/defaultsetup.conf
1981 also in the Source Directory.
1982 1936
1983 :term:`DISTRO_VERSION` 1937 :term:`DISTRO_VERSION`
1984 The version of the distribution. 1938 The version of the distribution.
@@ -2028,8 +1982,7 @@ system and gives an overview of their function and contents.
2028 You can safely share this directory between multiple builds on the 1982 You can safely share this directory between multiple builds on the
2029 same development machine. For additional information on how the build 1983 same development machine. For additional information on how the build
2030 process gets source files when working behind a firewall or proxy 1984 process gets source files when working behind a firewall or proxy
2031 server, see this specific question in the 1985 server, see this specific question in the ":doc:`faq`"
2032 "`FAQ <#how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server>`__"
2033 chapter. You can also refer to the 1986 chapter. You can also refer to the
2034 ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" 1987 ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`"
2035 Wiki page. 1988 Wiki page.
@@ -2089,12 +2042,10 @@ system and gives an overview of their function and contents.
2089 .. note:: 2042 .. note::
2090 2043
2091 The shared libraries resolver's functionality results in part from 2044 The shared libraries resolver's functionality results in part from
2092 the internal function 2045 the internal function ``package_do_shlibs``, which is part of the
2093 package_do_shlibs 2046 :ref:`ref-tasks-package` task. You should be aware that the shared
2094 , which is part of the 2047 libraries resolver might implicitly define some dependencies between
2095 do_package 2048 packages.
2096 task. You should be aware that the shared libraries resolver might
2097 implicitly define some dependencies between packages.
2098 2049
2099 The ``EXCLUDE_FROM_SHLIBS`` variable is similar to the 2050 The ``EXCLUDE_FROM_SHLIBS`` variable is similar to the
2100 :term:`PRIVATE_LIBS` variable, which excludes a 2051 :term:`PRIVATE_LIBS` variable, which excludes a
@@ -2117,13 +2068,10 @@ system and gives an overview of their function and contents.
2117 2068
2118 .. note:: 2069 .. note::
2119 2070
2120 Recipes added to 2071 Recipes added to ``EXCLUDE_FROM_WORLD`` may still be built during a
2121 EXCLUDE_FROM_WORLD 2072 world build in order to satisfy dependencies of other recipes. Adding
2122 may still be built during a world build in order to satisfy 2073 a recipe to ``EXCLUDE_FROM_WORLD`` only ensures that the recipe is not
2123 dependencies of other recipes. Adding a recipe to 2074 explicitly added to the list of build targets in a world build.
2124 EXCLUDE_FROM_WORLD
2125 only ensures that the recipe is not explicitly added to the list
2126 of build targets in a world build.
2127 2075
2128 :term:`EXTENDPE` 2076 :term:`EXTENDPE`
2129 Used with file and pathnames to create a prefix for a recipe's 2077 Used with file and pathnames to create a prefix for a recipe's
@@ -2205,8 +2153,7 @@ system and gives an overview of their function and contents.
2205 .. note:: 2153 .. note::
2206 2154
2207 To enable primary features from within the image recipe, use the 2155 To enable primary features from within the image recipe, use the
2208 IMAGE_FEATURES 2156 :term:`IMAGE_FEATURES` variable.
2209 variable.
2210 2157
2211 Here are some examples of features you can add: 2158 Here are some examples of features you can add:
2212 2159
@@ -2215,8 +2162,8 @@ system and gives an overview of their function and contents.
2215 2162
2216 - "debug-tweaks" - Makes an image suitable for debugging. For example, allows root logins without passwords and 2163 - "debug-tweaks" - Makes an image suitable for debugging. For example, allows root logins without passwords and
2217 enables post-installation logging. See the 'allow-empty-password' and 2164 enables post-installation logging. See the 'allow-empty-password' and
2218 'post-install-logging' features in the "`Image 2165 'post-install-logging' features in the ":ref:`ref-features-image`"
2219 Features <#ref-features-image>`__" section for more information. 2166 section for more information.
2220 - "dev-pkgs" - Adds -dev packages for all installed packages. This is 2167 - "dev-pkgs" - Adds -dev packages for all installed packages. This is
2221 useful if you want to develop against the libraries in the image. 2168 useful if you want to develop against the libraries in the image.
2222 - "read-only-rootfs" - Creates an image whose root filesystem is 2169 - "read-only-rootfs" - Creates an image whose root filesystem is
@@ -2231,7 +2178,7 @@ system and gives an overview of their function and contents.
2231 such as ts_print, aplay, arecord and so forth. 2178 such as ts_print, aplay, arecord and so forth.
2232 2179
2233 For a complete list of image features that ships with the Yocto 2180 For a complete list of image features that ships with the Yocto
2234 Project, see the "`Image Features <#ref-features-image>`__" section. 2181 Project, see the ":ref:`ref-features-image`" section.
2235 2182
2236 For an example that shows how to customize your image by using this 2183 For an example that shows how to customize your image by using this
2237 variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" 2184 variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`"
@@ -2258,8 +2205,7 @@ system and gives an overview of their function and contents.
2258 .. note:: 2205 .. note::
2259 2206
2260 To add packages to the root filesystem, see the various 2207 To add packages to the root filesystem, see the various
2261 \*RDEPENDS and \*RRECOMMENDS 2208 \*:term:`RDEPENDS` and \*:term:`RRECOMMENDS` variables.
2262 variables.
2263 2209
2264 :term:`EXTRANATIVEPATH` 2210 :term:`EXTRANATIVEPATH`
2265 A list of subdirectories of 2211 A list of subdirectories of
@@ -2332,13 +2278,10 @@ system and gives an overview of their function and contents.
2332 2278
2333 .. note:: 2279 .. note::
2334 2280
2335 Packages installed by features defined through 2281 Packages installed by features defined through ``FEATURE_PACKAGES``
2336 FEATURE_PACKAGES
2337 are often package groups. While similarly named, you should not 2282 are often package groups. While similarly named, you should not
2338 confuse the 2283 confuse the ``FEATURE_PACKAGES`` variable with package groups, which
2339 FEATURE_PACKAGES 2284 are discussed elsewhere in the documentation.
2340 variable with package groups, which are discussed elsewhere in the
2341 documentation.
2342 2285
2343 :term:`FEED_DEPLOYDIR_BASE_URI` 2286 :term:`FEED_DEPLOYDIR_BASE_URI`
2344 Points to the base URL of the server and location within the 2287 Points to the base URL of the server and location within the
@@ -2471,9 +2414,7 @@ system and gives an overview of their function and contents.
2471 .. note:: 2414 .. note::
2472 2415
2473 For a layer that supports a single BSP, the override could just be 2416 For a layer that supports a single BSP, the override could just be
2474 the value of 2417 the value of ``MACHINE``.
2475 MACHINE
2476 .
2477 2418
2478 By prepending paths in ``.bbappend`` files, you allow multiple append 2419 By prepending paths in ``.bbappend`` files, you allow multiple append
2479 files that reside in different layers but are used for the same 2420 files that reside in different layers but are used for the same
@@ -2498,10 +2439,9 @@ system and gives an overview of their function and contents.
2498 2439
2499 .. note:: 2440 .. note::
2500 2441
2501 Do not hand-edit the 2442 Do not hand-edit the ``FILESOVERRIDES`` variable. The values match up
2502 FILESOVERRIDES 2443 with expected overrides and are used in an expected manner by the
2503 variable. The values match up with expected overrides and are used 2444 build system.
2504 in an expected manner by the build system.
2505 2445
2506 :term:`FILESPATH` 2446 :term:`FILESPATH`
2507 The default set of directories the OpenEmbedded build system uses 2447 The default set of directories the OpenEmbedded build system uses
@@ -2674,11 +2614,8 @@ system and gives an overview of their function and contents.
2674 2614
2675 .. note:: 2615 .. note::
2676 2616
2677 If you specifically remove the locale 2617 If you specifically remove the locale ``en_US.UTF-8``, you must set
2678 en_US.UTF-8 2618 :term:`IMAGE_LINGUAS` appropriately.
2679 , you must set
2680 IMAGE_LINGUAS
2681 appropriately.
2682 2619
2683 You can set ``GLIBC_GENERATE_LOCALES`` in your ``local.conf`` file. 2620 You can set ``GLIBC_GENERATE_LOCALES`` in your ``local.conf`` file.
2684 By default, all locales are generated. 2621 By default, all locales are generated.
@@ -2771,7 +2708,7 @@ system and gives an overview of their function and contents.
2771 - :term:`TARGET_CC_ARCH` when building for the 2708 - :term:`TARGET_CC_ARCH` when building for the
2772 target 2709 target
2773 2710
2774 - ``BUILD_CC_ARCH`` when building for the build host (i.e. 2711 - :term:`BUILD_CC_ARCH` when building for the build host (i.e.
2775 ``-native``) 2712 ``-native``)
2776 2713
2777 - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e. 2714 - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e.
@@ -2870,9 +2807,7 @@ system and gives an overview of their function and contents.
2870 .. note:: 2807 .. note::
2871 2808
2872 The options passed affect builds on all enabled machines on the 2809 The options passed affect builds on all enabled machines on the
2873 network, which are machines running the 2810 network, which are machines running the ``iceccd`` daemon.
2874 iceccd
2875 daemon.
2876 2811
2877 If your enabled machines support multiple cores, coming up with the 2812 If your enabled machines support multiple cores, coming up with the
2878 maximum number of parallel threads that gives you the best 2813 maximum number of parallel threads that gives you the best
@@ -3046,11 +2981,10 @@ system and gives an overview of their function and contents.
3046 .. note:: 2981 .. note::
3047 2982
3048 To enable extra features from outside the image recipe, use the 2983 To enable extra features from outside the image recipe, use the
3049 EXTRA_IMAGE_FEATURES 2984 :term:`EXTRA_IMAGE_FEATURES` variable.
3050 variable.
3051 2985
3052 For a list of image features that ships with the Yocto Project, see 2986 For a list of image features that ships with the Yocto Project, see
3053 the "`Image Features <#ref-features-image>`__" section. 2987 the ":ref:`ref-features-image`" section.
3054 2988
3055 For an example that shows how to customize your image by using this 2989 For an example that shows how to customize your image by using this
3056 variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" 2990 variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`"
@@ -3104,7 +3038,7 @@ system and gives an overview of their function and contents.
3104 .. note:: 3038 .. note::
3105 3039
3106 - When working with a 3040 - When working with a
3107 ```core-image-minimal-initramfs`` <#images-core-image-minimal-initramfs>`__ 3041 :ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>`
3108 image, do not use the ``IMAGE_INSTALL`` variable to specify 3042 image, do not use the ``IMAGE_INSTALL`` variable to specify
3109 packages for installation. Instead, use the 3043 packages for installation. Instead, use the
3110 :term:`PACKAGE_INSTALL` variable, which 3044 :term:`PACKAGE_INSTALL` variable, which
@@ -3219,10 +3153,8 @@ system and gives an overview of their function and contents.
3219 3153
3220 .. note:: 3154 .. note::
3221 3155
3222 The 3156 The ``package_tar`` class is broken and is not supported. It is
3223 package_tar 3157 recommended that you do not use it.
3224 class is broken and is not supported. It is recommended that you
3225 do not use it.
3226 3158
3227 The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` and 3159 The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` and
3228 :ref:`image <ref-classes-image>` classes use the ``IMAGE_PKGTYPE`` 3160 :ref:`image <ref-classes-image>` classes use the ``IMAGE_PKGTYPE``
@@ -3237,10 +3169,9 @@ system and gives an overview of their function and contents.
3237 3169
3238 .. note:: 3170 .. note::
3239 3171
3240 Files using the 3172 Files using the ``.tar`` format are never used as a substitute
3241 .tar 3173 packaging format for DEB, RPM, and IPK formatted files for your image
3242 format are never used as a substitute packaging format for DEB, 3174 or SDK.
3243 RPM, and IPK formatted files for your image or SDK.
3244 3175
3245 :term:`IMAGE_POSTPROCESS_COMMAND` 3176 :term:`IMAGE_POSTPROCESS_COMMAND`
3246 Specifies a list of functions to call once the OpenEmbedded build 3177 Specifies a list of functions to call once the OpenEmbedded build
@@ -3447,23 +3378,17 @@ system and gives an overview of their function and contents.
3447 3378
3448 It is possible to define a list of licenses that are allowed to be 3379 It is possible to define a list of licenses that are allowed to be
3449 used instead of the licenses that are excluded. To do this, define 3380 used instead of the licenses that are excluded. To do this, define
3450 a variable 3381 a variable ``COMPATIBLE_LICENSES`` with the names of the licences
3451 COMPATIBLE_LICENSES 3382 that are allowed. Then define ``INCOMPATIBLE_LICENSE`` as:
3452 with the names of the licences that are allowed. Then define
3453 INCOMPATIBLE_LICENSE
3454 as:
3455 :: 3383 ::
3456 3384
3457 INCOMPATIBLE_LICENSE = "${@' '.join(sorted(set(d.getVar('AVAILABLE_LICENSES').split()) - set(d.getVar('COMPATIBLE_LICENSES').split())))}" 3385 INCOMPATIBLE_LICENSE = "${@' '.join(sorted(set(d.getVar('AVAILABLE_LICENSES').split()) - set(d.getVar('COMPATIBLE_LICENSES').split())))}"
3458 3386
3459 3387
3460 This will result in 3388 This will result in ``INCOMPATIBLE_LICENSE`` containing the names of
3461 INCOMPATIBLE_LICENSE 3389 all licences from :term:`AVAILABLE_LICENSES` except the ones specified
3462 containing the names of all licences from 3390 in ``COMPATIBLE_LICENSES`` , thus only allowing the latter licences to
3463 AVAILABLE_LICENSES 3391 be used.
3464 except the ones specified in
3465 COMPATIBLE_LICENSES
3466 , thus only allowing the latter licences to be used.
3467 3392
3468 :term:`INHERIT` 3393 :term:`INHERIT`
3469 Causes the named class or classes to be inherited globally. Anonymous 3394 Causes the named class or classes to be inherited globally. Anonymous
@@ -3536,13 +3461,11 @@ system and gives an overview of their function and contents.
3536 3461
3537 .. note:: 3462 .. note::
3538 3463
3539 Use of the 3464 Use of the ``INHIBIT_SYSROOT_STRIP`` variable occurs in rare and
3540 INHIBIT_SYSROOT_STRIP 3465 special circumstances. For example, suppose you are building
3541 variable occurs in rare and special circumstances. For example, 3466 bare-metal firmware by using an external GCC toolchain. Furthermore,
3542 suppose you are building bare-metal firmware by using an external 3467 even if the toolchain's binaries are strippable, other files exist
3543 GCC toolchain. Furthermore, even if the toolchain's binaries are 3468 that are needed for the build that are not strippable.
3544 strippable, other files exist that are needed for the build that
3545 are not strippable.
3546 3469
3547 :term:`INITRAMFS_FSTYPES` 3470 :term:`INITRAMFS_FSTYPES`
3548 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
@@ -3573,13 +3496,10 @@ system and gives an overview of their function and contents.
3573 3496
3574 .. note:: 3497 .. note::
3575 3498
3576 See the 3499 See the ``meta/recipes-core/images/core-image-minimal-initramfs.bb``
3577 meta/recipes-core/images/core-image-minimal-initramfs.bb 3500 recipe in the :term:`Source Directory`
3578 recipe in the
3579 Source Directory
3580 for an example initramfs recipe. To select this sample recipe as 3501 for an example initramfs recipe. To select this sample recipe as
3581 the one built to provide the initramfs image, set 3502 the one built to provide the initramfs image, set ``INITRAMFS_IMAGE``
3582 INITRAMFS_IMAGE
3583 to "core-image-minimal-initramfs". 3503 to "core-image-minimal-initramfs".
3584 3504
3585 You can also find more information by referencing the 3505 You can also find more information by referencing the
@@ -3637,10 +3557,8 @@ system and gives an overview of their function and contents.
3637 3557
3638 .. note:: 3558 .. note::
3639 3559
3640 You must set the 3560 You must set the ``INITRAMFS_IMAGE_BUNDLE`` variable in a
3641 INITRAMFS_IMAGE_BUNDLE 3561 configuration file. You cannot set the variable in a recipe file.
3642 variable in a configuration file. You cannot set the variable in a
3643 recipe file.
3644 3562
3645 See the 3563 See the
3646 :yocto_git:`local.conf.sample.extended </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>` 3564 :yocto_git:`local.conf.sample.extended </cgit/cgit.cgi/poky/tree/meta-poky/conf/local.conf.sample.extended>`
@@ -3861,7 +3779,7 @@ system and gives an overview of their function and contents.
3861 3779
3862 .. note:: 3780 .. note::
3863 3781
3864 The IMAGE_VERSION_SUFFIX variable is set to DATETIME. 3782 The ``IMAGE_VERSION_SUFFIX`` variable is set to :term:`DATETIME`.
3865 3783
3866 :term:`KERNEL_CLASSES` 3784 :term:`KERNEL_CLASSES`
3867 A list of classes defining kernel image types that the 3785 A list of classes defining kernel image types that the
@@ -3879,7 +3797,7 @@ system and gives an overview of their function and contents.
3879 .. note:: 3797 .. note::
3880 3798
3881 Legacy support exists for specifying the full path to the device 3799 Legacy support exists for specifying the full path to the device
3882 tree. However, providing just the .dtb file is preferred. 3800 tree. However, providing just the ``.dtb`` file is preferred.
3883 3801
3884 In order to use this variable, the 3802 In order to use this variable, the
3885 :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must 3803 :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must
@@ -4038,8 +3956,7 @@ system and gives an overview of their function and contents.
4038 3956
4039 .. note:: 3957 .. note::
4040 3958
4041 This variable replaces the deprecated 3959 This variable replaces the deprecated :term:`module_autoload`
4042 module_autoload
4043 variable. 3960 variable.
4044 3961
4045 You can use the ``KERNEL_MODULE_AUTOLOAD`` variable anywhere that it 3962 You can use the ``KERNEL_MODULE_AUTOLOAD`` variable anywhere that it
@@ -4234,9 +4151,8 @@ system and gives an overview of their function and contents.
4234 4151
4235 .. note:: 4152 .. note::
4236 4153
4237 Setting 4154 Setting ``LAYERSERIES_COMPAT`` is required by the Yocto Project
4238 LAYERSERIES_COMPAT 4155 Compatible version 2 standard.
4239 is required by the Yocto Project Compatible version 2 standard.
4240 The OpenEmbedded build system produces a warning if the variable 4156 The OpenEmbedded build system produces a warning if the variable
4241 is not set for any given layer. 4157 is not set for any given layer.
4242 4158
@@ -4484,9 +4400,7 @@ system and gives an overview of their function and contents.
4484 .. note:: 4400 .. note::
4485 4401
4486 Adding additional Board Support Package (BSP) layers to your 4402 Adding additional Board Support Package (BSP) layers to your
4487 configuration adds new possible settings for 4403 configuration adds new possible settings for ``MACHINE``.
4488 MACHINE
4489 .
4490 4404
4491 :term:`MACHINE_ARCH` 4405 :term:`MACHINE_ARCH`
4492 Specifies the name of the machine-specific architecture. This 4406 Specifies the name of the machine-specific architecture. This
@@ -4551,13 +4465,10 @@ system and gives an overview of their function and contents.
4551 4465
4552 .. note:: 4466 .. note::
4553 4467
4554 In this example, the 4468 In this example, the ``kernel-module-ab123`` recipe needs to
4555 kernel-module-ab123 4469 explicitly set its :term:`PACKAGES` variable to ensure that BitBake
4556 recipe needs to explicitly set its 4470 does not use the kernel recipe's :term:`PACKAGES_DYNAMIC` variable to
4557 PACKAGES 4471 satisfy the dependency.
4558 variable to ensure that BitBake does not use the kernel recipe's
4559 PACKAGES_DYNAMIC
4560 variable to satisfy the dependency.
4561 4472
4562 Some examples of these machine essentials are flash, screen, 4473 Some examples of these machine essentials are flash, screen,
4563 keyboard, mouse, or touchscreen drivers (depending on the machine). 4474 keyboard, mouse, or touchscreen drivers (depending on the machine).
@@ -4625,8 +4536,7 @@ system and gives an overview of their function and contents.
4625 :term:`IMAGE_FEATURES` variables. 4536 :term:`IMAGE_FEATURES` variables.
4626 4537
4627 For a list of hardware features supported by the Yocto Project as 4538 For a list of hardware features supported by the Yocto Project as
4628 shipped, see the "`Machine Features <#ref-features-machine>`__" 4539 shipped, see the ":ref:`ref-features-machine`" section.
4629 section.
4630 4540
4631 :term:`MACHINE_FEATURES_BACKFILL` 4541 :term:`MACHINE_FEATURES_BACKFILL`
4632 Features to be added to ``MACHINE_FEATURES`` if not also present in 4542 Features to be added to ``MACHINE_FEATURES`` if not also present in
@@ -4635,15 +4545,13 @@ system and gives an overview of their function and contents.
4635 This variable is set in the ``meta/conf/bitbake.conf`` file. It is 4545 This variable is set in the ``meta/conf/bitbake.conf`` file. It is
4636 not intended to be user-configurable. It is best to just reference 4546 not intended to be user-configurable. It is best to just reference
4637 the variable to see which machine features are being backfilled for 4547 the variable to see which machine features are being backfilled for
4638 all machine configurations. See the "`Feature 4548 all machine configurations. See the ":ref:`ref-features-backfill`"
4639 Backfilling <#ref-features-backfill>`__" section for more 4549 section for more information.
4640 information.
4641 4550
4642 :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` 4551 :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`
4643 Features from ``MACHINE_FEATURES_BACKFILL`` that should not be 4552 Features from ``MACHINE_FEATURES_BACKFILL`` that should not be
4644 backfilled (i.e. added to ``MACHINE_FEATURES``) during the build. See 4553 backfilled (i.e. added to ``MACHINE_FEATURES``) during the build. See
4645 the "`Feature Backfilling <#ref-features-backfill>`__" section for 4554 the ":ref:`ref-features-backfill`" section for more information.
4646 more information.
4647 4555
4648 :term:`MACHINEOVERRIDES` 4556 :term:`MACHINEOVERRIDES`
4649 A colon-separated list of overrides that apply to the current 4557 A colon-separated list of overrides that apply to the current
@@ -4697,16 +4605,10 @@ system and gives an overview of their function and contents.
4697 4605
4698 .. note:: 4606 .. note::
4699 4607
4700 The "ML" in 4608 The "ML" in ``MLPREFIX`` stands for "MultiLib". This representation is
4701 MLPREFIX 4609 historical and comes from a time when ``nativesdk`` was a suffix
4702 stands for "MultiLib". This representation is historical and comes 4610 rather than a prefix on the recipe name. When ``nativesdk`` was turned
4703 from a time when 4611 into a prefix, it made sense to set ``MLPREFIX`` for it as well.
4704 nativesdk
4705 was a suffix rather than a prefix on the recipe name. When
4706 nativesdk
4707 was turned into a prefix, it made sense to set
4708 MLPREFIX
4709 for it as well.
4710 4612
4711 To help understand when ``MLPREFIX`` might be needed, consider when 4613 To help understand when ``MLPREFIX`` might be needed, consider when
4712 :term:`BBCLASSEXTEND` is used to provide a 4614 :term:`BBCLASSEXTEND` is used to provide a
@@ -4891,7 +4793,7 @@ system and gives an overview of their function and contents.
4891 4793
4892 Some recommended packages might be required for certain system 4794 Some recommended packages might be required for certain system
4893 functionality, such as kernel modules. It is up to you to add 4795 functionality, such as kernel modules. It is up to you to add
4894 packages with the IMAGE_INSTALL variable. 4796 packages with the :term:`IMAGE_INSTALL` variable.
4895 4797
4896 Support for this variable exists only when using the IPK and RPM 4798 Support for this variable exists only when using the IPK and RPM
4897 packaging backend. Support does not exist for DEB. 4799 packaging backend. Support does not exist for DEB.
@@ -4969,7 +4871,7 @@ system and gives an overview of their function and contents.
4969 :term:`OEROOT` 4871 :term:`OEROOT`
4970 The directory from which the top-level build environment setup script 4872 The directory from which the top-level build environment setup script
4971 is sourced. The Yocto Project provides a top-level build environment 4873 is sourced. The Yocto Project provides a top-level build environment
4972 setup script: ````` <#structure-core-script>`__. When you run this 4874 setup script: :ref:`structure-core-script`. When you run this
4973 script, the ``OEROOT`` variable resolves to the directory that 4875 script, the ``OEROOT`` variable resolves to the directory that
4974 contains the script. 4876 contains the script.
4975 4877
@@ -5020,14 +4922,10 @@ system and gives an overview of their function and contents.
5020 4922
5021 .. note:: 4923 .. note::
5022 4924
5023 An easy way to see what overrides apply is to search for 4925 An easy way to see what overrides apply is to search for ``OVERRIDES``
5024 OVERRIDES 4926 in the output of the ``bitbake -e`` command. See the
5025 in the output of the 4927 ":ref:`dev-debugging-viewing-variable-values`" section in the Yocto
5026 bitbake -e 4928 Project Development Tasks Manual for more information.
5027 command. See the "
5028 Viewing Variable Values
5029 " section in the Yocto Project Development Tasks Manual for more
5030 information.
5031 4929
5032 :term:`P` 4930 :term:`P`
5033 The recipe name and version. ``P`` is comprised of the following: 4931 The recipe name and version. ``P`` is comprised of the following:
@@ -5062,9 +4960,7 @@ system and gives an overview of their function and contents.
5062 4960
5063 .. note:: 4961 .. note::
5064 4962
5065 See 4963 See :term:`SDK_ARCH` for more information.
5066 SDK_ARCH
5067 for more information.
5068 4964
5069 However, if your recipe's output packages are built specific to the 4965 However, if your recipe's output packages are built specific to the
5070 target machine rather than generally for the architecture of the 4966 target machine rather than generally for the architecture of the
@@ -5098,8 +4994,7 @@ system and gives an overview of their function and contents.
5098 4994
5099 .. note:: 4995 .. note::
5100 4996
5101 While it is a legal option, the 4997 While it is a legal option, the ``package_tar``
5102 package_tar
5103 class has limited functionality due to no support for package 4998 class has limited functionality due to no support for package
5104 dependencies by that backend. Therefore, it is recommended that 4999 dependencies by that backend. Therefore, it is recommended that
5105 you do not use it. 5000 you do not use it.
@@ -5209,8 +5104,7 @@ system and gives an overview of their function and contents.
5209 5104
5210 .. note:: 5105 .. note::
5211 5106
5212 You can use the 5107 You can use the ``PACKAGE_FEEDS_ARCHS``
5213 PACKAGE_FEEDS_ARCHS
5214 variable to whitelist specific package architectures. If you do 5108 variable to whitelist specific package architectures. If you do
5215 not need to whitelist specific architectures, which is a common 5109 not need to whitelist specific architectures, which is a common
5216 case, you can omit this variable. Omitting the variable results in 5110 case, you can omit this variable. Omitting the variable results in
@@ -5228,7 +5122,8 @@ system and gives an overview of their function and contents.
5228 PACKAGE_FEED_ARCHS = "all core2-64" 5122 PACKAGE_FEED_ARCHS = "all core2-64"
5229 5123
5230 Given these settings, the resulting package feeds are as follows: 5124 Given these settings, the resulting package feeds are as follows:
5231 :: 5125
5126 .. code-block:: none
5232 5127
5233 https://example.com/packagerepos/release/rpm/all 5128 https://example.com/packagerepos/release/rpm/all
5234 https://example.com/packagerepos/release/rpm/core2-64 5129 https://example.com/packagerepos/release/rpm/core2-64
@@ -5257,7 +5152,8 @@ system and gives an overview of their function and contents.
5257 PACKAGE_FEED_ARCHS = "all core2-64" 5152 PACKAGE_FEED_ARCHS = "all core2-64"
5258 5153
5259 Given these settings, the resulting package feeds are as follows: 5154 Given these settings, the resulting package feeds are as follows:
5260 :: 5155
5156 .. code-block:: none
5261 5157
5262 https://example.com/packagerepos/release/rpm/all 5158 https://example.com/packagerepos/release/rpm/all
5263 https://example.com/packagerepos/release/rpm/core2-64 5159 https://example.com/packagerepos/release/rpm/core2-64
@@ -5286,7 +5182,8 @@ system and gives an overview of their function and contents.
5286 PACKAGE_FEED_ARCHS = "all core2-64" 5182 PACKAGE_FEED_ARCHS = "all core2-64"
5287 5183
5288 Given these settings, the resulting package feeds are as follows: 5184 Given these settings, the resulting package feeds are as follows:
5289 :: 5185
5186 .. code-block:: none
5290 5187
5291 https://example.com/packagerepos/release/rpm/all 5188 https://example.com/packagerepos/release/rpm/all
5292 https://example.com/packagerepos/release/rpm/core2-64 5189 https://example.com/packagerepos/release/rpm/core2-64
@@ -5308,8 +5205,7 @@ system and gives an overview of their function and contents.
5308 general, you should use the 5205 general, you should use the
5309 :term:`IMAGE_INSTALL` variable to specify 5206 :term:`IMAGE_INSTALL` variable to specify
5310 packages for installation. The exception to this is when working with 5207 packages for installation. The exception to this is when working with
5311 the 5208 the :ref:`core-image-minimal-initramfs <ref-manual/ref-images:images>`
5312 ```core-image-minimal-initramfs`` <#images-core-image-minimal-initramfs>`__
5313 image. When working with an initial RAM filesystem (initramfs) image, 5209 image. When working with an initial RAM filesystem (initramfs) image,
5314 use the ``PACKAGE_INSTALL`` variable. For information on creating an 5210 use the ``PACKAGE_INSTALL`` variable. For information on creating an
5315 initramfs, see the ":ref:`building-an-initramfs-image`" section 5211 initramfs, see the ":ref:`building-an-initramfs-image`" section
@@ -5424,8 +5320,11 @@ system and gives an overview of their function and contents.
5424 block through an append file except you edit your ``local.conf`` 5320 block through an append file except you edit your ``local.conf``
5425 or ``mydistro.conf`` file. As with append files previously 5321 or ``mydistro.conf`` file. As with append files previously
5426 described, you can either completely override the variable: 5322 described, you can either completely override the variable:
5427 PACKAGECONFIG_pn-recipename = "f4 f5" Or, you can just amend the 5323 ::
5428 variable: 5324
5325 PACKAGECONFIG_pn-recipename = "f4 f5"
5326
5327 Or, you can just amend the variable:
5429 :: 5328 ::
5430 5329
5431 PACKAGECONFIG_append_pn-recipename = " f4" 5330 PACKAGECONFIG_append_pn-recipename = " f4"
@@ -5511,17 +5410,9 @@ system and gives an overview of their function and contents.
5511 5410
5512 .. note:: 5411 .. note::
5513 5412
5514 In order for 5413 In order for ``PARALLEL_MAKE`` to be effective, ``make`` must be
5515 PARALLEL_MAKE 5414 called with ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy way to ensure
5516 to be effective, 5415 this is to use the ``oe_runmake`` function.
5517 make
5518 must be called with
5519 ${
5520 EXTRA_OEMAKE
5521 }
5522 . An easy way to ensure this is to use the
5523 oe_runmake
5524 function.
5525 5416
5526 By default, the OpenEmbedded build system automatically sets this 5417 By default, the OpenEmbedded build system automatically sets this
5527 variable to be equal to the number of cores the build system uses. 5418 variable to be equal to the number of cores the build system uses.
@@ -5529,14 +5420,11 @@ system and gives an overview of their function and contents.
5529 .. note:: 5420 .. note::
5530 5421
5531 If the software being built experiences dependency issues during 5422 If the software being built experiences dependency issues during
5532 the 5423 the ``do_compile`` task that result in race conditions, you can clear
5533 do_compile 5424 the ``PARALLEL_MAKE`` variable within the recipe as a workaround. For
5534 task that result in race conditions, you can clear the 5425 information on addressing race conditions, see the
5535 PARALLEL_MAKE 5426 ":ref:`dev-manual/dev-manual-common-tasks:debugging parallel make races`"
5536 variable within the recipe as a workaround. For information on 5427 section in the Yocto Project Development Tasks Manual.
5537 addressing race conditions, see the "
5538 Debugging Parallel Make Races
5539 " section in the Yocto Project Development Tasks Manual.
5540 5428
5541 For single socket systems (i.e. one CPU), you should not have to 5429 For single socket systems (i.e. one CPU), you should not have to
5542 override this variable to gain optimal parallelism during builds. 5430 override this variable to gain optimal parallelism during builds.
@@ -5623,9 +5511,7 @@ system and gives an overview of their function and contents.
5623 5511
5624 .. note:: 5512 .. note::
5625 5513
5626 When using the 5514 When using the ``PKG`` variable, you must use a package name override.
5627 PKG
5628 variable, you must use a package name override.
5629 5515
5630 For example, when the :ref:`debian <ref-classes-debian>` class 5516 For example, when the :ref:`debian <ref-classes-debian>` class
5631 renames the output package, it does so by setting 5517 renames the output package, it does so by setting
@@ -5768,14 +5654,11 @@ system and gives an overview of their function and contents.
5768 5654
5769 .. note:: 5655 .. note::
5770 5656
5771 The OpenEmbedded build system does not need the aid of 5657 The OpenEmbedded build system does not need the aid of ``PR``
5772 PR
5773 to know when to rebuild a recipe. The build system uses the task 5658 to know when to rebuild a recipe. The build system uses the task
5774 input checksums 5659 :ref:`input checksums <overview-checksums>` along with the
5775 along with the 5660 :ref:`stamp <structure-build-tmp-stamps>` and
5776 stamp 5661 :ref:`overview-manual/overview-manual-concepts:shared state cache`
5777 and
5778 shared state cache
5779 mechanisms. 5662 mechanisms.
5780 5663
5781 The ``PR`` variable primarily becomes significant when a package 5664 The ``PR`` variable primarily becomes significant when a package
@@ -5790,8 +5673,7 @@ system and gives an overview of their function and contents.
5790 5673
5791 .. note:: 5674 .. note::
5792 5675
5793 PR 5676 ``PR`` does not need to be increased for changes that do not change the
5794 does not need to be increased for changes that do not change the
5795 package contents or metadata. 5677 package contents or metadata.
5796 5678
5797 Because manually managing ``PR`` can be cumbersome and error-prone, 5679 Because manually managing ``PR`` can be cumbersome and error-prone,
@@ -5826,17 +5708,11 @@ system and gives an overview of their function and contents.
5826 5708
5827 .. note:: 5709 .. note::
5828 5710
5829 If you use a 5711 If you use a ``virtual/\*`` item with ``PREFERRED_PROVIDER``, then any
5830 virtual/\* 5712 recipe that :term:`PROVIDES` that item but is not selected (defined)
5831 item with 5713 by ``PREFERRED_PROVIDER`` is prevented from building, which is usually
5832 PREFERRED_PROVIDER 5714 desirable since this mechanism is designed to select between mutually
5833 , then any recipe that 5715 exclusive alternative providers.
5834 PROVIDES
5835 that item but is not selected (defined) by
5836 PREFERRED_PROVIDER
5837 is prevented from building, which is usually desirable since this
5838 mechanism is designed to select between mutually exclusive
5839 alternative providers.
5840 5716
5841 :term:`PREFERRED_VERSION` 5717 :term:`PREFERRED_VERSION`
5842 If multiple versions of recipes exist, this variable determines which 5718 If multiple versions of recipes exist, this variable determines which
@@ -5897,8 +5773,8 @@ system and gives an overview of their function and contents.
5897 5773
5898 .. note:: 5774 .. note::
5899 5775
5900 The \_forcevariable override is not handled specially. This override 5776 The ``\_forcevariable`` override is not handled specially. This override
5901 only works because the default value of OVERRIDES includes "forcevariable". 5777 only works because the default value of ``OVERRIDES`` includes "forcevariable".
5902 5778
5903 :term:`PREMIRRORS` 5779 :term:`PREMIRRORS`
5904 Specifies additional paths from which the OpenEmbedded build system 5780 Specifies additional paths from which the OpenEmbedded build system
@@ -5988,9 +5864,7 @@ system and gives an overview of their function and contents.
5988 .. note:: 5864 .. note::
5989 5865
5990 Given that a recipe's own recipe name is already implicitly in its 5866 Given that a recipe's own recipe name is already implicitly in its
5991 own 5867 own PROVIDES list, it is unnecessary to add aliases with the "+=" operator;
5992 PROVIDES
5993 list, it is unnecessary to add aliases with the "+=" operator;
5994 using a simple assignment will be sufficient. In other words, 5868 using a simple assignment will be sufficient. In other words,
5995 while you could write: 5869 while you could write:
5996 :: 5870 ::
@@ -6122,8 +5996,15 @@ system and gives an overview of their function and contents.
6122 5996
6123 RCONFLICTS_${PN} = "package (operator version)" 5997 RCONFLICTS_${PN} = "package (operator version)"
6124 5998
6125 For ``operator``, you can specify the following: = < > <= 5999 For ``operator``, you can specify the following:
6126 >= For example, the following sets up a dependency on version 1.2 or 6000
6001 - =
6002 - <
6003 - >
6004 - <=
6005 - >=
6006
6007 For example, the following sets up a dependency on version 1.2 or
6127 greater of the package ``foo``: 6008 greater of the package ``foo``:
6128 :: 6009 ::
6129 6010
@@ -6149,7 +6030,7 @@ system and gives an overview of their function and contents.
6149 The practical effect of the above ``RDEPENDS`` assignment is that 6030 The practical effect of the above ``RDEPENDS`` assignment is that
6150 ``bar`` and ``baz`` will be declared as dependencies inside the 6031 ``bar`` and ``baz`` will be declared as dependencies inside the
6151 package ``foo`` when it is written out by one of the 6032 package ``foo`` when it is written out by one of the
6152 ```do_package_write_*`` <#ref-tasks-package_write_deb>`__ tasks. 6033 :ref:`do_package_write_\* <ref-tasks-package_write_deb>` tasks.
6153 Exactly how this is done depends on which package format is used, 6034 Exactly how this is done depends on which package format is used,
6154 which is determined by 6035 which is determined by
6155 :term:`PACKAGE_CLASSES`. When the 6036 :term:`PACKAGE_CLASSES`. When the
@@ -6188,19 +6069,11 @@ system and gives an overview of their function and contents.
6188 6069
6189 .. note:: 6070 .. note::
6190 6071
6191 RDEPENDS_${PN}-dev 6072 ``RDEPENDS_${PN}-dev`` includes ``${``\ :term:`PN`\ ``}``
6192 includes
6193 ${
6194 PN
6195 }
6196 by default. This default is set in the BitBake configuration file 6073 by default. This default is set in the BitBake configuration file
6197 ( 6074 (``meta/conf/bitbake.conf``). Be careful not to accidentally remove
6198 meta/conf/bitbake.conf 6075 ``${PN}`` when modifying ``RDEPENDS_${PN}-dev``. Use the "+=" operator
6199 ). Be careful not to accidentally remove 6076 rather than the "=" operator.
6200 ${PN}
6201 when modifying
6202 RDEPENDS_${PN}-dev
6203 . Use the "+=" operator rather than the "=" operator.
6204 6077
6205 The package names you use with ``RDEPENDS`` must appear as they would 6078 The package names you use with ``RDEPENDS`` must appear as they would
6206 in the ``PACKAGES`` variable. The :term:`PKG` variable 6079 in the ``PACKAGES`` variable. The :term:`PKG` variable
@@ -6219,14 +6092,20 @@ system and gives an overview of their function and contents.
6219 6092
6220 RDEPENDS_${PN} = "package (operator version)" 6093 RDEPENDS_${PN} = "package (operator version)"
6221 6094
6222 For operator, you can specify the following: = < > <= >= For version, 6095 For ``operator``, you can specify the following:
6223 provide the version number. 6096
6097 - =
6098 - <
6099 - >
6100 - <=
6101 - >=
6102
6103 For version, provide the version number.
6224 6104
6225 .. note:: 6105 .. note::
6226 6106
6227 You can use 6107 You can use ``EXTENDPKGV`` to provide a full package version
6228 EXTENDPKGV 6108 specification.
6229 to provide a full package version specification.
6230 6109
6231 For example, the following sets up a dependency on version 1.2 or 6110 For example, the following sets up a dependency on version 1.2 or
6232 greater of the package ``foo``: 6111 greater of the package ``foo``:
@@ -6355,9 +6234,7 @@ system and gives an overview of their function and contents.
6355 6234
6356 .. note:: 6235 .. note::
6357 6236
6358 A package's own name is implicitly already in its 6237 A package's own name is implicitly already in its ``RPROVIDES`` list.
6359 RPROVIDES
6360 list.
6361 6238
6362 As with all package-controlling variables, you must always use the 6239 As with all package-controlling variables, you must always use the
6363 variable in conjunction with a package name override. Here is an 6240 variable in conjunction with a package name override. Here is an
@@ -6546,13 +6423,8 @@ system and gives an overview of their function and contents.
6546 6423
6547 .. note:: 6424 .. note::
6548 6425
6549 The 6426 The ``SDK_DIR`` directory is a temporary directory as it is part of
6550 SDK_DIR 6427 ``WORKDIR``. The final output directory is :term:`SDK_DEPLOY`.
6551 directory is a temporary directory as it is part of
6552 WORKDIR
6553 . The final output directory is
6554 SDK_DEPLOY
6555 .
6556 6428
6557 :term:`SDK_EXT_TYPE` 6429 :term:`SDK_EXT_TYPE`
6558 Controls whether or not shared state artifacts are copied into the 6430 Controls whether or not shared state artifacts are copied into the
@@ -6563,9 +6435,8 @@ system and gives an overview of their function and contents.
6563 .. note:: 6435 .. note::
6564 6436
6565 If you set the variable to "minimal", you need to ensure 6437 If you set the variable to "minimal", you need to ensure
6566 SSTATE_MIRRORS 6438 :term:`SSTATE_MIRRORS` is set in the SDK's configuration to enable the
6567 is set in the SDK's configuration to enable the artifacts to be 6439 artifacts to be fetched as needed.
6568 fetched as needed.
6569 6440
6570 :term:`SDK_HOST_MANIFEST` 6441 :term:`SDK_HOST_MANIFEST`
6571 The manifest file for the host part of the SDK. This file lists all 6442 The manifest file for the host part of the SDK. This file lists all
@@ -6594,8 +6465,7 @@ system and gives an overview of their function and contents.
6594 6465
6595 .. note:: 6466 .. note::
6596 6467
6597 Enabling the 6468 Enabling the ``SDK_INCLUDE_PKGDATA``
6598 SDK_INCLUDE_PKGDATA
6599 variable significantly increases build time because all of world 6469 variable significantly increases build time because all of world
6600 needs to be built. Enabling the variable also slightly increases 6470 needs to be built. Enabling the variable also slightly increases
6601 the size of the extensible SDK. 6471 the size of the extensible SDK.
@@ -6702,9 +6572,9 @@ system and gives an overview of their function and contents.
6702 6572
6703 .. note:: 6573 .. note::
6704 6574
6705 The SDK_OUTPUT directory is a temporary directory as it is part of 6575 The ``SDK_OUTPUT`` directory is a temporary directory as it is part of
6706 WORKDIR by way of SDK_DIR. The final output directory is 6576 :term:`WORKDIR` by way of :term:`SDK_DIR`. The final output directory is
6707 SDK_DEPLOY. 6577 :term:`SDK_DEPLOY`.
6708 6578
6709 :term:`SDK_PACKAGE_ARCHS` 6579 :term:`SDK_PACKAGE_ARCHS`
6710 Specifies a list of architectures compatible with the SDK machine. 6580 Specifies a list of architectures compatible with the SDK machine.
@@ -6859,8 +6729,7 @@ system and gives an overview of their function and contents.
6859 6729
6860 .. note:: 6730 .. note::
6861 6731
6862 You cannot set the 6732 You cannot set the ``SDKMACHINE``
6863 SDKMACHINE
6864 variable in your distribution configuration file. If you do, the 6733 variable in your distribution configuration file. If you do, the
6865 configuration will not take affect. 6734 configuration will not take affect.
6866 6735
@@ -6900,11 +6769,8 @@ system and gives an overview of their function and contents.
6900 6769
6901 .. note:: 6770 .. note::
6902 6771
6903 The 6772 The ``SERIAL_CONSOLE`` variable is deprecated. Please use the
6904 SERIAL_CONSOLE 6773 :term:`SERIAL_CONSOLES` variable.
6905 variable is deprecated. Please use the
6906 SERIAL_CONSOLES
6907 variable.
6908 6774
6909 :term:`SERIAL_CONSOLES` 6775 :term:`SERIAL_CONSOLES`
6910 Defines a serial console (TTY) to enable using 6776 Defines a serial console (TTY) to enable using
@@ -6996,11 +6862,8 @@ system and gives an overview of their function and contents.
6996 6862
6997 .. note:: 6863 .. note::
6998 6864
6999 You must include 6865 You must include ``conf/machine/include/soc-family.inc`` for this
7000 conf/machine/include/soc-family.inc 6866 variable to appear in :term:`MACHINEOVERRIDES`.
7001 for this variable to appear in
7002 MACHINEOVERRIDES
7003 .
7004 6867
7005 :term:`SOLIBS` 6868 :term:`SOLIBS`
7006 Defines the suffix for shared libraries used on the target platform. 6869 Defines the suffix for shared libraries used on the target platform.
@@ -7033,8 +6896,7 @@ system and gives an overview of their function and contents.
7033 6896
7034 .. note:: 6897 .. note::
7035 6898
7036 Do not set the 6899 Do not set the ``SOURCE_MIRROR_FETCH``
7037 SOURCE_MIRROR_FETCH
7038 variable unless you are creating a source mirror. In other words, 6900 variable unless you are creating a source mirror. In other words,
7039 do not set the variable during a normal build. 6901 do not set the variable during a normal build.
7040 6902
@@ -7053,9 +6915,7 @@ system and gives an overview of their function and contents.
7053 6915
7054 .. note:: 6916 .. note::
7055 6917
7056 You can specify only a single URL in 6918 You can specify only a single URL in ``SOURCE_MIRROR_URL``.
7057 SOURCE_MIRROR_URL
7058 .
7059 6919
7060 :term:`SPDXLICENSEMAP` 6920 :term:`SPDXLICENSEMAP`
7061 Maps commonly used license names to their SPDX counterparts found in 6921 Maps commonly used license names to their SPDX counterparts found in
@@ -7283,13 +7143,10 @@ system and gives an overview of their function and contents.
7283 .. note:: 7143 .. note::
7284 7144
7285 For information on limitations when inheriting the latest revision 7145 For information on limitations when inheriting the latest revision
7286 of software using 7146 of software using ``SRCREV``, see the :term:`AUTOREV` variable
7287 SRCREV 7147 description and the
7288 , see the 7148 ":ref:`automatically-incrementing-a-binary-package-revision-number`"
7289 AUTOREV 7149 section, which is in the Yocto Project Development Tasks Manual.
7290 variable description and the "
7291 Automatically Incrementing a Binary Package Revision Number
7292 " section, which is in the Yocto Project Development Tasks Manual.
7293 7150
7294 :term:`SSTATE_DIR` 7151 :term:`SSTATE_DIR`
7295 The directory for the shared state cache. 7152 The directory for the shared state cache.
@@ -7379,13 +7236,9 @@ system and gives an overview of their function and contents.
7379 .. note:: 7236 .. note::
7380 7237
7381 This style of build configuration has been largely replaced by 7238 This style of build configuration has been largely replaced by
7382 pkg-config 7239 ``pkg-config``. Consequently, if ``pkg-config`` is supported by the
7383 . Consequently, if 7240 library to which you are linking, it is recommended you use
7384 pkg-config 7241 ``pkg-config`` instead of a provided configuration script.
7385 is supported by the library to which you are linking, it is
7386 recommended you use
7387 pkg-config
7388 instead of a provided configuration script.
7389 7242
7390 :term:`STAGING_BINDIR_NATIVE` 7243 :term:`STAGING_BINDIR_NATIVE`
7391 Specifies the path to the ``/usr/bin`` subdirectory of the sysroot 7244 Specifies the path to the ``/usr/bin`` subdirectory of the sysroot
@@ -7414,15 +7267,10 @@ system and gives an overview of their function and contents.
7414 7267
7415 .. note:: 7268 .. note::
7416 7269
7417 Recipes should never write files directly under the 7270 Recipes should never write files directly under the ``STAGING_DIR``
7418 STAGING_DIR
7419 directory because the OpenEmbedded build system manages the 7271 directory because the OpenEmbedded build system manages the
7420 directory automatically. Instead, files should be installed to 7272 directory automatically. Instead, files should be installed to
7421 ${ 7273 ``${``\ :term:`D`\ ``}`` within your recipe's :ref:`ref-tasks-install`
7422 D
7423 }
7424 within your recipe's
7425 do_install
7426 task and then the OpenEmbedded build system will stage a subset of 7274 task and then the OpenEmbedded build system will stage a subset of
7427 those files into the sysroot. 7275 those files into the sysroot.
7428 7276
@@ -7668,12 +7516,9 @@ system and gives an overview of their function and contents.
7668 7516
7669 .. note:: 7517 .. note::
7670 7518
7671 Programs built by 7519 Programs built by ``-native`` recipes run directly from the sysroot
7672 -native 7520 (:term:`STAGING_DIR_NATIVE`), which is why additional directories
7673 recipes run directly from the sysroot ( 7521 containing program executables and supporting files need to be staged.
7674 STAGING_DIR_NATIVE
7675 ), which is why additional directories containing program
7676 executables and supporting files need to be staged.
7677 7522
7678 :term:`SYSROOT_PREPROCESS_FUNCS` 7523 :term:`SYSROOT_PREPROCESS_FUNCS`
7679 A list of functions to execute after files are staged into the 7524 A list of functions to execute after files are staged into the
@@ -7819,14 +7664,9 @@ system and gives an overview of their function and contents.
7819 7664
7820 .. note:: 7665 .. note::
7821 7666
7822 It is a common workaround to append 7667 It is a common workaround to append :term:`LDFLAGS` to
7823 LDFLAGS 7668 ``TARGET_CC_ARCH`` in recipes that build software for the target that
7824 to 7669 would not otherwise respect the exported ``LDFLAGS`` variable.
7825 TARGET_CC_ARCH
7826 in recipes that build software for the target that would not
7827 otherwise respect the exported
7828 LDFLAGS
7829 variable.
7830 7670
7831 :term:`TARGET_CC_KERNEL_ARCH` 7671 :term:`TARGET_CC_KERNEL_ARCH`
7832 This is a specific kernel compiler flag for a CPU or Application 7672 This is a specific kernel compiler flag for a CPU or Application
@@ -7929,7 +7769,7 @@ system and gives an overview of their function and contents.
7929 7769
7930 .. note:: 7770 .. note::
7931 7771
7932 You do not need to set the TARGET_SYS variable yourself. 7772 You do not need to set the ``TARGET_SYS`` variable yourself.
7933 7773
7934 Consider these two examples: 7774 Consider these two examples:
7935 7775
@@ -7973,16 +7813,13 @@ system and gives an overview of their function and contents.
7973 7813
7974 .. note:: 7814 .. note::
7975 7815
7976 If 7816 If ``TCMODE`` is set to a value other than "default", then it is your
7977 TCMODE
7978 is set to a value other than "default", then it is your
7979 responsibility to ensure that the toolchain is compatible with the 7817 responsibility to ensure that the toolchain is compatible with the
7980 default toolchain. Using older or newer versions of these 7818 default toolchain. Using older or newer versions of these
7981 components might cause build problems. See the Release Notes for 7819 components might cause build problems. See the Release Notes for
7982 the Yocto Project release for the specific components with which 7820 the Yocto Project release for the specific components with which
7983 the toolchain must be compatible. To access the Release Notes, go 7821 the toolchain must be compatible. To access the Release Notes, go
7984 to the 7822 to the :yocto_home:`Downloads </software-overview/downloads>`
7985 Downloads
7986 page on the Yocto Project website and click on the "RELEASE 7823 page on the Yocto Project website and click on the "RELEASE
7987 INFORMATION" link for the appropriate release. 7824 INFORMATION" link for the appropriate release.
7988 7825
@@ -8026,11 +7863,8 @@ system and gives an overview of their function and contents.
8026 7863
8027 .. note:: 7864 .. note::
8028 7865
8029 Actual test results reside in the task log ( 7866 Actual test results reside in the task log (``log.do_testimage``),
8030 log.do_testimage 7867 which is in the ``${WORKDIR}/temp/`` directory.
8031 ), which is in the
8032 ${WORKDIR}/temp/
8033 directory.
8034 7868
8035 :term:`TEST_POWERCONTROL_CMD` 7869 :term:`TEST_POWERCONTROL_CMD`
8036 For automated hardware testing, specifies the command to use to 7870 For automated hardware testing, specifies the command to use to
@@ -8089,12 +7923,9 @@ system and gives an overview of their function and contents.
8089 7923
8090 .. note:: 7924 .. note::
8091 7925
8092 The 7926 The ``TEST_SERVER_IP`` variable is only used for a small number of
8093 TEST_SERVER_IP 7927 tests such as the "dnf" test suite, which needs to download packages
8094 variable is only used for a small number of tests such as the 7928 from ``WORKDIR/oe-rootfs-repo``.
8095 "dnf" test suite, which needs to download packages from
8096 WORKDIR/oe-rootfs-repo
8097 .
8098 7929
8099 :term:`TEST_SUITES` 7930 :term:`TEST_SUITES`
8100 An ordered list of tests (modules) to run against an image when 7931 An ordered list of tests (modules) to run against an image when
@@ -8169,8 +8000,7 @@ system and gives an overview of their function and contents.
8169 .. note:: 8000 .. note::
8170 8001
8171 This argument is defined in 8002 This argument is defined in
8172 meta/lib/oeqa/controllers/simpleremote.py 8003 ``meta/lib/oeqa/controllers/simpleremote.py``.
8173 .
8174 8004
8175 For information on running tests on hardware, see the 8005 For information on running tests on hardware, see the
8176 ":ref:`hardware-image-enabling-tests`" 8006 ":ref:`hardware-image-enabling-tests`"
@@ -8304,7 +8134,7 @@ system and gives an overview of their function and contents.
8304 :term:`TOPDIR` 8134 :term:`TOPDIR`
8305 The top-level :term:`Build Directory`. BitBake 8135 The top-level :term:`Build Directory`. BitBake
8306 automatically sets this variable when you initialize your build 8136 automatically sets this variable when you initialize your build
8307 environment using ````` <#structure-core-script>`__. 8137 environment using :ref:`structure-core-script`.
8308 8138
8309 :term:`TRANSLATED_TARGET_ARCH` 8139 :term:`TRANSLATED_TARGET_ARCH`
8310 A sanitized version of :term:`TARGET_ARCH`. This 8140 A sanitized version of :term:`TARGET_ARCH`. This
@@ -8728,20 +8558,11 @@ system and gives an overview of their function and contents.
8728 .. note:: 8558 .. note::
8729 8559
8730 There is a difference in behavior between setting 8560 There is a difference in behavior between setting
8731 USERADD_ERROR_DYNAMIC 8561 ``USERADD_ERROR_DYNAMIC`` to ``error`` and setting it to ``warn``.
8732 to 8562 When it is set to ``warn``, the build system will report a warning for
8733 error 8563 every undefined ``uid`` and ``gid`` in any recipe. But when it is set
8734 and setting it to 8564 to ``error``, it will only report errors for recipes that are actually
8735 warn 8565 built.
8736 . When it is set to
8737 warn
8738 , the build system will report a warning for every undefined
8739 uid
8740 and
8741 gid
8742 in any recipe. But when it is set to
8743 error
8744 , it will only report errors for recipes that are actually built.
8745 This saves you from having to add static IDs for recipes that you 8566 This saves you from having to add static IDs for recipes that you
8746 know will never be built. 8567 know will never be built.
8747 8568
@@ -8761,12 +8582,8 @@ system and gives an overview of their function and contents.
8761 8582
8762 .. note:: 8583 .. note::
8763 8584
8764 Setting the 8585 Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids"
8765 USERADDEXTENSION 8586 causes the build system to use static ``gid`` values.
8766 variable to "useradd-staticids" causes the build system to use
8767 static
8768 gid
8769 values.
8770 8587
8771 :term:`USERADD_PACKAGES` 8588 :term:`USERADD_PACKAGES`
8772 When inheriting the :ref:`useradd <ref-classes-useradd>` class, 8589 When inheriting the :ref:`useradd <ref-classes-useradd>` class,
@@ -8782,15 +8599,9 @@ system and gives an overview of their function and contents.
8782 8599
8783 .. note:: 8600 .. note::
8784 8601
8785 It follows that if you are going to use the 8602 It follows that if you are going to use the ``USERADD_PACKAGES``
8786 USERADD_PACKAGES 8603 variable, you need to set one or more of the :term:`USERADD_PARAM`,
8787 variable, you need to set one or more of the 8604 :term:`GROUPADD_PARAM`, or :term:`GROUPMEMS_PARAM` variables.
8788 USERADD_PARAM
8789 ,
8790 GROUPADD_PARAM
8791 , or
8792 GROUPMEMS_PARAM
8793 variables.
8794 8605
8795 :term:`USERADD_PARAM` 8606 :term:`USERADD_PARAM`
8796 When inheriting the :ref:`useradd <ref-classes-useradd>` class, 8607 When inheriting the :ref:`useradd <ref-classes-useradd>` class,
@@ -8824,12 +8635,8 @@ system and gives an overview of their function and contents.
8824 8635
8825 .. note:: 8636 .. note::
8826 8637
8827 Setting the 8638 Setting the :term:`USERADDEXTENSION` variable to "useradd-staticids"
8828 USERADDEXTENSION 8639 causes the build system to use static ``uid`` values.
8829 variable to "useradd-staticids" causes the build system to use
8830 static
8831 uid
8832 values.
8833 8640
8834 :term:`USERADDEXTENSION` 8641 :term:`USERADDEXTENSION`
8835 When set to "useradd-staticids", causes the OpenEmbedded build system 8642 When set to "useradd-staticids", causes the OpenEmbedded build system
@@ -8842,13 +8649,9 @@ system and gives an overview of their function and contents.
8842 8649
8843 .. note:: 8650 .. note::
8844 8651
8845 Setting this variable to use static 8652 Setting this variable to use static ``uid`` and ``gid``
8846 uid
8847 and
8848 gid
8849 values causes the OpenEmbedded build system to employ the 8653 values causes the OpenEmbedded build system to employ the
8850 useradd-staticids 8654 :ref:`ref-classes-useradd` class.
8851 class.
8852 8655
8853 If you use static ``uid`` and ``gid`` information, you must also 8656 If you use static ``uid`` and ``gid`` information, you must also
8854 specify the ``files/passwd`` and ``files/group`` files by setting the 8657 specify the ``files/passwd`` and ``files/group`` files by setting the
@@ -8919,22 +8722,13 @@ system and gives an overview of their function and contents.
8919 8722
8920 The actual directory depends on several things: 8723 The actual directory depends on several things:
8921 8724
8922 - TMPDIR 8725 - :term:`TMPDIR`: The top-level build output directory
8923 : The top-level build output directory 8726 - :term:`MULTIMACH_TARGET_SYS`: The target system identifier
8924 - MULTIMACH_TARGET_SYS 8727 - :term:`PN`: The recipe name
8925 : The target system identifier 8728 - :term:`EXTENDPE`: The epoch - (if :term:`PE` is not specified, which
8926 - PN 8729 is usually the case for most recipes, then `EXTENDPE` is blank)
8927 : The recipe name 8730 - :term:`PV`: The recipe version
8928 - EXTENDPE 8731 - :term:`PR`: The recipe revision
8929 : The epoch - (if
8930 PE
8931 is not specified, which is usually the case for most recipes, then
8932 EXTENDPE
8933 is blank)
8934 - PV
8935 : The recipe version
8936 - PR
8937 : The recipe revision
8938 8732
8939 As an example, assume a Source Directory top-level folder name 8733 As an example, assume a Source Directory top-level folder name
8940 ``poky``, a default Build Directory at ``poky/build``, and a 8734 ``poky``, a default Build Directory at ``poky/build``, and a
diff --git a/documentation/ref-manual/resources.rst b/documentation/ref-manual/resources.rst
index f90182b9e3..2ef182fb1c 100644
--- a/documentation/ref-manual/resources.rst
+++ b/documentation/ref-manual/resources.rst
@@ -65,27 +65,27 @@ and announcements. To subscribe to one of the following mailing lists,
65click on the appropriate URL in the following list and follow the 65click on the appropriate URL in the following list and follow the
66instructions: 66instructions:
67 67
68- https://lists.yoctoproject.org/g/yocto - General Yocto Project 68- :yocto_lists:`/g/yocto` - General Yocto Project
69 discussion mailing list. 69 discussion mailing list.
70 70
71- https://lists.openembedded.org/g/openembedded-core - Discussion mailing 71- :oe_lists:`/g/openembedded-core` - Discussion mailing
72 list about OpenEmbedded-Core (the core metadata). 72 list about OpenEmbedded-Core (the core metadata).
73 73
74- https://lists.openembedded.org/g/openembedded-devel - Discussion 74- :oe_lists:`/g/openembedded-devel` - Discussion
75 mailing list about OpenEmbedded. 75 mailing list about OpenEmbedded.
76 76
77- https://lists.openembedded.org/g/bitbake-devel - Discussion mailing 77- :oe_lists:`/g/bitbake-devel` - Discussion mailing
78 list about the :term:`BitBake` build tool. 78 list about the :term:`BitBake` build tool.
79 79
80- https://lists.yoctoproject.org/g/poky - Discussion mailing list 80- :yocto_lists:`/g/poky` - Discussion mailing list
81 about `Poky <#poky>`__. 81 about :term:`Poky`.
82 82
83- https://lists.yoctoproject.org/g/yocto-announce - Mailing list to 83- :yocto_lists:`/g/yocto-announce` - Mailing list to
84 receive official Yocto Project release and milestone announcements. 84 receive official Yocto Project release and milestone announcements.
85 85
86For more Yocto Project-related mailing lists, see the 86For more Yocto Project-related mailing lists, see the
87Yocto Project Website 87:yocto_home:`Yocto Project Website <>`.
88. 88
89.. _resources-irc: 89.. _resources-irc:
90 90
91Internet Relay Chat (IRC) 91Internet Relay Chat (IRC)
@@ -113,12 +113,12 @@ Here is a list of resources you might find helpful:
113 planning, release engineering, QA & automation, a reference site map, 113 planning, release engineering, QA & automation, a reference site map,
114 and other resources related to the Yocto Project. 114 and other resources related to the Yocto Project.
115 115
116- `OpenEmbedded <http://www.openembedded.org/>`__\ *:* The build system used by the 116- :oe_home:`OpenEmbedded <>`\ *:* The build system used by the
117 Yocto Project. This project is the upstream, generic, embedded 117 Yocto Project. This project is the upstream, generic, embedded
118 distribution from which the Yocto Project derives its build system 118 distribution from which the Yocto Project derives its build system
119 (Poky) and to which it contributes. 119 (Poky) and to which it contributes.
120 120
121- `BitBake <http://www.openembedded.org/wiki/BitBake>`__\ *:* The tool 121- :oe_home:`BitBake </wiki/BitBake>`\ *:* The tool
122 used to process metadata. 122 used to process metadata.
123 123
124- :doc:`BitBake User Manual <bitbake:index>`\ *:* A comprehensive 124- :doc:`BitBake User Manual <bitbake:index>`\ *:* A comprehensive
@@ -155,7 +155,7 @@ Here is a list of resources you might find helpful:
155 manual provides reference material such as variable, task, and class 155 manual provides reference material such as variable, task, and class
156 descriptions. 156 descriptions.
157 157
158- `Yocto Project Mega-Manual <https://docs.yoctoproject.org/singleindex.html>`__\ *:* This manual 158- :yocto_docs:`Yocto Project Mega-Manual </singleindex.html>`\ *:* This manual
159 is simply a single HTML file comprised of the bulk of the Yocto 159 is simply a single HTML file comprised of the bulk of the Yocto
160 Project manuals. The Mega-Manual primarily exists as a vehicle by 160 Project manuals. The Mega-Manual primarily exists as a vehicle by
161 which you can easily search for phrases and terms used in the Yocto 161 which you can easily search for phrases and terms used in the Yocto
@@ -180,7 +180,7 @@ Here is a list of resources you might find helpful:
180 the Yocto Project website and click on the "RELEASE INFORMATION" link 180 the Yocto Project website and click on the "RELEASE INFORMATION" link
181 for the appropriate release. 181 for the appropriate release.
182 182
183- `Bugzilla <https://bugzilla.yoctoproject.org>`__\ *:* The bug tracking application 183- :yocto_bugs:`Bugzilla <>`\ *:* The bug tracking application
184 the Yocto Project uses. If you find problems with the Yocto Project, 184 the Yocto Project uses. If you find problems with the Yocto Project,
185 you should report them using this application. 185 you should report them using this application.
186 186
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-18 10:47:03 +0000