summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-27 17:38:09 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:33 +0100
commit424567d629b08785a6594d16427ee0fa8c31f384 (patch)
tree4985979745b1c5601f7a82c662042fb745bfd7db /documentation/ref-manual
parent4bf6fc5281d1976ad7113c91a93995406cfab429 (diff)
downloadpoky-424567d629b08785a6594d16427ee0fa8c31f384.tar.gz
sphinx: manual updates for some links
Some links were not found by the regexp, especially because of they are spanning across multiple lines. This patch is a manual fixup for these patterns. (From yocto-docs rev: 7a5cf8b372903d959d4a1f0882e6198f31f3cba5) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/faq.rst11
-rw-r--r--documentation/ref-manual/migration.rst12
-rw-r--r--documentation/ref-manual/ref-classes.rst20
-rw-r--r--documentation/ref-manual/ref-images.rst4
-rw-r--r--documentation/ref-manual/ref-release-process.rst2
-rw-r--r--documentation/ref-manual/ref-structure.rst15
-rw-r--r--documentation/ref-manual/ref-system-requirements.rst4
-rw-r--r--documentation/ref-manual/ref-tasks.rst2
-rw-r--r--documentation/ref-manual/ref-terms.rst4
-rw-r--r--documentation/ref-manual/ref-variables.rst117
10 files changed, 93 insertions, 98 deletions
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index 07244a0311..3e8127b927 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -256,8 +256,7 @@ situation changes, the team will not support spaces in pathnames.
256**A:** The toolchain configuration is very flexible and customizable. It 256**A:** The toolchain configuration is very flexible and customizable. It
257is primarily controlled with the ``TCMODE`` variable. This variable 257is primarily controlled with the ``TCMODE`` variable. This variable
258controls which ``tcmode-*.inc`` file to include from the 258controls which ``tcmode-*.inc`` file to include from the
259``meta/conf/distro/include`` directory within the `Source 259``meta/conf/distro/include`` directory within the :term:`Source Directory`.
260Directory <#source-directory>`__.
261 260
262The default value of ``TCMODE`` is "default", which tells the 261The default value of ``TCMODE`` is "default", which tells the
263OpenEmbedded build system to use its internally built toolchain (i.e. 262OpenEmbedded build system to use its internally built toolchain (i.e.
@@ -342,8 +341,8 @@ redirect requests through proxy servers.
342**A:** Yes - you can easily do this. When you use BitBake to build an 341**A:** Yes - you can easily do this. When you use BitBake to build an
343image, all the build output goes into the directory created when you run 342image, all the build output goes into the directory created when you run
344the build environment setup script (i.e. 343the build environment setup script (i.e.
345````` <#structure-core-script>`__). By default, this `Build 344````` <#structure-core-script>`__). By default, this :term:`Build Directory`
346Directory <#build-directory>`__ is named ``build`` but can be named 345is named ``build`` but can be named
347anything you want. 346anything you want.
348 347
349Within the Build Directory, is the ``tmp`` directory. To remove all the 348Within the Build Directory, is the ``tmp`` directory. To remove all the
@@ -379,8 +378,8 @@ system of that image. Thus, the build system provides a value of
379"/usr/bin" for ``bindir``, a value of "/usr/lib" for ``libdir``, and so 378"/usr/bin" for ``bindir``, a value of "/usr/lib" for ``libdir``, and so
380forth. 379forth.
381 380
382Meanwhile, ``DESTDIR`` is a path within the `Build 381Meanwhile, ``DESTDIR`` is a path within the :term:`Build Directory`.
383Directory <#build-directory>`__. However, when the recipe builds a 382However, when the recipe builds a
384native program (i.e. one that is intended to run on the build machine), 383native program (i.e. one that is intended to run on the build machine),
385that program is never installed directly to the build machine's root 384that program is never installed directly to the build machine's root
386file system. Consequently, the build system uses paths within the Build 385file system. Consequently, the build system uses paths within the Build
diff --git a/documentation/ref-manual/migration.rst b/documentation/ref-manual/migration.rst
index 1d4d53647f..31959b2845 100644
--- a/documentation/ref-manual/migration.rst
+++ b/documentation/ref-manual/migration.rst
@@ -731,7 +731,7 @@ Automated Image Testing
731----------------------- 731-----------------------
732 732
733A new automated image testing framework has been added through the 733A new automated image testing framework has been added through the
734```testimage.bbclass`` <#ref-classes-testimage*>`__ class. This 734:ref:`testimage.bbclass <ref-classes-testimage*>` class. This
735framework replaces the older ``imagetest-qemu`` framework. 735framework replaces the older ``imagetest-qemu`` framework.
736 736
737You can learn more about performing automated image tests in the 737You can learn more about performing automated image tests in the
@@ -1077,7 +1077,7 @@ future releases the :ref:`autotools <ref-classes-autotools>` class
1077will enable a separate build directory by default as well. Recipes 1077will enable a separate build directory by default as well. Recipes
1078building Autotools-based software that fails to build with a separate 1078building Autotools-based software that fails to build with a separate
1079build directory should be changed to inherit from the 1079build directory should be changed to inherit from the
1080```autotools-brokensep`` <#ref-classes-autotools>`__ class instead of 1080:ref:`autotools-brokensep <ref-classes-autotools>` class instead of
1081the ``autotools`` or ``autotools_stage``\ classes. 1081the ``autotools`` or ``autotools_stage``\ classes.
1082 1082
1083.. _migration-1.6-building-qemu-native: 1083.. _migration-1.6-building-qemu-native:
@@ -1305,7 +1305,7 @@ occurred:
1305 However, if the software is not capable of being built in this 1305 However, if the software is not capable of being built in this
1306 manner, you will need to either patch the software so that it can 1306 manner, you will need to either patch the software so that it can
1307 build separately, or you will need to change the recipe to inherit 1307 build separately, or you will need to change the recipe to inherit
1308 the ```autotools-brokensep`` <#ref-classes-autotools>`__ class 1308 the :ref:`autotools-brokensep <ref-classes-autotools>` class
1309 instead of the ``autotools`` or ``autotools_stage`` classes. 1309 instead of the ``autotools`` or ``autotools_stage`` classes.
1310 1310
1311- *The ``--foreign`` option is no longer passed to ``automake`` when 1311- *The ``--foreign`` option is no longer passed to ``automake`` when
@@ -2048,7 +2048,7 @@ time.
2048A minor part of this restructuring is that the post-processing 2048A minor part of this restructuring is that the post-processing
2049definitions and functions have been moved from the 2049definitions and functions have been moved from the
2050:ref:`image <ref-classes-image>` class to the 2050:ref:`image <ref-classes-image>` class to the
2051```rootfs-postcommands`` <#ref-classes-rootfs*>`__ class. Functionally, 2051:ref:`rootfs-postcommands <ref-classes-rootfs*>` class. Functionally,
2052however, they remain unchanged. 2052however, they remain unchanged.
2053 2053
2054.. _migration-2.1-removed-recipes: 2054.. _migration-2.1-removed-recipes:
@@ -3973,7 +3973,7 @@ For names of recipes removed because of this repository change, see the
3973 3973
3974Previously, it was possible for Python recipes that inherited the 3974Previously, it was possible for Python recipes that inherited the
3975:ref:`distutils <ref-classes-distutils>` and 3975:ref:`distutils <ref-classes-distutils>` and
3976```distutils3`` <#ref-classes-distutils3>`__ classes to fetch code 3976:ref:`distutils3 <ref-classes-distutils3>` classes to fetch code
3977during the :ref:`ref-tasks-configure` task to satisfy 3977during the :ref:`ref-tasks-configure` task to satisfy
3978dependencies mentioned in ``setup.py`` if those dependencies were not 3978dependencies mentioned in ``setup.py`` if those dependencies were not
3979provided in the sysroot (i.e. recipes providing the dependencies were 3979provided in the sysroot (i.e. recipes providing the dependencies were
@@ -4183,7 +4183,7 @@ This section provides information about automatic testing changes:
4183 practices now dictate that you use the 4183 practices now dictate that you use the
4184 :term:`IMAGE_CLASSES` variable rather than the 4184 :term:`IMAGE_CLASSES` variable rather than the
4185 :term:`INHERIT` variable when you inherit the 4185 :term:`INHERIT` variable when you inherit the
4186 ```testimage`` <#ref-classes-testimage*>`__ and 4186 :ref:`testimage <ref-classes-testimage*>` and
4187 :ref:`testsdk <ref-classes-testsdk>` classes used for automatic 4187 :ref:`testsdk <ref-classes-testsdk>` classes used for automatic
4188 testing. 4188 testing.
4189 4189
diff --git a/documentation/ref-manual/ref-classes.rst b/documentation/ref-manual/ref-classes.rst
index 6449b49cd4..4b4f3bac5a 100644
--- a/documentation/ref-manual/ref-classes.rst
+++ b/documentation/ref-manual/ref-classes.rst
@@ -14,8 +14,8 @@ some default behavior.
14Any :term:`Metadata` usually found in a recipe can also be 14Any :term:`Metadata` usually found in a recipe can also be
15placed in a class file. Class files are identified by the extension 15placed in a class file. Class files are identified by the extension
16``.bbclass`` and are usually placed in a ``classes/`` directory beneath 16``.bbclass`` and are usually placed in a ``classes/`` directory beneath
17the ``meta*/`` directory found in the `Source 17the ``meta*/`` directory found in the :term:`Source Directory`.
18Directory <#source-directory>`__. Class files can also be pointed to by 18Class files can also be pointed to by
19:term:`BUILDDIR` (e.g. ``build/``) in the same way as 19:term:`BUILDDIR` (e.g. ``build/``) in the same way as
20``.conf`` files in the ``conf`` directory. Class files are searched for 20``.conf`` files in the ``conf`` directory. Class files are searched for
21in :term:`BBPATH` using the same method by which ``.conf`` 21in :term:`BBPATH` using the same method by which ``.conf``
@@ -555,7 +555,7 @@ used.
555 ``distutils`` class in their recipes. 555 ``distutils`` class in their recipes.
556 556
557- Extensions that use build systems based on ``setuptools3`` require 557- Extensions that use build systems based on ``setuptools3`` require
558 the ```setuptools3`` <#ref-classes-setuptools>`__ class in their 558 the :ref:`setuptools3 <ref-classes-setuptools>` class in their
559 recipes. 559 recipes.
560 560
561The ``distutils3*`` classes either inherit their corresponding 561The ``distutils3*`` classes either inherit their corresponding
@@ -592,8 +592,8 @@ ${WORKDIR}/${BPN}/{PV}/ See these variables for more information:
592:term:`PV`, 592:term:`PV`,
593 593
594For more information on the ``externalsrc`` class, see the comments in 594For more information on the ``externalsrc`` class, see the comments in
595``meta/classes/externalsrc.bbclass`` in the `Source 595``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`.
596Directory <#source-directory>`__. For information on how to use the 596For information on how to use the
597``externalsrc`` class, see the "`Building Software from an External 597``externalsrc`` class, see the "`Building Software from an External
598Source <&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source>`__" 598Source <&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source>`__"
599section in the Yocto Project Development Tasks Manual. 599section in the Yocto Project Development Tasks Manual.
@@ -1733,8 +1733,8 @@ package-specific classes:
1733 1733
1734You can control the list of resulting package formats by using the 1734You can control the list of resulting package formats by using the
1735``PACKAGE_CLASSES`` variable defined in your ``conf/local.conf`` 1735``PACKAGE_CLASSES`` variable defined in your ``conf/local.conf``
1736configuration file, which is located in the `Build 1736configuration file, which is located in the :term:`Build Directory`.
1737Directory <#build-directory>`__. When defining the variable, you can 1737When defining the variable, you can
1738specify one or more package types. Since images are generated from 1738specify one or more package types. Since images are generated from
1739packages, a packaging class is needed to enable image generation. The 1739packages, a packaging class is needed to enable image generation. The
1740first class listed in this variable is used for image generation. 1740first class listed in this variable is used for image generation.
@@ -2181,8 +2181,8 @@ recipe are no longer needed. However, by default, the build system
2181preserves these files for inspection and possible debugging purposes. If 2181preserves these files for inspection and possible debugging purposes. If
2182you would rather have these files deleted to save disk space as the 2182you would rather have these files deleted to save disk space as the
2183build progresses, you can enable ``rm_work`` by adding the following to 2183build progresses, you can enable ``rm_work`` by adding the following to
2184your ``local.conf`` file, which is found in the `Build 2184your ``local.conf`` file, which is found in the :term:`Build Directory`.
2185Directory <#build-directory>`__. INHERIT += "rm_work" If you are 2185INHERIT += "rm_work" If you are
2186modifying and building source code out of the work directory for a 2186modifying and building source code out of the work directory for a
2187recipe, enabling ``rm_work`` will potentially result in your changes to 2187recipe, enabling ``rm_work`` will potentially result in your changes to
2188the source being lost. To exclude some recipes from having their work 2188the source being lost. To exclude some recipes from having their work
@@ -2565,7 +2565,7 @@ Other classes use the ``terminal`` class anywhere a separate terminal
2565session needs to be started. For example, the 2565session needs to be started. For example, the
2566:ref:`patch <ref-classes-patch>` class assuming 2566:ref:`patch <ref-classes-patch>` class assuming
2567:term:`PATCHRESOLVE` is set to "user", the 2567:term:`PATCHRESOLVE` is set to "user", the
2568```cml1`` <#ref-classes-cml1>`__ class, and the 2568:ref:`cml1 <ref-classes-cml1>` class, and the
2569:ref:`devshell <ref-classes-devshell>` class all use the ``terminal`` 2569:ref:`devshell <ref-classes-devshell>` class all use the ``terminal``
2570class. 2570class.
2571 2571
diff --git a/documentation/ref-manual/ref-images.rst b/documentation/ref-manual/ref-images.rst
index 5aeaa43833..4eba5cdf16 100644
--- a/documentation/ref-manual/ref-images.rst
+++ b/documentation/ref-manual/ref-images.rst
@@ -27,8 +27,8 @@ image you want.
27 27
28 28
29From within the ``poky`` Git repository, you can use the following 29From within the ``poky`` Git repository, you can use the following
30command to display the list of directories within the `Source 30command to display the list of directories within the :term:`Source Directory`
31Directory <#source-directory>`__ that contain image recipe files: $ ls 31that contain image recipe files: $ ls
32meta*/recipes*/images/*.bb 32meta*/recipes*/images/*.bb
33 33
34Following is a list of supported recipes: 34Following is a list of supported recipes:
diff --git a/documentation/ref-manual/ref-release-process.rst b/documentation/ref-manual/ref-release-process.rst
index 95ec686a13..832f011918 100644
--- a/documentation/ref-manual/ref-release-process.rst
+++ b/documentation/ref-manual/ref-release-process.rst
@@ -117,7 +117,7 @@ consists of the following pieces:
117 an ARM target, did the build produce ARM binaries. If, for example, 117 an ARM target, did the build produce ARM binaries. If, for example,
118 the build produced PPC binaries then there is a problem. 118 the build produced PPC binaries then there is a problem.
119 119
120- ```testimage.bbclass`` <#ref-classes-testimage*>`__: This class 120- :ref:`testimage.bbclass <ref-classes-testimage*>`: This class
121 performs runtime testing of images after they are built. The tests 121 performs runtime testing of images after they are built. The tests
122 are usually used with `QEMU <&YOCTO_DOCS_DEV_URL;#dev-manual-qemu>`__ 122 are usually used with `QEMU <&YOCTO_DOCS_DEV_URL;#dev-manual-qemu>`__
123 to boot the images and check the combined runtime result boot 123 to boot the images and check the combined runtime result boot
diff --git a/documentation/ref-manual/ref-structure.rst b/documentation/ref-manual/ref-structure.rst
index c63900e604..a21c0bdd52 100644
--- a/documentation/ref-manual/ref-structure.rst
+++ b/documentation/ref-manual/ref-structure.rst
@@ -26,8 +26,7 @@ section in the Yocto Project Development Tasks Manual.
26Top-Level Core Components 26Top-Level Core Components
27========================= 27=========================
28 28
29This section describes the top-level components of the `Source 29This section describes the top-level components of the :term:`Source Directory`.
30Directory <#source-directory>`__.
31 30
32.. _structure-core-bitbake: 31.. _structure-core-bitbake:
33 32
@@ -57,8 +56,8 @@ Manual <&YOCTO_DOCS_BB_URL;>`__.
57 56
58This directory contains user configuration files and the output 57This directory contains user configuration files and the output
59generated by the OpenEmbedded build system in its standard configuration 58generated by the OpenEmbedded build system in its standard configuration
60where the source tree is combined with the output. The `Build 59where the source tree is combined with the output. The :term:`Build Directory`
61Directory <#build-directory>`__ is created initially when you ``source`` 60is created initially when you ``source``
62the OpenEmbedded build environment setup script (i.e. 61the OpenEmbedded build environment setup script (i.e.
63````` <#structure-core-script>`__). 62````` <#structure-core-script>`__).
64 63
@@ -175,8 +174,8 @@ creates the ``build/`` directory in your current working directory. If
175you provide a Build Directory argument when you ``source`` the script, 174you provide a Build Directory argument when you ``source`` the script,
176you direct the OpenEmbedded build system to create a Build Directory of 175you direct the OpenEmbedded build system to create a Build Directory of
177your choice. For example, the following command creates a Build 176your choice. For example, the following command creates a Build
178Directory named ``mybuilds/`` that is outside of the `Source 177Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`:
179Directory <#source-directory>`__: $ source OE_INIT_FILE ~/mybuilds The 178$ source OE_INIT_FILE ~/mybuilds The
180OpenEmbedded build system uses the template configuration files, which 179OpenEmbedded build system uses the template configuration files, which
181are found by default in the ``meta-poky/conf/`` directory in the Source 180are found by default in the ``meta-poky/conf/`` directory in the Source
182Directory. See the "`Creating a Custom Template Configuration 181Directory. See the "`Creating a Custom Template Configuration
@@ -206,8 +205,8 @@ These files are standard top-level files.
206The Build Directory - ``build/`` 205The Build Directory - ``build/``
207================================ 206================================
208 207
209The OpenEmbedded build system creates the `Build 208The OpenEmbedded build system creates the :term:`Build Directory`
210Directory <#build-directory>`__ when you run the build environment setup 209when you run the build environment setup
211script ````` <#structure-core-script>`__. If you do not give the Build 210script ````` <#structure-core-script>`__. If you do not give the Build
212Directory a specific name when you run the setup script, the name 211Directory a specific name when you run the setup script, the name
213defaults to ``build/``. 212defaults to ``build/``.
diff --git a/documentation/ref-manual/ref-system-requirements.rst b/documentation/ref-manual/ref-system-requirements.rst
index 9358a168f1..3144d303f8 100644
--- a/documentation/ref-manual/ref-system-requirements.rst
+++ b/documentation/ref-manual/ref-system-requirements.rst
@@ -348,8 +348,8 @@ installer:
348 system. 348 system.
349 349
350 Once the build completes, you can find the ``.sh`` file that installs 350 Once the build completes, you can find the ``.sh`` file that installs
351 the tools in the ``tmp/deploy/sdk`` subdirectory of the `Build 351 the tools in the ``tmp/deploy/sdk`` subdirectory of the
352 Directory <#build-directory>`__. The installer file has the string 352 :term:`Build Directory`. The installer file has the string
353 "buildtools" (or "buildtools-extended") in the name. 353 "buildtools" (or "buildtools-extended") in the name.
354 354
3553. Transfer the ``.sh`` file from the build host to the machine that 3553. Transfer the ``.sh`` file from the build host to the machine that
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index f3c698ba98..4bcd0a2d00 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -409,7 +409,7 @@ dependencies specified by :term:`DEPENDS`). See the
409 409
410Removes work files after the OpenEmbedded build system has finished with 410Removes work files after the OpenEmbedded build system has finished with
411them. You can learn more by looking at the 411them. You can learn more by looking at the
412"```rm_work.bbclass`` <#ref-classes-rm-work>`__" section. 412":ref:`rm_work.bbclass <ref-classes-rm-work>`" section.
413 413
414.. _ref-tasks-unpack: 414.. _ref-tasks-unpack:
415 415
diff --git a/documentation/ref-manual/ref-terms.rst b/documentation/ref-manual/ref-terms.rst
index 4298e04965..eacc49fc3d 100644
--- a/documentation/ref-manual/ref-terms.rst
+++ b/documentation/ref-manual/ref-terms.rst
@@ -378,8 +378,8 @@ universal, the list includes them just in case:
378 :ref:`ref-tasks-patch`, and so forth). 378 :ref:`ref-tasks-patch`, and so forth).
379 379
380 Toaster 380 Toaster
381 A web interface to the Yocto Project's `OpenEmbedded Build 381 A web interface to the Yocto Project's :term:`OpenEmbedded Build System`.
382 System <#build-system-term>`__. The interface enables you to 382 The interface enables you to
383 configure and run your builds. Information about builds is collected 383 configure and run your builds. Information about builds is collected
384 and stored in a database. For information on Toaster, see the 384 and stored in a database. For information on Toaster, see the
385 `Toaster User Manual <&YOCTO_DOCS_TOAST_URL;>`__. 385 `Toaster User Manual <&YOCTO_DOCS_TOAST_URL;>`__.
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 473b672b76..aa7f59f602 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -144,8 +144,7 @@ system and gives an overview of their function and contents.
144 = "1" # Uses environment data. ARCHIVER_MODE[recipe] = "1" # Uses 144 = "1" # Uses environment data. ARCHIVER_MODE[recipe] = "1" # Uses
145 recipe and include files. ARCHIVER_MODE[srpm] = "1" # Uses RPM 145 recipe and include files. ARCHIVER_MODE[srpm] = "1" # Uses RPM
146 package files. For information on how the variable works, see the 146 package files. For information on how the variable works, see the
147 ``meta/classes/archiver.bbclass`` file in the `Source 147 ``meta/classes/archiver.bbclass`` file in the :term:`Source Directory`.
148 Directory <#source-directory>`__.
149 148
150 AS 149 AS
151 Minimal command and arguments needed to run the assembler. 150 Minimal command and arguments needed to run the assembler.
@@ -583,8 +582,8 @@ system and gives an overview of their function and contents.
583 582
584 BBLAYERS 583 BBLAYERS
585 Lists the layers to enable during the build. This variable is defined 584 Lists the layers to enable during the build. This variable is defined
586 in the ``bblayers.conf`` configuration file in the `Build 585 in the ``bblayers.conf`` configuration file in the :term:`Build Directory`.
587 Directory <#build-directory>`__. Here is an example: BBLAYERS = " \\ 586 Here is an example: BBLAYERS = " \\
588 /home/scottrif/poky/meta \\ /home/scottrif/poky/meta-poky \\ 587 /home/scottrif/poky/meta \\ /home/scottrif/poky/meta-poky \\
589 /home/scottrif/poky/meta-yocto-bsp \\ 588 /home/scottrif/poky/meta-yocto-bsp \\
590 /home/scottrif/poky/meta-mykernel \\ " 589 /home/scottrif/poky/meta-mykernel \\ "
@@ -705,8 +704,8 @@ system and gives an overview of their function and contents.
705 . 704 .
706 705
707 For more information on how this variable works, see 706 For more information on how this variable works, see
708 ``meta/classes/binconfig.bbclass`` in the `Source 707 ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`.
709 Directory <#source-directory>`__. You can also find general 708 You can also find general
710 information on the class in the 709 information on the class in the
711 ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section. 710 ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section.
712 711
@@ -1042,8 +1041,8 @@ system and gives an overview of their function and contents.
1042 Bluetooth but you do not ever intend to use it. 1041 Bluetooth but you do not ever intend to use it.
1043 1042
1044 COMMON_LICENSE_DIR 1043 COMMON_LICENSE_DIR
1045 Points to ``meta/files/common-licenses`` in the `Source 1044 Points to ``meta/files/common-licenses`` in the
1046 Directory <#source-directory>`__, which is where generic license 1045 :term:`Source Directory`, which is where generic license
1047 files reside. 1046 files reside.
1048 1047
1049 COMPATIBLE_HOST 1048 COMPATIBLE_HOST
@@ -1391,8 +1390,8 @@ system and gives an overview of their function and contents.
1391 for an SDK (i.e. ``nativesdk-``) 1390 for an SDK (i.e. ``nativesdk-``)
1392 1391
1393 D 1392 D
1394 The destination directory. The location in the `Build 1393 The destination directory. The location in the :term:`Build Directory`
1395 Directory <#build-directory>`__ where components are installed by the 1394 where components are installed by the
1396 :ref:`ref-tasks-install` task. This location defaults 1395 :ref:`ref-tasks-install` task. This location defaults
1397 to: ${WORKDIR}/image 1396 to: ${WORKDIR}/image
1398 1397
@@ -1664,8 +1663,8 @@ system and gives an overview of their function and contents.
1664 file whose root name is the same as the variable's argument and whose 1663 file whose root name is the same as the variable's argument and whose
1665 filename extension is ``.conf``. For example, the distribution 1664 filename extension is ``.conf``. For example, the distribution
1666 configuration file for the Poky distribution is named ``poky.conf`` 1665 configuration file for the Poky distribution is named ``poky.conf``
1667 and resides in the ``meta-poky/conf/distro`` directory of the `Source 1666 and resides in the ``meta-poky/conf/distro`` directory of the
1668 Directory <#source-directory>`__. 1667 :term:`Source Directory`.
1669 1668
1670 Within that ``poky.conf`` file, the ``DISTRO`` variable is set as 1669 Within that ``poky.conf`` file, the ``DISTRO`` variable is set as
1671 follows: DISTRO = "poky" 1670 follows: DISTRO = "poky"
@@ -2296,8 +2295,8 @@ system and gives an overview of their function and contents.
2296 :term:`SRC_URI` statements. 2295 :term:`SRC_URI` statements.
2297 2296
2298 The default value for the ``FILESPATH`` variable is defined in the 2297 The default value for the ``FILESPATH`` variable is defined in the
2299 ``base.bbclass`` class found in ``meta/classes`` in the `Source 2298 ``base.bbclass`` class found in ``meta/classes`` in the
2300 Directory <#source-directory>`__: FILESPATH = 2299 :term:`Source Directory`: FILESPATH =
2301 "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \\ 2300 "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \\
2302 "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" The 2301 "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" The
2303 ``FILESPATH`` variable is automatically extended using the overrides 2302 ``FILESPATH`` variable is automatically extended using the overrides
@@ -2344,14 +2343,14 @@ system and gives an overview of their function and contents.
2344 packages themselves but this is not always possible. 2343 packages themselves but this is not always possible.
2345 2344
2346 By default, the OpenEmbedded build system uses the ``fs-perms.txt``, 2345 By default, the OpenEmbedded build system uses the ``fs-perms.txt``,
2347 which is located in the ``meta/files`` folder in the `Source 2346 which is located in the ``meta/files`` folder in the :term:`Source Directory`.
2348 Directory <#source-directory>`__. If you create your own file 2347 If you create your own file
2349 permissions setting table, you should place it in your layer or the 2348 permissions setting table, you should place it in your layer or the
2350 distro's layer. 2349 distro's layer.
2351 2350
2352 You define the ``FILESYSTEM_PERMS_TABLES`` variable in the 2351 You define the ``FILESYSTEM_PERMS_TABLES`` variable in the
2353 ``conf/local.conf`` file, which is found in the `Build 2352 ``conf/local.conf`` file, which is found in the :term:`Build Directory`,
2354 Directory <#build-directory>`__, to point to your custom 2353 to point to your custom
2355 ``fs-perms.txt``. You can specify more than a single file permissions 2354 ``fs-perms.txt``. You can specify more than a single file permissions
2356 setting table. The paths you specify to these files must be defined 2355 setting table. The paths you specify to these files must be defined
2357 within the :term:`BBPATH` variable. 2356 within the :term:`BBPATH` variable.
@@ -2717,8 +2716,8 @@ system and gives an overview of their function and contents.
2717 IMAGE_FEATURES 2716 IMAGE_FEATURES
2718 The primary list of features to include in an image. Typically, you 2717 The primary list of features to include in an image. Typically, you
2719 configure this variable in an image recipe. Although you can use this 2718 configure this variable in an image recipe. Although you can use this
2720 variable from your ``local.conf`` file, which is found in the `Build 2719 variable from your ``local.conf`` file, which is found in the
2721 Directory <#build-directory>`__, best practices dictate that you do 2720 :term:`Build Directory`, best practices dictate that you do
2722 not. 2721 not.
2723 2722
2724 .. note:: 2723 .. note::
@@ -2886,13 +2885,13 @@ system and gives an overview of their function and contents.
2886 class is broken and is not supported. It is recommended that you 2885 class is broken and is not supported. It is recommended that you
2887 do not use it. 2886 do not use it.
2888 2887
2889 The ```populate_sdk_*`` <#ref-classes-populate-sdk-*>`__ and 2888 The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` and
2890 :ref:`image <ref-classes-image>` classes use the ``IMAGE_PKGTYPE`` 2889 :ref:`image <ref-classes-image>` classes use the ``IMAGE_PKGTYPE``
2891 for packaging up images and SDKs. 2890 for packaging up images and SDKs.
2892 2891
2893 You should not set the ``IMAGE_PKGTYPE`` manually. Rather, the 2892 You should not set the ``IMAGE_PKGTYPE`` manually. Rather, the
2894 variable is set indirectly through the appropriate 2893 variable is set indirectly through the appropriate
2895 ```package_*`` <#ref-classes-package>`__ class using the 2894 :ref:`package_* <ref-classes-package>` class using the
2896 :term:`PACKAGE_CLASSES` variable. The 2895 :term:`PACKAGE_CLASSES` variable. The
2897 OpenEmbedded build system uses the first package type (e.g. DEB, RPM, 2896 OpenEmbedded build system uses the first package type (e.g. DEB, RPM,
2898 or IPK) that appears with the variable 2897 or IPK) that appears with the variable
@@ -2995,8 +2994,7 @@ system and gives an overview of their function and contents.
2995 wic.bz2 wic.gz wic.lzma 2994 wic.bz2 wic.gz wic.lzma
2996 2995
2997 For more information about these types of images, see 2996 For more information about these types of images, see
2998 ``meta/classes/image_types*.bbclass`` in the `Source 2997 ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`.
2999 Directory <#source-directory>`__.
3000 2998
3001 INC_PR 2999 INC_PR
3002 Helps define the recipe revision for recipes that share a common 3000 Helps define the recipe revision for recipes that share a common
@@ -3156,8 +3154,8 @@ system and gives an overview of their function and contents.
3156 :term:`IMAGE_FSTYPES` variable. 3154 :term:`IMAGE_FSTYPES` variable.
3157 3155
3158 The default value of this variable, which is set in the 3156 The default value of this variable, which is set in the
3159 ``meta/conf/bitbake.conf`` configuration file in the `Source 3157 ``meta/conf/bitbake.conf`` configuration file in the
3160 Directory <#source-directory>`__, is "cpio.gz". The Linux kernel's 3158 :term:`Source Directory`, is "cpio.gz". The Linux kernel's
3161 initramfs mechanism, as opposed to the initial RAM filesystem 3159 initramfs mechanism, as opposed to the initial RAM filesystem
3162 `initrd <https://en.wikipedia.org/wiki/Initrd>`__ mechanism, expects 3160 `initrd <https://en.wikipedia.org/wiki/Initrd>`__ mechanism, expects
3163 an optionally compressed cpio archive. 3161 an optionally compressed cpio archive.
@@ -3945,8 +3943,8 @@ system and gives an overview of their function and contents.
3945 3943
3946 MACHINE 3944 MACHINE
3947 Specifies the target device for which the image is built. You define 3945 Specifies the target device for which the image is built. You define
3948 ``MACHINE`` in the ``local.conf`` file found in the `Build 3946 ``MACHINE`` in the ``local.conf`` file found in the
3949 Directory <#build-directory>`__. By default, ``MACHINE`` is set to 3947 :term:`Build Directory`. By default, ``MACHINE`` is set to
3950 "qemux86", which is an x86-based architecture machine to be emulated 3948 "qemux86", which is an x86-based architecture machine to be emulated
3951 using QEMU: MACHINE ?= "qemux86" 3949 using QEMU: MACHINE ?= "qemux86"
3952 3950
@@ -4353,8 +4351,8 @@ system and gives an overview of their function and contents.
4353 ``sysroots/`` directory so that all builds that use the script will 4351 ``sysroots/`` directory so that all builds that use the script will
4354 use the correct directories for the cross compiling layout. 4352 use the correct directories for the cross compiling layout.
4355 4353
4356 See the ``meta/classes/binconfig.bbclass`` in the `Source 4354 See the ``meta/classes/binconfig.bbclass`` in the
4357 Directory <#source-directory>`__ for details on how this class 4355 :term:`Source Directory` for details on how this class
4358 applies these additional sed command arguments. For general 4356 applies these additional sed command arguments. For general
4359 information on the ``binconfig`` class, see the 4357 information on the ``binconfig`` class, see the
4360 ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section. 4358 ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section.
@@ -4499,8 +4497,8 @@ system and gives an overview of their function and contents.
4499 4497
4500 PACKAGE_CLASSES 4498 PACKAGE_CLASSES
4501 This variable, which is set in the ``local.conf`` configuration file 4499 This variable, which is set in the ``local.conf`` configuration file
4502 found in the ``conf`` folder of the `Build 4500 found in the ``conf`` folder of the
4503 Directory <#build-directory>`__, specifies the package manager the 4501 :term:`Build Directory`, specifies the package manager the
4504 OpenEmbedded build system uses when packaging data. 4502 OpenEmbedded build system uses when packaging data.
4505 4503
4506 You can provide one or more of the following arguments for the 4504 You can provide one or more of the following arguments for the
@@ -5234,8 +5232,8 @@ system and gives an overview of their function and contents.
5234 5232
5235 Typically, you could add a specific server for the build system to 5233 Typically, you could add a specific server for the build system to
5236 attempt before any others by adding something like the following to 5234 attempt before any others by adding something like the following to
5237 the ``local.conf`` configuration file in the `Build 5235 the ``local.conf`` configuration file in the
5238 Directory <#build-directory>`__: PREMIRRORS_prepend = "\\ 5236 :term:`Build Directory`: PREMIRRORS_prepend = "\\
5239 git://.*/.\* http://www.yoctoproject.org/sources/ \\n \\ ftp://.*/.\* 5237 git://.*/.\* http://www.yoctoproject.org/sources/ \\n \\ ftp://.*/.\*
5240 http://www.yoctoproject.org/sources/ \\n \\ http://.*/.\* 5238 http://www.yoctoproject.org/sources/ \\n \\ http://.*/.\*
5241 http://www.yoctoproject.org/sources/ \\n \\ https://.*/.\* 5239 http://www.yoctoproject.org/sources/ \\n \\ https://.*/.\*
@@ -5364,8 +5362,8 @@ system and gives an overview of their function and contents.
5364 5362
5365 PYTHON_ABI 5363 PYTHON_ABI
5366 When used by recipes that inherit the 5364 When used by recipes that inherit the
5367 ```distutils3`` <#ref-classes-distutils3>`__, 5365 :ref:`distutils3 <ref-classes-distutils3>`,
5368 ```setuptools3`` <#ref-classes-setuptools3>`__, 5366 :ref:`setuptools3 <ref-classes-setuptools3>`,
5369 :ref:`distutils <ref-classes-distutils>`, or 5367 :ref:`distutils <ref-classes-distutils>`, or
5370 :ref:`setuptools <ref-classes-setuptools>` classes, denotes the 5368 :ref:`setuptools <ref-classes-setuptools>` classes, denotes the
5371 Application Binary Interface (ABI) currently in use for Python. By 5369 Application Binary Interface (ABI) currently in use for Python. By
@@ -5382,8 +5380,8 @@ system and gives an overview of their function and contents.
5382 5380
5383 PYTHON_PN 5381 PYTHON_PN
5384 When used by recipes that inherit the 5382 When used by recipes that inherit the
5385 ```distutils3`` <#ref-classes-distutils3>`__, 5383 `distutils3 <ref-classes-distutils3>`,
5386 ```setuptools3`` <#ref-classes-setuptools3>`__, 5384 :ref:`setuptools3 <ref-classes-setuptools3>`,
5387 :ref:`distutils <ref-classes-distutils>`, or 5385 :ref:`distutils <ref-classes-distutils>`, or
5388 :ref:`setuptools <ref-classes-setuptools>` classes, specifies the 5386 :ref:`setuptools <ref-classes-setuptools>` classes, specifies the
5389 major Python version being built. For Python 3.x, ``PYTHON_PN`` would 5387 major Python version being built. For Python 3.x, ``PYTHON_PN`` would
@@ -5522,7 +5520,7 @@ system and gives an overview of their function and contents.
5522 RM_WORK_EXCLUDE 5520 RM_WORK_EXCLUDE
5523 With ``rm_work`` enabled, this variable specifies a list of recipes 5521 With ``rm_work`` enabled, this variable specifies a list of recipes
5524 whose work directories should not be removed. See the 5522 whose work directories should not be removed. See the
5525 "```rm_work.bbclass`` <#ref-classes-rm-work>`__" section for more 5523 ":ref:`rm_work.bbclass <ref-classes-rm-work>`" section for more
5526 details. 5524 details.
5527 5525
5528 ROOT_HOME 5526 ROOT_HOME
@@ -5731,14 +5729,14 @@ system and gives an overview of their function and contents.
5731 5729
5732 SDK_DEPLOY 5730 SDK_DEPLOY
5733 The directory set up and used by the 5731 The directory set up and used by the
5734 ```populate_sdk_base`` <#ref-classes-populate-sdk>`__ class to which 5732 :ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which
5735 the SDK is deployed. The ``populate_sdk_base`` class defines 5733 the SDK is deployed. The ``populate_sdk_base`` class defines
5736 ``SDK_DEPLOY`` as follows: SDK_DEPLOY = "${TMPDIR}/deploy/sdk" 5734 ``SDK_DEPLOY`` as follows: SDK_DEPLOY = "${TMPDIR}/deploy/sdk"
5737 5735
5738 SDK_DIR 5736 SDK_DIR
5739 The parent directory used by the OpenEmbedded build system when 5737 The parent directory used by the OpenEmbedded build system when
5740 creating SDK output. The 5738 creating SDK output. The
5741 ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class defines 5739 :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class defines
5742 the variable as follows: SDK_DIR = "${WORKDIR}/sdk" 5740 the variable as follows: SDK_DIR = "${WORKDIR}/sdk"
5743 5741
5744 .. note:: 5742 .. note::
@@ -5770,7 +5768,7 @@ system and gives an overview of their function and contents.
5770 file contains package information on a line-per-package basis as 5768 file contains package information on a line-per-package basis as
5771 follows: packagename packagearch version 5769 follows: packagename packagearch version
5772 5770
5773 The ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class 5771 The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class
5774 defines the manifest file as follows: SDK_HOST_MANIFEST = 5772 defines the manifest file as follows: SDK_HOST_MANIFEST =
5775 "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest" The location is 5773 "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest" The location is
5776 derived using the :term:`SDK_DEPLOY` and 5774 derived using the :term:`SDK_DEPLOY` and
@@ -5807,7 +5805,7 @@ system and gives an overview of their function and contents.
5807 SDK_INHERIT_BLACKLIST 5805 SDK_INHERIT_BLACKLIST
5808 A list of classes to remove from the :term:`INHERIT` 5806 A list of classes to remove from the :term:`INHERIT`
5809 value globally within the extensible SDK configuration. The 5807 value globally within the extensible SDK configuration. The
5810 ```populate-sdk-ext`` <#ref-classes-populate-sdk-*>`__ class sets the 5808 :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the
5811 default value: SDK_INHERIT_BLACKLIST ?= "buildhistory icecc" 5809 default value: SDK_INHERIT_BLACKLIST ?= "buildhistory icecc"
5812 5810
5813 Some classes are not generally applicable within the extensible SDK 5811 Some classes are not generally applicable within the extensible SDK
@@ -5827,7 +5825,7 @@ system and gives an overview of their function and contents.
5827 within the extensible SDK. 5825 within the extensible SDK.
5828 5826
5829 By default, ``SDK_LOCAL_CONF_BLACKLIST`` is set in the 5827 By default, ``SDK_LOCAL_CONF_BLACKLIST`` is set in the
5830 ```populate-sdk-ext`` <#ref-classes-populate-sdk-*>`__ class and 5828 :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class and
5831 excludes the following variables: 5829 excludes the following variables:
5832 :term:`CONF_VERSION` 5830 :term:`CONF_VERSION`
5833 :term:`BB_NUMBER_THREADS` 5831 :term:`BB_NUMBER_THREADS`
@@ -5848,7 +5846,7 @@ system and gives an overview of their function and contents.
5848 A list of variables allowed through from the OpenEmbedded build 5846 A list of variables allowed through from the OpenEmbedded build
5849 system configuration into the extensible SDK configuration. By 5847 system configuration into the extensible SDK configuration. By
5850 default, the list of variables is empty and is set in the 5848 default, the list of variables is empty and is set in the
5851 ```populate-sdk-ext`` <#ref-classes-populate-sdk-*>`__ class. 5849 :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class.
5852 5850
5853 This list overrides the variables specified using the 5851 This list overrides the variables specified using the
5854 :term:`SDK_LOCAL_CONF_BLACKLIST` 5852 :term:`SDK_LOCAL_CONF_BLACKLIST`
@@ -5877,7 +5875,7 @@ system and gives an overview of their function and contents.
5877 5875
5878 SDK_OUTPUT 5876 SDK_OUTPUT
5879 The location used by the OpenEmbedded build system when creating SDK 5877 The location used by the OpenEmbedded build system when creating SDK
5880 output. The ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ 5878 output. The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>`
5881 class defines the variable as follows: SDK_DIR = "${WORKDIR}/sdk" 5879 class defines the variable as follows: SDK_DIR = "${WORKDIR}/sdk"
5882 SDK_OUTPUT = "${SDK_DIR}/image" SDK_DEPLOY = "${DEPLOY_DIR}/sdk" 5880 SDK_OUTPUT = "${SDK_DIR}/image" SDK_DEPLOY = "${DEPLOY_DIR}/sdk"
5883 5881
@@ -5942,7 +5940,7 @@ system and gives an overview of their function and contents.
5942 file contains package information on a line-per-package basis as 5940 file contains package information on a line-per-package basis as
5943 follows: packagename packagearch version 5941 follows: packagename packagearch version
5944 5942
5945 The ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class 5943 The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class
5946 defines the manifest file as follows: SDK_TARGET_MANIFEST = 5944 defines the manifest file as follows: SDK_TARGET_MANIFEST =
5947 "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest" The location 5945 "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest" The location
5948 is derived using the :term:`SDK_DEPLOY` and 5946 is derived using the :term:`SDK_DEPLOY` and
@@ -5960,7 +5958,7 @@ system and gives an overview of their function and contents.
5960 The title to be printed when running the SDK installer. By default, 5958 The title to be printed when running the SDK installer. By default,
5961 this title is based on the :term:`DISTRO_NAME` or 5959 this title is based on the :term:`DISTRO_NAME` or
5962 :term:`DISTRO` variable and is set in the 5960 :term:`DISTRO` variable and is set in the
5963 ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class as 5961 :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class as
5964 follows: SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or 5962 follows: SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or
5965 d.getVar('DISTRO')} SDK" For the default distribution "poky", 5963 d.getVar('DISTRO')} SDK" For the default distribution "poky",
5966 ``SDK_TITLE`` is set to "Poky (Yocto Project Reference Distro)". 5964 ``SDK_TITLE`` is set to "Poky (Yocto Project Reference Distro)".
@@ -5993,7 +5991,7 @@ system and gives an overview of their function and contents.
5993 The default installation directory for the Extensible SDK. By 5991 The default installation directory for the Extensible SDK. By
5994 default, this directory is based on the :term:`DISTRO` 5992 default, this directory is based on the :term:`DISTRO`
5995 variable and is set in the 5993 variable and is set in the
5996 ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class as 5994 :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class as
5997 follows: SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" For the 5995 follows: SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" For the
5998 default distribution "poky", the ``SDKEXTPATH`` is set to "poky_sdk". 5996 default distribution "poky", the ``SDKEXTPATH`` is set to "poky_sdk".
5999 5997
@@ -6135,8 +6133,8 @@ system and gives an overview of their function and contents.
6135 prebuilt binaries and libraries such as ``libstdc++`` and ``glibc``. 6133 prebuilt binaries and libraries such as ``libstdc++`` and ``glibc``.
6136 6134
6137 To enable file removal, set the variable to "1" in your 6135 To enable file removal, set the variable to "1" in your
6138 ``conf/local.conf`` configuration file in your: `Build 6136 ``conf/local.conf`` configuration file in your:
6139 Directory <#build-directory>`__. SKIP_FILEDEPS = "1" 6137 :term:`Build Directory`. SKIP_FILEDEPS = "1"
6140 6138
6141 SOC_FAMILY 6139 SOC_FAMILY
6142 Groups together machines based upon the same family of SOC (System On 6140 Groups together machines based upon the same family of SOC (System On
@@ -7289,8 +7287,8 @@ system and gives an overview of their function and contents.
7289 7287
7290 If you want to establish this directory in a location other than the 7288 If you want to establish this directory in a location other than the
7291 default, you can uncomment and edit the following statement in the 7289 default, you can uncomment and edit the following statement in the
7292 ``conf/local.conf`` file in the `Source 7290 ``conf/local.conf`` file in the :term:`Source Directory`:
7293 Directory <#source-directory>`__: #TMPDIR = "${TOPDIR}/tmp" An 7291 #TMPDIR = "${TOPDIR}/tmp" An
7294 example use for this scenario is to set ``TMPDIR`` to a local disk, 7292 example use for this scenario is to set ``TMPDIR`` to a local disk,
7295 which does not use NFS, while having the Build Directory use NFS. 7293 which does not use NFS, while having the Build Directory use NFS.
7296 7294
@@ -7325,7 +7323,7 @@ system and gives an overview of their function and contents.
7325 7323
7326 TOOLCHAIN_OUTPUTNAME 7324 TOOLCHAIN_OUTPUTNAME
7327 This variable defines the name used for the toolchain output. The 7325 This variable defines the name used for the toolchain output. The
7328 ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class sets 7326 :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class sets
7329 the ``TOOLCHAIN_OUTPUTNAME`` variable as follows: 7327 the ``TOOLCHAIN_OUTPUTNAME`` variable as follows:
7330 TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}" See 7328 TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}" See
7331 the :term:`SDK_NAME` and 7329 the :term:`SDK_NAME` and
@@ -7374,8 +7372,8 @@ system and gives an overview of their function and contents.
7374 definitions can be a single static definition, or can be dynamically 7372 definitions can be a single static definition, or can be dynamically
7375 adjusted. You can see details for a given CPU family by looking at 7373 adjusted. You can see details for a given CPU family by looking at
7376 the architecture's ``README`` file. For example, the 7374 the architecture's ``README`` file. For example, the
7377 ``meta/conf/machine/include/mips/README`` file in the `Source 7375 ``meta/conf/machine/include/mips/README`` file in the
7378 Directory <#source-directory>`__ provides information for 7376 :term:`Source Directory` provides information for
7379 ``TUNE_ARCH`` specific to the ``mips`` architecture. 7377 ``TUNE_ARCH`` specific to the ``mips`` architecture.
7380 7378
7381 ``TUNE_ARCH`` is tied closely to 7379 ``TUNE_ARCH`` is tied closely to
@@ -7510,8 +7508,8 @@ system and gives an overview of their function and contents.
7510 ``meta/conf/machine/include/arm/arch-arm.inc``). Here is an example 7508 ``meta/conf/machine/include/arm/arch-arm.inc``). Here is an example
7511 from that file: TUNEVALID[bigendian] = "Enable big-endian mode." 7509 from that file: TUNEVALID[bigendian] = "Enable big-endian mode."
7512 7510
7513 See the machine include files in the `Source 7511 See the machine include files in the :term:`Source Directory`
7514 Directory <#source-directory>`__ for these features. 7512 for these features.
7515 7513
7516 UBOOT_CONFIG 7514 UBOOT_CONFIG
7517 Configures the :term:`UBOOT_MACHINE` and can 7515 Configures the :term:`UBOOT_MACHINE` and can
@@ -7696,8 +7694,7 @@ system and gives an overview of their function and contents.
7696 7694
7697 The default list is set in your ``local.conf`` file: USER_CLASSES ?= 7695 The default list is set in your ``local.conf`` file: USER_CLASSES ?=
7698 "buildstats image-mklibs image-prelink" For more information, see 7696 "buildstats image-mklibs image-prelink" For more information, see
7699 ``meta-poky/conf/local.conf.sample`` in the `Source 7697 ``meta-poky/conf/local.conf.sample`` in the :term:`Source Directory`.
7700 Directory <#source-directory>`__.
7701 7698
7702 USERADD_ERROR_DYNAMIC 7699 USERADD_ERROR_DYNAMIC
7703 If set to ``error``, forces the OpenEmbedded build system to produce 7700 If set to ``error``, forces the OpenEmbedded build system to produce