summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/ref-variables.rst')
-rw-r--r--documentation/ref-manual/ref-variables.rst1162
1 files changed, 581 insertions, 581 deletions
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 6b00380350..60a766e79e 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -18,7 +18,7 @@ system and gives an overview of their function and contents.
18 18
19.. glossary:: 19.. glossary::
20 20
21 ABIEXTENSION 21 :term:`ABIEXTENSION`
22 Extension to the Application Binary Interface (ABI) field of the GNU 22 Extension to the Application Binary Interface (ABI) field of the GNU
23 canonical architecture name (e.g. "eabi"). 23 canonical architecture name (e.g. "eabi").
24 24
@@ -29,7 +29,7 @@ system and gives an overview of their function and contents.
29 29
30 ABIEXTENSION = "eabi" 30 ABIEXTENSION = "eabi"
31 31
32 ALLOW_EMPTY 32 :term:`ALLOW_EMPTY`
33 Specifies whether to produce an output package even if it is empty. 33 Specifies whether to produce an output package even if it is empty.
34 By default, BitBake does not produce empty packages. This default 34 By default, BitBake does not produce empty packages. This default
35 behavior can cause issues when there is an 35 behavior can cause issues when there is an
@@ -44,7 +44,7 @@ system and gives an overview of their function and contents.
44 ALLOW_EMPTY_${PN}-dev = "1" 44 ALLOW_EMPTY_${PN}-dev = "1"
45 ALLOW_EMPTY_${PN}-staticdev = "1" 45 ALLOW_EMPTY_${PN}-staticdev = "1"
46 46
47 ALTERNATIVE 47 :term:`ALTERNATIVE`
48 Lists commands in a package that need an alternative binary naming 48 Lists commands in a package that need an alternative binary naming
49 scheme. Sometimes the same command is provided in multiple packages. 49 scheme. Sometimes the same command is provided in multiple packages.
50 When this occurs, the OpenEmbedded build system needs to use the 50 When this occurs, the OpenEmbedded build system needs to use the
@@ -63,7 +63,7 @@ system and gives an overview of their function and contents.
63 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" 63 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
64 section. 64 section.
65 65
66 ALTERNATIVE_LINK_NAME 66 :term:`ALTERNATIVE_LINK_NAME`
67 Used by the alternatives system to map duplicated commands to actual 67 Used by the alternatives system to map duplicated commands to actual
68 locations. For example, if the ``bracket`` command provided by the 68 locations. For example, if the ``bracket`` command provided by the
69 ``busybox`` package is duplicated through another package, you must 69 ``busybox`` package is duplicated through another package, you must
@@ -84,7 +84,7 @@ system and gives an overview of their function and contents.
84 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" 84 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
85 section. 85 section.
86 86
87 ALTERNATIVE_PRIORITY 87 :term:`ALTERNATIVE_PRIORITY`
88 Used by the alternatives system to create default priorities for 88 Used by the alternatives system to create default priorities for
89 duplicated commands. You can use the variable to create a single 89 duplicated commands. You can use the variable to create a single
90 default regardless of the command name or package, a default for 90 default regardless of the command name or package, a default for
@@ -101,7 +101,7 @@ system and gives an overview of their function and contents.
101 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" 101 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
102 section. 102 section.
103 103
104 ALTERNATIVE_TARGET 104 :term:`ALTERNATIVE_TARGET`
105 Used by the alternatives system to create default link locations for 105 Used by the alternatives system to create default link locations for
106 duplicated commands. You can use the variable to create a single 106 duplicated commands. You can use the variable to create a single
107 default location for all duplicated commands regardless of the 107 default location for all duplicated commands regardless of the
@@ -132,17 +132,17 @@ system and gives an overview of their function and contents.
132 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" 132 ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`"
133 section. 133 section.
134 134
135 APPEND 135 :term:`APPEND`
136 An override list of append strings for each target specified with 136 An override list of append strings for each target specified with
137 :term:`LABELS`. 137 :term:`LABELS`.
138 138
139 See the :ref:`grub-efi <ref-classes-grub-efi>` class for more 139 See the :ref:`grub-efi <ref-classes-grub-efi>` class for more
140 information on how this variable is used. 140 information on how this variable is used.
141 141
142 AR 142 :term:`AR`
143 The minimal command and arguments used to run ``ar``. 143 The minimal command and arguments used to run ``ar``.
144 144
145 ARCHIVER_MODE 145 :term:`ARCHIVER_MODE`
146 When used with the :ref:`archiver <ref-classes-archiver>` class, 146 When used with the :ref:`archiver <ref-classes-archiver>` class,
147 determines the type of information used to create a released archive. 147 determines the type of information used to create a released archive.
148 You can use this variable to create archives of patched source, 148 You can use this variable to create archives of patched source,
@@ -162,10 +162,10 @@ system and gives an overview of their function and contents.
162 For information on how the variable works, see the 162 For information on how the variable works, see the
163 ``meta/classes/archiver.bbclass`` file in the :term:`Source Directory`. 163 ``meta/classes/archiver.bbclass`` file in the :term:`Source Directory`.
164 164
165 AS 165 :term:`AS`
166 Minimal command and arguments needed to run the assembler. 166 Minimal command and arguments needed to run the assembler.
167 167
168 ASSUME_PROVIDED 168 :term:`ASSUME_PROVIDED`
169 Lists recipe names (:term:`PN` values) BitBake does not 169 Lists recipe names (:term:`PN` values) BitBake does not
170 attempt to build. Instead, BitBake assumes these recipes have already 170 attempt to build. Instead, BitBake assumes these recipes have already
171 been built. 171 been built.
@@ -175,7 +175,7 @@ system and gives an overview of their function and contents.
175 when specified, allows for the Git binary from the host to be used 175 when specified, allows for the Git binary from the host to be used
176 rather than building ``git-native``. 176 rather than building ``git-native``.
177 177
178 ASSUME_SHLIBS 178 :term:`ASSUME_SHLIBS`
179 Provides additional ``shlibs`` provider mapping information, which 179 Provides additional ``shlibs`` provider mapping information, which
180 adds to or overwrites the information provided automatically by the 180 adds to or overwrites the information provided automatically by the
181 system. Separate multiple entries using spaces. 181 system. Separate multiple entries using spaces.
@@ -192,11 +192,11 @@ system and gives an overview of their function and contents.
192 192
193 ASSUME_SHLIBS = "libEGL.so.1:libegl-implementation" 193 ASSUME_SHLIBS = "libEGL.so.1:libegl-implementation"
194 194
195 AUTHOR 195 :term:`AUTHOR`
196 The email address used to contact the original author or authors in 196 The email address used to contact the original author or authors in
197 order to send patches and forward bugs. 197 order to send patches and forward bugs.
198 198
199 AUTO_LIBNAME_PKGS 199 :term:`AUTO_LIBNAME_PKGS`
200 When the :ref:`debian <ref-classes-debian>` class is inherited, 200 When the :ref:`debian <ref-classes-debian>` class is inherited,
201 which is the default behavior, ``AUTO_LIBNAME_PKGS`` specifies which 201 which is the default behavior, ``AUTO_LIBNAME_PKGS`` specifies which
202 packages should be checked for libraries and renamed according to 202 packages should be checked for libraries and renamed according to
@@ -205,12 +205,12 @@ system and gives an overview of their function and contents.
205 The default value is "${PACKAGES}", which causes the debian class to 205 The default value is "${PACKAGES}", which causes the debian class to
206 act on all packages that are explicitly generated by the recipe. 206 act on all packages that are explicitly generated by the recipe.
207 207
208 AUTO_SYSLINUXMENU 208 :term:`AUTO_SYSLINUXMENU`
209 Enables creating an automatic menu for the syslinux bootloader. You 209 Enables creating an automatic menu for the syslinux bootloader. You
210 must set this variable in your recipe. The 210 must set this variable in your recipe. The
211 :ref:`syslinux <ref-classes-syslinux>` class checks this variable. 211 :ref:`syslinux <ref-classes-syslinux>` class checks this variable.
212 212
213 AUTOREV 213 :term:`AUTOREV`
214 When ``SRCREV`` is set to the value of this variable, it specifies to 214 When ``SRCREV`` is set to the value of this variable, it specifies to
215 use the latest source revision in the repository. Here is an example: 215 use the latest source revision in the repository. Here is an example:
216 :: 216 ::
@@ -230,7 +230,7 @@ system and gives an overview of their function and contents.
230 ":ref:`dev-manual/dev-manual-common-tasks:automatically incrementing a package version number`" 230 ":ref:`dev-manual/dev-manual-common-tasks:automatically incrementing a package version number`"
231 section in the Yocto Project Development Tasks Manual. 231 section in the Yocto Project Development Tasks Manual.
232 232
233 AVAILABLE_LICENSES 233 :term:`AVAILABLE_LICENSES`
234 List of licenses found in the directories specified by 234 List of licenses found in the directories specified by
235 :term:`COMMON_LICENSE_DIR` and 235 :term:`COMMON_LICENSE_DIR` and
236 :term:`LICENSE_PATH`. 236 :term:`LICENSE_PATH`.
@@ -247,7 +247,7 @@ system and gives an overview of their function and contents.
247 license.bbclass 247 license.bbclass
248 ). 248 ).
249 249
250 AVAILTUNES 250 :term:`AVAILTUNES`
251 The list of defined CPU and Application Binary Interface (ABI) 251 The list of defined CPU and Application Binary Interface (ABI)
252 tunings (i.e. "tunes") available for use by the OpenEmbedded build 252 tunings (i.e. "tunes") available for use by the OpenEmbedded build
253 system. 253 system.
@@ -264,7 +264,7 @@ system and gives an overview of their function and contents.
264 ":ref:`Basic Syntax <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax>`" section in the BitBake 264 ":ref:`Basic Syntax <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:basic syntax>`" section in the BitBake
265 User Manual for more information. 265 User Manual for more information.
266 266
267 B 267 :term:`B`
268 The directory within the :term:`Build Directory` in 268 The directory within the :term:`Build Directory` in
269 which the OpenEmbedded build system places generated objects during a 269 which the OpenEmbedded build system places generated objects during a
270 recipe's build process. By default, this directory is the same as the 270 recipe's build process. By default, this directory is the same as the
@@ -278,7 +278,7 @@ system and gives an overview of their function and contents.
278 separating these directories. The build system defaults to using 278 separating these directories. The build system defaults to using
279 separate directories for ``gcc`` and some kernel recipes. 279 separate directories for ``gcc`` and some kernel recipes.
280 280
281 BAD_RECOMMENDATIONS 281 :term:`BAD_RECOMMENDATIONS`
282 Lists "recommended-only" packages to not install. Recommended-only 282 Lists "recommended-only" packages to not install. Recommended-only
283 packages are packages installed only through the 283 packages are packages installed only through the
284 :term:`RRECOMMENDS` variable. You can prevent any 284 :term:`RRECOMMENDS` variable. You can prevent any
@@ -308,7 +308,7 @@ system and gives an overview of their function and contents.
308 :term:`PACKAGE_EXCLUDE` variables for related 308 :term:`PACKAGE_EXCLUDE` variables for related
309 information. 309 information.
310 310
311 BASE_LIB 311 :term:`BASE_LIB`
312 The library directory name for the CPU or Application Binary 312 The library directory name for the CPU or Application Binary
313 Interface (ABI) tune. The ``BASE_LIB`` applies only in the Multilib 313 Interface (ABI) tune. The ``BASE_LIB`` applies only in the Multilib
314 context. See the ":ref:`dev-manual/dev-manual-common-tasks:combining multiple versions of library files into one image`" 314 context. See the ":ref:`dev-manual/dev-manual-common-tasks:combining multiple versions of library files into one image`"
@@ -319,11 +319,11 @@ system and gives an overview of their function and contents.
319 the :term:`Source Directory`. If Multilib is not 319 the :term:`Source Directory`. If Multilib is not
320 being used, the value defaults to "lib". 320 being used, the value defaults to "lib".
321 321
322 BASE_WORKDIR 322 :term:`BASE_WORKDIR`
323 Points to the base of the work directory for all recipes. The default 323 Points to the base of the work directory for all recipes. The default
324 value is "${TMPDIR}/work". 324 value is "${TMPDIR}/work".
325 325
326 BB_ALLOWED_NETWORKS 326 :term:`BB_ALLOWED_NETWORKS`
327 Specifies a space-delimited list of hosts that the fetcher is allowed 327 Specifies a space-delimited list of hosts that the fetcher is allowed
328 to use to obtain the required source code. Following are 328 to use to obtain the required source code. Following are
329 considerations surrounding this variable: 329 considerations surrounding this variable:
@@ -362,7 +362,7 @@ system and gives an overview of their function and contents.
362 host listed in ``SRC_URI`` after a successful fetch from the 362 host listed in ``SRC_URI`` after a successful fetch from the
363 ``PREMIRRORS`` occurs. 363 ``PREMIRRORS`` occurs.
364 364
365 BB_DANGLINGAPPENDS_WARNONLY 365 :term:`BB_DANGLINGAPPENDS_WARNONLY`
366 Defines how BitBake handles situations where an append file 366 Defines how BitBake handles situations where an append file
367 (``.bbappend``) has no corresponding recipe file (``.bb``). This 367 (``.bbappend``) has no corresponding recipe file (``.bb``). This
368 condition often occurs when layers get out of sync (e.g. ``oe-core`` 368 condition often occurs when layers get out of sync (e.g. ``oe-core``
@@ -381,7 +381,7 @@ system and gives an overview of their function and contents.
381 381
382 BB_DANGLINGAPPENDS_WARNONLY = "1" 382 BB_DANGLINGAPPENDS_WARNONLY = "1"
383 383
384 BB_DISKMON_DIRS 384 :term:`BB_DISKMON_DIRS`
385 Monitors disk space and available inodes during the build and allows 385 Monitors disk space and available inodes during the build and allows
386 you to control the build based on these parameters. 386 you to control the build based on these parameters.
387 387
@@ -453,7 +453,7 @@ system and gives an overview of their function and contents.
453 free inodes in the ``${TMPDIR}`` directory drops below 100 Kbytes. No 453 free inodes in the ``${TMPDIR}`` directory drops below 100 Kbytes. No
454 disk space monitoring for the directory itself occurs in this case. 454 disk space monitoring for the directory itself occurs in this case.
455 455
456 BB_DISKMON_WARNINTERVAL 456 :term:`BB_DISKMON_WARNINTERVAL`
457 Defines the disk space and free inode warning intervals. To set these 457 Defines the disk space and free inode warning intervals. To set these
458 intervals, define the variable in your ``conf/local.conf`` file in 458 intervals, define the variable in your ``conf/local.conf`` file in
459 the :term:`Build Directory`. 459 the :term:`Build Directory`.
@@ -503,7 +503,7 @@ system and gives an overview of their function and contents.
503 a respective interval is reached beyond the initial warning (i.e. 1 503 a respective interval is reached beyond the initial warning (i.e. 1
504 Gbytes and 100 Kbytes). 504 Gbytes and 100 Kbytes).
505 505
506 BB_GENERATE_MIRROR_TARBALLS 506 :term:`BB_GENERATE_MIRROR_TARBALLS`
507 Causes tarballs of the source control repositories (e.g. Git 507 Causes tarballs of the source control repositories (e.g. Git
508 repositories), including metadata, to be placed in the 508 repositories), including metadata, to be placed in the
509 :term:`DL_DIR` directory. 509 :term:`DL_DIR` directory.
@@ -522,7 +522,7 @@ system and gives an overview of their function and contents.
522 clean up your ``DL_DIR`` directory by deleting any Git or other 522 clean up your ``DL_DIR`` directory by deleting any Git or other
523 source control work directories. 523 source control work directories.
524 524
525 BB_NUMBER_THREADS 525 :term:`BB_NUMBER_THREADS`
526 The maximum number of tasks BitBake should run in parallel at any one 526 The maximum number of tasks BitBake should run in parallel at any one
527 time. The OpenEmbedded build system automatically configures this 527 time. The OpenEmbedded build system automatically configures this
528 variable to be equal to the number of cores on the build system. For 528 variable to be equal to the number of cores on the build system. For
@@ -540,7 +540,7 @@ system and gives an overview of their function and contents.
540 ":ref:`dev-manual/dev-manual-common-tasks:speeding up a build`" 540 ":ref:`dev-manual/dev-manual-common-tasks:speeding up a build`"
541 section in the Yocto Project Development Tasks Manual. 541 section in the Yocto Project Development Tasks Manual.
542 542
543 BB_SERVER_TIMEOUT 543 :term:`BB_SERVER_TIMEOUT`
544 Specifies the time (in seconds) after which to unload the BitBake 544 Specifies the time (in seconds) after which to unload the BitBake
545 server due to inactivity. Set ``BB_SERVER_TIMEOUT`` to determine how 545 server due to inactivity. Set ``BB_SERVER_TIMEOUT`` to determine how
546 long the BitBake server stays resident between invocations. 546 long the BitBake server stays resident between invocations.
@@ -554,7 +554,7 @@ system and gives an overview of their function and contents.
554 If you want the server to never be unloaded, 554 If you want the server to never be unloaded,
555 set ``BB_SERVER_TIMEOUT`` to "-1". 555 set ``BB_SERVER_TIMEOUT`` to "-1".
556 556
557 BBCLASSEXTEND 557 :term:`BBCLASSEXTEND`
558 Allows you to extend a recipe so that it builds variants of the 558 Allows you to extend a recipe so that it builds variants of the
559 software. Common variants for recipes exist such as "natives" like 559 software. Common variants for recipes exist such as "natives" like
560 ``quilt-native``, which is a copy of Quilt built to run on the build 560 ``quilt-native``, which is a copy of Quilt built to run on the build
@@ -585,18 +585,18 @@ system and gives an overview of their function and contents.
585 since ``include`` statements are processed when the recipe is 585 since ``include`` statements are processed when the recipe is
586 parsed. 586 parsed.
587 587
588 BBFILE_COLLECTIONS 588 :term:`BBFILE_COLLECTIONS`
589 Lists the names of configured layers. These names are used to find 589 Lists the names of configured layers. These names are used to find
590 the other ``BBFILE_*`` variables. Typically, each layer will append 590 the other ``BBFILE_*`` variables. Typically, each layer will append
591 its name to this variable in its ``conf/layer.conf`` file. 591 its name to this variable in its ``conf/layer.conf`` file.
592 592
593 BBFILE_PATTERN 593 :term:`BBFILE_PATTERN`
594 Variable that expands to match files from 594 Variable that expands to match files from
595 :term:`BBFILES` in a particular layer. This variable 595 :term:`BBFILES` in a particular layer. This variable
596 is used in the ``conf/layer.conf`` file and must be suffixed with the 596 is used in the ``conf/layer.conf`` file and must be suffixed with the
597 name of the specific layer (e.g. ``BBFILE_PATTERN_emenlow``). 597 name of the specific layer (e.g. ``BBFILE_PATTERN_emenlow``).
598 598
599 BBFILE_PRIORITY 599 :term:`BBFILE_PRIORITY`
600 Assigns the priority for recipe files in each layer. 600 Assigns the priority for recipe files in each layer.
601 601
602 This variable is useful in situations where the same recipe appears 602 This variable is useful in situations where the same recipe appears
@@ -623,7 +623,7 @@ system and gives an overview of their function and contents.
623 bitbake-layers show-layers 623 bitbake-layers show-layers
624 to list all configured layers along with their priorities. 624 to list all configured layers along with their priorities.
625 625
626 BBFILES 626 :term:`BBFILES`
627 A space-separated list of recipe files BitBake uses to build 627 A space-separated list of recipe files BitBake uses to build
628 software. 628 software.
629 629
@@ -632,7 +632,7 @@ system and gives an overview of their function and contents.
632 For details on the syntax, see the documentation by following the 632 For details on the syntax, see the documentation by following the
633 previous link. 633 previous link.
634 634
635 BBFILES_DYNAMIC 635 :term:`BBFILES_DYNAMIC`
636 Activates content when identified layers are present. You identify 636 Activates content when identified layers are present. You identify
637 the layers by the collections that the layers define. 637 the layers by the collections that the layers define.
638 638
@@ -659,16 +659,16 @@ system and gives an overview of their function and contents.
659 /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend 659 /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend
660 /work/my-layer/bbappends/openembedded-core/meta/*/*/*.bbappend 660 /work/my-layer/bbappends/openembedded-core/meta/*/*/*.bbappend
661 661
662 BBINCLUDELOGS 662 :term:`BBINCLUDELOGS`
663 Variable that controls how BitBake displays logs on build failure. 663 Variable that controls how BitBake displays logs on build failure.
664 664
665 BBINCLUDELOGS_LINES 665 :term:`BBINCLUDELOGS_LINES`
666 If :term:`BBINCLUDELOGS` is set, specifies the 666 If :term:`BBINCLUDELOGS` is set, specifies the
667 maximum number of lines from the task log file to print when 667 maximum number of lines from the task log file to print when
668 reporting a failed task. If you do not set ``BBINCLUDELOGS_LINES``, 668 reporting a failed task. If you do not set ``BBINCLUDELOGS_LINES``,
669 the entire log is printed. 669 the entire log is printed.
670 670
671 BBLAYERS 671 :term:`BBLAYERS`
672 Lists the layers to enable during the build. This variable is defined 672 Lists the layers to enable during the build. This variable is defined
673 in the ``bblayers.conf`` configuration file in the :term:`Build Directory`. 673 in the ``bblayers.conf`` configuration file in the :term:`Build Directory`.
674 Here is an example: 674 Here is an example:
@@ -683,7 +683,7 @@ system and gives an overview of their function and contents.
683 This example enables four layers, one of which is a custom, 683 This example enables four layers, one of which is a custom,
684 user-defined layer named ``meta-mykernel``. 684 user-defined layer named ``meta-mykernel``.
685 685
686 BBMASK 686 :term:`BBMASK`
687 Prevents BitBake from processing recipes and recipe append files. 687 Prevents BitBake from processing recipes and recipe append files.
688 688
689 You can use the ``BBMASK`` variable to "hide" these ``.bb`` and 689 You can use the ``BBMASK`` variable to "hide" these ``.bb`` and
@@ -720,7 +720,7 @@ system and gives an overview of their function and contents.
720 When specifying a directory name, use the trailing slash character 720 When specifying a directory name, use the trailing slash character
721 to ensure you match just that directory name. 721 to ensure you match just that directory name.
722 722
723 BBMULTICONFIG 723 :term:`BBMULTICONFIG`
724 Specifies each additional separate configuration when you are 724 Specifies each additional separate configuration when you are
725 building targets with multiple configurations. Use this variable in 725 building targets with multiple configurations. Use this variable in
726 your ``conf/local.conf`` configuration file. Specify a 726 your ``conf/local.conf`` configuration file. Specify a
@@ -740,7 +740,7 @@ system and gives an overview of their function and contents.
740 ":ref:`dev-building-images-for-multiple-targets-using-multiple-configurations`" 740 ":ref:`dev-building-images-for-multiple-targets-using-multiple-configurations`"
741 section in the Yocto Project Development Tasks Manual. 741 section in the Yocto Project Development Tasks Manual.
742 742
743 BBPATH 743 :term:`BBPATH`
744 Used by BitBake to locate ``.bbclass`` and configuration files. This 744 Used by BitBake to locate ``.bbclass`` and configuration files. This
745 variable is analogous to the ``PATH`` variable. 745 variable is analogous to the ``PATH`` variable.
746 746
@@ -759,7 +759,7 @@ system and gives an overview of their function and contents.
759 $ bitbake target 759 $ bitbake target
760 760
761 761
762 BBSERVER 762 :term:`BBSERVER`
763 If defined in the BitBake environment, ``BBSERVER`` points to the 763 If defined in the BitBake environment, ``BBSERVER`` points to the
764 BitBake remote server. 764 BitBake remote server.
765 765
@@ -774,7 +774,7 @@ system and gives an overview of their function and contents.
774 Consequently, ``BBSERVER`` is excluded from checksum and dependency 774 Consequently, ``BBSERVER`` is excluded from checksum and dependency
775 data. 775 data.
776 776
777 BINCONFIG 777 :term:`BINCONFIG`
778 When inheriting the 778 When inheriting the
779 :ref:`binconfig-disabled <ref-classes-binconfig-disabled>` class, 779 :ref:`binconfig-disabled <ref-classes-binconfig-disabled>` class,
780 this variable specifies binary configuration scripts to disable in 780 this variable specifies binary configuration scripts to disable in
@@ -789,7 +789,7 @@ system and gives an overview of their function and contents.
789 789
790 BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config" 790 BINCONFIG = "${bindir}/libpng-config ${bindir}/libpng16-config"
791 791
792 BINCONFIG_GLOB 792 :term:`BINCONFIG_GLOB`
793 When inheriting the :ref:`binconfig <ref-classes-binconfig>` class, 793 When inheriting the :ref:`binconfig <ref-classes-binconfig>` class,
794 this variable specifies a wildcard for configuration scripts that 794 this variable specifies a wildcard for configuration scripts that
795 need editing. The scripts are edited to correct any paths that have 795 need editing. The scripts are edited to correct any paths that have
@@ -816,7 +816,7 @@ system and gives an overview of their function and contents.
816 information on the class in the 816 information on the class in the
817 ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section. 817 ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section.
818 818
819 BP 819 :term:`BP`
820 The base recipe name and version but without any special recipe name 820 The base recipe name and version but without any special recipe name
821 suffix (i.e. ``-native``, ``lib64-``, and so forth). ``BP`` is 821 suffix (i.e. ``-native``, ``lib64-``, and so forth). ``BP`` is
822 comprised of the following: 822 comprised of the following:
@@ -824,7 +824,7 @@ system and gives an overview of their function and contents.
824 824
825 ${BPN}-${PV} 825 ${BPN}-${PV}
826 826
827 BPN 827 :term:`BPN`
828 This variable is a version of the :term:`PN` variable with 828 This variable is a version of the :term:`PN` variable with
829 common prefixes and suffixes removed, such as ``nativesdk-``, 829 common prefixes and suffixes removed, such as ``nativesdk-``,
830 ``-cross``, ``-native``, and multilib's ``lib64-`` and ``lib32-``. 830 ``-cross``, ``-native``, and multilib's ``lib64-`` and ``lib32-``.
@@ -833,73 +833,73 @@ system and gives an overview of their function and contents.
833 :term:`SPECIAL_PKGSUFFIX` variables, 833 :term:`SPECIAL_PKGSUFFIX` variables,
834 respectively. 834 respectively.
835 835
836 BUGTRACKER 836 :term:`BUGTRACKER`
837 Specifies a URL for an upstream bug tracking website for a recipe. 837 Specifies a URL for an upstream bug tracking website for a recipe.
838 The OpenEmbedded build system does not use this variable. Rather, the 838 The OpenEmbedded build system does not use this variable. Rather, the
839 variable is a useful pointer in case a bug in the software being 839 variable is a useful pointer in case a bug in the software being
840 built needs to be manually reported. 840 built needs to be manually reported.
841 841
842 BUILD_ARCH 842 :term:`BUILD_ARCH`
843 Specifies the architecture of the build host (e.g. ``i686``). The 843 Specifies the architecture of the build host (e.g. ``i686``). The
844 OpenEmbedded build system sets the value of ``BUILD_ARCH`` from the 844 OpenEmbedded build system sets the value of ``BUILD_ARCH`` from the
845 machine name reported by the ``uname`` command. 845 machine name reported by the ``uname`` command.
846 846
847 BUILD_AS_ARCH 847 :term:`BUILD_AS_ARCH`
848 Specifies the architecture-specific assembler flags for the build 848 Specifies the architecture-specific assembler flags for the build
849 host. By default, the value of ``BUILD_AS_ARCH`` is empty. 849 host. By default, the value of ``BUILD_AS_ARCH`` is empty.
850 850
851 BUILD_CC_ARCH 851 :term:`BUILD_CC_ARCH`
852 Specifies the architecture-specific C compiler flags for the build 852 Specifies the architecture-specific C compiler flags for the build
853 host. By default, the value of ``BUILD_CC_ARCH`` is empty. 853 host. By default, the value of ``BUILD_CC_ARCH`` is empty.
854 854
855 BUILD_CCLD 855 :term:`BUILD_CCLD`
856 Specifies the linker command to be used for the build host when the C 856 Specifies the linker command to be used for the build host when the C
857 compiler is being used as the linker. By default, ``BUILD_CCLD`` 857 compiler is being used as the linker. By default, ``BUILD_CCLD``
858 points to GCC and passes as arguments the value of 858 points to GCC and passes as arguments the value of
859 :term:`BUILD_CC_ARCH`, assuming 859 :term:`BUILD_CC_ARCH`, assuming
860 ``BUILD_CC_ARCH`` is set. 860 ``BUILD_CC_ARCH`` is set.
861 861
862 BUILD_CFLAGS 862 :term:`BUILD_CFLAGS`
863 Specifies the flags to pass to the C compiler when building for the 863 Specifies the flags to pass to the C compiler when building for the
864 build host. When building in the ``-native`` context, 864 build host. When building in the ``-native`` context,
865 :term:`CFLAGS` is set to the value of this variable by 865 :term:`CFLAGS` is set to the value of this variable by
866 default. 866 default.
867 867
868 BUILD_CPPFLAGS 868 :term:`BUILD_CPPFLAGS`
869 Specifies the flags to pass to the C preprocessor (i.e. to both the C 869 Specifies the flags to pass to the C preprocessor (i.e. to both the C
870 and the C++ compilers) when building for the build host. When 870 and the C++ compilers) when building for the build host. When
871 building in the ``-native`` context, :term:`CPPFLAGS` 871 building in the ``-native`` context, :term:`CPPFLAGS`
872 is set to the value of this variable by default. 872 is set to the value of this variable by default.
873 873
874 BUILD_CXXFLAGS 874 :term:`BUILD_CXXFLAGS`
875 Specifies the flags to pass to the C++ compiler when building for the 875 Specifies the flags to pass to the C++ compiler when building for the
876 build host. When building in the ``-native`` context, 876 build host. When building in the ``-native`` context,
877 :term:`CXXFLAGS` is set to the value of this variable 877 :term:`CXXFLAGS` is set to the value of this variable
878 by default. 878 by default.
879 879
880 BUILD_FC 880 :term:`BUILD_FC`
881 Specifies the Fortran compiler command for the build host. By 881 Specifies the Fortran compiler command for the build host. By
882 default, ``BUILD_FC`` points to Gfortran and passes as arguments the 882 default, ``BUILD_FC`` points to Gfortran and passes as arguments the
883 value of :term:`BUILD_CC_ARCH`, assuming 883 value of :term:`BUILD_CC_ARCH`, assuming
884 ``BUILD_CC_ARCH`` is set. 884 ``BUILD_CC_ARCH`` is set.
885 885
886 BUILD_LD 886 :term:`BUILD_LD`
887 Specifies the linker command for the build host. By default, 887 Specifies the linker command for the build host. By default,
888 ``BUILD_LD`` points to the GNU linker (ld) and passes as arguments 888 ``BUILD_LD`` points to the GNU linker (ld) and passes as arguments
889 the value of :term:`BUILD_LD_ARCH`, assuming 889 the value of :term:`BUILD_LD_ARCH`, assuming
890 ``BUILD_LD_ARCH`` is set. 890 ``BUILD_LD_ARCH`` is set.
891 891
892 BUILD_LD_ARCH 892 :term:`BUILD_LD_ARCH`
893 Specifies architecture-specific linker flags for the build host. By 893 Specifies architecture-specific linker flags for the build host. By
894 default, the value of ``BUILD_LD_ARCH`` is empty. 894 default, the value of ``BUILD_LD_ARCH`` is empty.
895 895
896 BUILD_LDFLAGS 896 :term:`BUILD_LDFLAGS`
897 Specifies the flags to pass to the linker when building for the build 897 Specifies the flags to pass to the linker when building for the build
898 host. When building in the ``-native`` context, 898 host. When building in the ``-native`` context,
899 :term:`LDFLAGS` is set to the value of this variable 899 :term:`LDFLAGS` is set to the value of this variable
900 by default. 900 by default.
901 901
902 BUILD_OPTIMIZATION 902 :term:`BUILD_OPTIMIZATION`
903 Specifies the optimization flags passed to the C compiler when 903 Specifies the optimization flags passed to the C compiler when
904 building for the build host or the SDK. The flags are passed through 904 building for the build host or the SDK. The flags are passed through
905 the :term:`BUILD_CFLAGS` and 905 the :term:`BUILD_CFLAGS` and
@@ -908,25 +908,25 @@ system and gives an overview of their function and contents.
908 The default value of the ``BUILD_OPTIMIZATION`` variable is "-O2 908 The default value of the ``BUILD_OPTIMIZATION`` variable is "-O2
909 -pipe". 909 -pipe".
910 910
911 BUILD_OS 911 :term:`BUILD_OS`
912 Specifies the operating system in use on the build host (e.g. 912 Specifies the operating system in use on the build host (e.g.
913 "linux"). The OpenEmbedded build system sets the value of 913 "linux"). The OpenEmbedded build system sets the value of
914 ``BUILD_OS`` from the OS reported by the ``uname`` command - the 914 ``BUILD_OS`` from the OS reported by the ``uname`` command - the
915 first word, converted to lower-case characters. 915 first word, converted to lower-case characters.
916 916
917 BUILD_PREFIX 917 :term:`BUILD_PREFIX`
918 The toolchain binary prefix used for native recipes. The OpenEmbedded 918 The toolchain binary prefix used for native recipes. The OpenEmbedded
919 build system uses the ``BUILD_PREFIX`` value to set the 919 build system uses the ``BUILD_PREFIX`` value to set the
920 :term:`TARGET_PREFIX` when building for 920 :term:`TARGET_PREFIX` when building for
921 ``native`` recipes. 921 ``native`` recipes.
922 922
923 BUILD_STRIP 923 :term:`BUILD_STRIP`
924 Specifies the command to be used to strip debugging symbols from 924 Specifies the command to be used to strip debugging symbols from
925 binaries produced for the build host. By default, ``BUILD_STRIP`` 925 binaries produced for the build host. By default, ``BUILD_STRIP``
926 points to 926 points to
927 ``${``\ :term:`BUILD_PREFIX`\ ``}strip``. 927 ``${``\ :term:`BUILD_PREFIX`\ ``}strip``.
928 928
929 BUILD_SYS 929 :term:`BUILD_SYS`
930 Specifies the system, including the architecture and the operating 930 Specifies the system, including the architecture and the operating
931 system, to use when building for the build host (i.e. when building 931 system, to use when building for the build host (i.e. when building
932 ``native`` recipes). 932 ``native`` recipes).
@@ -937,11 +937,11 @@ system and gives an overview of their function and contents.
937 :term:`BUILD_OS`. You do not need to set the 937 :term:`BUILD_OS`. You do not need to set the
938 ``BUILD_SYS`` variable yourself. 938 ``BUILD_SYS`` variable yourself.
939 939
940 BUILD_VENDOR 940 :term:`BUILD_VENDOR`
941 Specifies the vendor name to use when building for the build host. 941 Specifies the vendor name to use when building for the build host.
942 The default value is an empty string (""). 942 The default value is an empty string ("").
943 943
944 BUILDDIR 944 :term:`BUILDDIR`
945 Points to the location of the :term:`Build Directory`. 945 Points to the location of the :term:`Build Directory`.
946 You can define this directory indirectly through the 946 You can define this directory indirectly through the
947 ````` <#structure-core-script>`__ script by passing in a Build 947 ````` <#structure-core-script>`__ script by passing in a Build
@@ -949,7 +949,7 @@ system and gives an overview of their function and contents.
949 not provide a Build Directory path, the ``BUILDDIR`` defaults to 949 not provide a Build Directory path, the ``BUILDDIR`` defaults to
950 ``build`` in the current directory. 950 ``build`` in the current directory.
951 951
952 BUILDHISTORY_COMMIT 952 :term:`BUILDHISTORY_COMMIT`
953 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 953 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
954 class, this variable specifies whether or not to commit the build 954 class, this variable specifies whether or not to commit the build
955 history output in a local Git repository. If set to "1", this local 955 history output in a local Git repository. If set to "1", this local
@@ -965,7 +965,7 @@ system and gives an overview of their function and contents.
965 965
966 BUILDHISTORY_COMMIT ?= "0" 966 BUILDHISTORY_COMMIT ?= "0"
967 967
968 BUILDHISTORY_COMMIT_AUTHOR 968 :term:`BUILDHISTORY_COMMIT_AUTHOR`
969 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 969 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
970 class, this variable specifies the author to use for each Git commit. 970 class, this variable specifies the author to use for each Git commit.
971 In order for the ``BUILDHISTORY_COMMIT_AUTHOR`` variable to work, the 971 In order for the ``BUILDHISTORY_COMMIT_AUTHOR`` variable to work, the
@@ -982,7 +982,7 @@ system and gives an overview of their function and contents.
982 982
983 BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>" 983 BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>"
984 984
985 BUILDHISTORY_DIR 985 :term:`BUILDHISTORY_DIR`
986 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 986 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
987 class, this variable specifies the directory in which build history 987 class, this variable specifies the directory in which build history
988 information is kept. For more information on how the variable works, 988 information is kept. For more information on how the variable works,
@@ -993,7 +993,7 @@ system and gives an overview of their function and contents.
993 993
994 BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory" 994 BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory"
995 995
996 BUILDHISTORY_FEATURES 996 :term:`BUILDHISTORY_FEATURES`
997 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 997 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
998 class, this variable specifies the build history features to be 998 class, this variable specifies the build history features to be
999 enabled. For more information on how build history works, see the 999 enabled. For more information on how build history works, see the
@@ -1022,7 +1022,7 @@ system and gives an overview of their function and contents.
1022 1022
1023 BUILDHISTORY_FEATURES ?= "image package sdk" 1023 BUILDHISTORY_FEATURES ?= "image package sdk"
1024 1024
1025 BUILDHISTORY_IMAGE_FILES 1025 :term:`BUILDHISTORY_IMAGE_FILES`
1026 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 1026 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
1027 class, this variable specifies a list of paths to files copied from 1027 class, this variable specifies a list of paths to files copied from
1028 the image contents into the build history directory under an 1028 the image contents into the build history directory under an
@@ -1039,7 +1039,7 @@ system and gives an overview of their function and contents.
1039 1039
1040 BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group" 1040 BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group"
1041 1041
1042 BUILDHISTORY_PUSH_REPO 1042 :term:`BUILDHISTORY_PUSH_REPO`
1043 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` 1043 When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
1044 class, this variable optionally specifies a remote repository to 1044 class, this variable optionally specifies a remote repository to
1045 which build history pushes Git changes. In order for 1045 which build history pushes Git changes. In order for
@@ -1057,38 +1057,38 @@ system and gives an overview of their function and contents.
1057 1057
1058 BUILDHISTORY_PUSH_REPO ?= "" 1058 BUILDHISTORY_PUSH_REPO ?= ""
1059 1059
1060 BUILDSDK_CFLAGS 1060 :term:`BUILDSDK_CFLAGS`
1061 Specifies the flags to pass to the C compiler when building for the 1061 Specifies the flags to pass to the C compiler when building for the
1062 SDK. When building in the ``nativesdk-`` context, 1062 SDK. When building in the ``nativesdk-`` context,
1063 :term:`CFLAGS` is set to the value of this variable by 1063 :term:`CFLAGS` is set to the value of this variable by
1064 default. 1064 default.
1065 1065
1066 BUILDSDK_CPPFLAGS 1066 :term:`BUILDSDK_CPPFLAGS`
1067 Specifies the flags to pass to the C pre-processor (i.e. to both the 1067 Specifies the flags to pass to the C pre-processor (i.e. to both the
1068 C and the C++ compilers) when building for the SDK. When building in 1068 C and the C++ compilers) when building for the SDK. When building in
1069 the ``nativesdk-`` context, :term:`CPPFLAGS` is set 1069 the ``nativesdk-`` context, :term:`CPPFLAGS` is set
1070 to the value of this variable by default. 1070 to the value of this variable by default.
1071 1071
1072 BUILDSDK_CXXFLAGS 1072 :term:`BUILDSDK_CXXFLAGS`
1073 Specifies the flags to pass to the C++ compiler when building for the 1073 Specifies the flags to pass to the C++ compiler when building for the
1074 SDK. When building in the ``nativesdk-`` context, 1074 SDK. When building in the ``nativesdk-`` context,
1075 :term:`CXXFLAGS` is set to the value of this variable 1075 :term:`CXXFLAGS` is set to the value of this variable
1076 by default. 1076 by default.
1077 1077
1078 BUILDSDK_LDFLAGS 1078 :term:`BUILDSDK_LDFLAGS`
1079 Specifies the flags to pass to the linker when building for the SDK. 1079 Specifies the flags to pass to the linker when building for the SDK.
1080 When building in the ``nativesdk-`` context, 1080 When building in the ``nativesdk-`` context,
1081 :term:`LDFLAGS` is set to the value of this variable 1081 :term:`LDFLAGS` is set to the value of this variable
1082 by default. 1082 by default.
1083 1083
1084 BUILDSTATS_BASE 1084 :term:`BUILDSTATS_BASE`
1085 Points to the location of the directory that holds build statistics 1085 Points to the location of the directory that holds build statistics
1086 when you use and enable the 1086 when you use and enable the
1087 :ref:`buildstats <ref-classes-buildstats>` class. The 1087 :ref:`buildstats <ref-classes-buildstats>` class. The
1088 ``BUILDSTATS_BASE`` directory defaults to 1088 ``BUILDSTATS_BASE`` directory defaults to
1089 ``${``\ :term:`TMPDIR`\ ``}/buildstats/``. 1089 ``${``\ :term:`TMPDIR`\ ``}/buildstats/``.
1090 1090
1091 BUSYBOX_SPLIT_SUID 1091 :term:`BUSYBOX_SPLIT_SUID`
1092 For the BusyBox recipe, specifies whether to split the output 1092 For the BusyBox recipe, specifies whether to split the output
1093 executable file into two parts: one for features that require 1093 executable file into two parts: one for features that require
1094 ``setuid root``, and one for the remaining features (i.e. those that 1094 ``setuid root``, and one for the remaining features (i.e. those that
@@ -1098,15 +1098,15 @@ system and gives an overview of their function and contents.
1098 splitting the output executable file. Set the variable to "0" to get 1098 splitting the output executable file. Set the variable to "0" to get
1099 a single output executable file. 1099 a single output executable file.
1100 1100
1101 CACHE 1101 :term:`CACHE`
1102 Specifies the directory BitBake uses to store a cache of the 1102 Specifies the directory BitBake uses to store a cache of the
1103 :term:`Metadata` so it does not need to be parsed every time 1103 :term:`Metadata` so it does not need to be parsed every time
1104 BitBake is started. 1104 BitBake is started.
1105 1105
1106 CC 1106 :term:`CC`
1107 The minimal command and arguments used to run the C compiler. 1107 The minimal command and arguments used to run the C compiler.
1108 1108
1109 CFLAGS 1109 :term:`CFLAGS`
1110 Specifies the flags to pass to the C compiler. This variable is 1110 Specifies the flags to pass to the C compiler. This variable is
1111 exported to an environment variable and thus made visible to the 1111 exported to an environment variable and thus made visible to the
1112 software being built during the compilation step. 1112 software being built during the compilation step.
@@ -1123,7 +1123,7 @@ system and gives an overview of their function and contents.
1123 - :term:`BUILDSDK_CFLAGS` when building for 1123 - :term:`BUILDSDK_CFLAGS` when building for
1124 an SDK (i.e. ``nativesdk-``) 1124 an SDK (i.e. ``nativesdk-``)
1125 1125
1126 CLASSOVERRIDE 1126 :term:`CLASSOVERRIDE`
1127 An internal variable specifying the special class override that 1127 An internal variable specifying the special class override that
1128 should currently apply (e.g. "class-target", "class-native", and so 1128 should currently apply (e.g. "class-target", "class-native", and so
1129 forth). The classes that use this variable (e.g. 1129 forth). The classes that use this variable (e.g.
@@ -1158,14 +1158,14 @@ system and gives an overview of their function and contents.
1158 that it is included in the default value of 1158 that it is included in the default value of
1159 :term:`OVERRIDES`. 1159 :term:`OVERRIDES`.
1160 1160
1161 CLEANBROKEN 1161 :term:`CLEANBROKEN`
1162 If set to "1" within a recipe, ``CLEANBROKEN`` specifies that the 1162 If set to "1" within a recipe, ``CLEANBROKEN`` specifies that the
1163 ``make clean`` command does not work for the software being built. 1163 ``make clean`` command does not work for the software being built.
1164 Consequently, the OpenEmbedded build system will not try to run 1164 Consequently, the OpenEmbedded build system will not try to run
1165 ``make clean`` during the :ref:`ref-tasks-configure` 1165 ``make clean`` during the :ref:`ref-tasks-configure`
1166 task, which is the default behavior. 1166 task, which is the default behavior.
1167 1167
1168 COMBINED_FEATURES 1168 :term:`COMBINED_FEATURES`
1169 Provides a list of hardware features that are enabled in both 1169 Provides a list of hardware features that are enabled in both
1170 :term:`MACHINE_FEATURES` and 1170 :term:`MACHINE_FEATURES` and
1171 :term:`DISTRO_FEATURES`. This select list of 1171 :term:`DISTRO_FEATURES`. This select list of
@@ -1175,12 +1175,12 @@ system and gives an overview of their function and contents.
1175 optional at the distribution level, in case the hardware supports 1175 optional at the distribution level, in case the hardware supports
1176 Bluetooth but you do not ever intend to use it. 1176 Bluetooth but you do not ever intend to use it.
1177 1177
1178 COMMON_LICENSE_DIR 1178 :term:`COMMON_LICENSE_DIR`
1179 Points to ``meta/files/common-licenses`` in the 1179 Points to ``meta/files/common-licenses`` in the
1180 :term:`Source Directory`, which is where generic license 1180 :term:`Source Directory`, which is where generic license
1181 files reside. 1181 files reside.
1182 1182
1183 COMPATIBLE_HOST 1183 :term:`COMPATIBLE_HOST`
1184 A regular expression that resolves to one or more hosts (when the 1184 A regular expression that resolves to one or more hosts (when the
1185 recipe is native) or one or more targets (when the recipe is 1185 recipe is native) or one or more targets (when the recipe is
1186 non-native) with which a recipe is compatible. The regular expression 1186 non-native) with which a recipe is compatible. The regular expression
@@ -1191,7 +1191,7 @@ system and gives an overview of their function and contents.
1191 parsing speed since the build system skips parsing recipes not 1191 parsing speed since the build system skips parsing recipes not
1192 compatible with the current system. 1192 compatible with the current system.
1193 1193
1194 COMPATIBLE_MACHINE 1194 :term:`COMPATIBLE_MACHINE`
1195 A regular expression that resolves to one or more target machines 1195 A regular expression that resolves to one or more target machines
1196 with which a recipe is compatible. The regular expression is matched 1196 with which a recipe is compatible. The regular expression is matched
1197 against :term:`MACHINEOVERRIDES`. You can use 1197 against :term:`MACHINEOVERRIDES`. You can use
@@ -1201,7 +1201,7 @@ system and gives an overview of their function and contents.
1201 speed since the build system skips parsing recipes not compatible 1201 speed since the build system skips parsing recipes not compatible
1202 with the current machine. 1202 with the current machine.
1203 1203
1204 COMPLEMENTARY_GLOB 1204 :term:`COMPLEMENTARY_GLOB`
1205 Defines wildcards to match when installing a list of complementary 1205 Defines wildcards to match when installing a list of complementary
1206 packages for all the packages explicitly (or implicitly) installed in 1206 packages for all the packages explicitly (or implicitly) installed in
1207 an image. 1207 an image.
@@ -1230,7 +1230,7 @@ system and gives an overview of their function and contents.
1230 1230
1231 COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev' 1231 COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev'
1232 1232
1233 COMPONENTS_DIR 1233 :term:`COMPONENTS_DIR`
1234 Stores sysroot components for each recipe. The OpenEmbedded build 1234 Stores sysroot components for each recipe. The OpenEmbedded build
1235 system uses ``COMPONENTS_DIR`` when constructing recipe-specific 1235 system uses ``COMPONENTS_DIR`` when constructing recipe-specific
1236 sysroots for other recipes. 1236 sysroots for other recipes.
@@ -1240,12 +1240,12 @@ system and gives an overview of their function and contents.
1240 (i.e. 1240 (i.e.
1241 "``${``\ :term:`TMPDIR`\ ``}/sysroots-components``"). 1241 "``${``\ :term:`TMPDIR`\ ``}/sysroots-components``").
1242 1242
1243 CONF_VERSION 1243 :term:`CONF_VERSION`
1244 Tracks the version of the local configuration file (i.e. 1244 Tracks the version of the local configuration file (i.e.
1245 ``local.conf``). The value for ``CONF_VERSION`` increments each time 1245 ``local.conf``). The value for ``CONF_VERSION`` increments each time
1246 ``build/conf/`` compatibility changes. 1246 ``build/conf/`` compatibility changes.
1247 1247
1248 CONFFILES 1248 :term:`CONFFILES`
1249 Identifies editable or configurable files that are part of a package. 1249 Identifies editable or configurable files that are part of a package.
1250 If the Package Management System (PMS) is being used to update 1250 If the Package Management System (PMS) is being used to update
1251 packages on the target system, it is possible that configuration 1251 packages on the target system, it is possible that configuration
@@ -1291,7 +1291,7 @@ system and gives an overview of their function and contents.
1291 Source Directory 1291 Source Directory
1292 . 1292 .
1293 1293
1294 CONFIG_INITRAMFS_SOURCE 1294 :term:`CONFIG_INITRAMFS_SOURCE`
1295 Identifies the initial RAM filesystem (initramfs) source files. The 1295 Identifies the initial RAM filesystem (initramfs) source files. The
1296 OpenEmbedded build system receives and uses this kernel Kconfig 1296 OpenEmbedded build system receives and uses this kernel Kconfig
1297 variable as an environment variable. By default, the variable is set 1297 variable as an environment variable. By default, the variable is set
@@ -1312,15 +1312,15 @@ system and gives an overview of their function and contents.
1312 ":ref:`building-an-initramfs-image`" section 1312 ":ref:`building-an-initramfs-image`" section
1313 in the Yocto Project Development Tasks Manual. 1313 in the Yocto Project Development Tasks Manual.
1314 1314
1315 CONFIG_SITE 1315 :term:`CONFIG_SITE`
1316 A list of files that contains ``autoconf`` test results relevant to 1316 A list of files that contains ``autoconf`` test results relevant to
1317 the current build. This variable is used by the Autotools utilities 1317 the current build. This variable is used by the Autotools utilities
1318 when running ``configure``. 1318 when running ``configure``.
1319 1319
1320 CONFIGURE_FLAGS 1320 :term:`CONFIGURE_FLAGS`
1321 The minimal arguments for GNU configure. 1321 The minimal arguments for GNU configure.
1322 1322
1323 CONFLICT_DISTRO_FEATURES 1323 :term:`CONFLICT_DISTRO_FEATURES`
1324 When inheriting the 1324 When inheriting the
1325 :ref:`distro_features_check <ref-classes-distro_features_check>` 1325 :ref:`distro_features_check <ref-classes-distro_features_check>`
1326 class, this variable identifies distribution features that would be 1326 class, this variable identifies distribution features that would be
@@ -1329,7 +1329,7 @@ system and gives an overview of their function and contents.
1329 appears in ``DISTRO_FEATURES`` within the current configuration, an 1329 appears in ``DISTRO_FEATURES`` within the current configuration, an
1330 error occurs and the build stops. 1330 error occurs and the build stops.
1331 1331
1332 COPYLEFT_LICENSE_EXCLUDE 1332 :term:`COPYLEFT_LICENSE_EXCLUDE`
1333 A space-separated list of licenses to exclude from the source 1333 A space-separated list of licenses to exclude from the source
1334 archived by the :ref:`archiver <ref-classes-archiver>` class. In 1334 archived by the :ref:`archiver <ref-classes-archiver>` class. In
1335 other words, if a license in a recipe's 1335 other words, if a license in a recipe's
@@ -1350,7 +1350,7 @@ system and gives an overview of their function and contents.
1350 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which 1350 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
1351 is inherited by the ``archiver`` class. 1351 is inherited by the ``archiver`` class.
1352 1352
1353 COPYLEFT_LICENSE_INCLUDE 1353 :term:`COPYLEFT_LICENSE_INCLUDE`
1354 A space-separated list of licenses to include in the source archived 1354 A space-separated list of licenses to include in the source archived
1355 by the :ref:`archiver <ref-classes-archiver>` class. In other 1355 by the :ref:`archiver <ref-classes-archiver>` class. In other
1356 words, if a license in a recipe's :term:`LICENSE` 1356 words, if a license in a recipe's :term:`LICENSE`
@@ -1362,7 +1362,7 @@ system and gives an overview of their function and contents.
1362 is inherited by the ``archiver`` class. The default value includes 1362 is inherited by the ``archiver`` class. The default value includes
1363 "GPL*", "LGPL*", and "AGPL*". 1363 "GPL*", "LGPL*", and "AGPL*".
1364 1364
1365 COPYLEFT_PN_EXCLUDE 1365 :term:`COPYLEFT_PN_EXCLUDE`
1366 A list of recipes to exclude in the source archived by the 1366 A list of recipes to exclude in the source archived by the
1367 :ref:`archiver <ref-classes-archiver>` class. The 1367 :ref:`archiver <ref-classes-archiver>` class. The
1368 ``COPYLEFT_PN_EXCLUDE`` variable overrides the license inclusion and 1368 ``COPYLEFT_PN_EXCLUDE`` variable overrides the license inclusion and
@@ -1376,7 +1376,7 @@ system and gives an overview of their function and contents.
1376 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which 1376 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
1377 is inherited by the ``archiver`` class. 1377 is inherited by the ``archiver`` class.
1378 1378
1379 COPYLEFT_PN_INCLUDE 1379 :term:`COPYLEFT_PN_INCLUDE`
1380 A list of recipes to include in the source archived by the 1380 A list of recipes to include in the source archived by the
1381 :ref:`archiver <ref-classes-archiver>` class. The 1381 :ref:`archiver <ref-classes-archiver>` class. The
1382 ``COPYLEFT_PN_INCLUDE`` variable overrides the license inclusion and 1382 ``COPYLEFT_PN_INCLUDE`` variable overrides the license inclusion and
@@ -1390,7 +1390,7 @@ system and gives an overview of their function and contents.
1390 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which 1390 :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which
1391 is inherited by the ``archiver`` class. 1391 is inherited by the ``archiver`` class.
1392 1392
1393 COPYLEFT_RECIPE_TYPES 1393 :term:`COPYLEFT_RECIPE_TYPES`
1394 A space-separated list of recipe types to include in the source 1394 A space-separated list of recipe types to include in the source
1395 archived by the :ref:`archiver <ref-classes-archiver>` class. 1395 archived by the :ref:`archiver <ref-classes-archiver>` class.
1396 Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``, 1396 Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``,
@@ -1400,7 +1400,7 @@ system and gives an overview of their function and contents.
1400 is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>` 1400 is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>`
1401 class, which is inherited by the ``archiver`` class. 1401 class, which is inherited by the ``archiver`` class.
1402 1402
1403 COPY_LIC_DIRS 1403 :term:`COPY_LIC_DIRS`
1404 If set to "1" along with the 1404 If set to "1" along with the
1405 :term:`COPY_LIC_MANIFEST` variable, the 1405 :term:`COPY_LIC_MANIFEST` variable, the
1406 OpenEmbedded build system copies into the image the license files, 1406 OpenEmbedded build system copies into the image the license files,
@@ -1421,7 +1421,7 @@ system and gives an overview of their function and contents.
1421 " section in the Yocto Project Development Tasks Manual for 1421 " section in the Yocto Project Development Tasks Manual for
1422 information on providing license text. 1422 information on providing license text.
1423 1423
1424 COPY_LIC_MANIFEST 1424 :term:`COPY_LIC_MANIFEST`
1425 If set to "1", the OpenEmbedded build system copies the license 1425 If set to "1", the OpenEmbedded build system copies the license
1426 manifest for the image to 1426 manifest for the image to
1427 ``/usr/share/common-licenses/license.manifest`` within the image 1427 ``/usr/share/common-licenses/license.manifest`` within the image
@@ -1440,7 +1440,7 @@ system and gives an overview of their function and contents.
1440 " section in the Yocto Project Development Tasks Manual for 1440 " section in the Yocto Project Development Tasks Manual for
1441 information on providing license text. 1441 information on providing license text.
1442 1442
1443 CORE_IMAGE_EXTRA_INSTALL 1443 :term:`CORE_IMAGE_EXTRA_INSTALL`
1444 Specifies the list of packages to be added to the image. You should 1444 Specifies the list of packages to be added to the image. You should
1445 only set this variable in the ``local.conf`` configuration file found 1445 only set this variable in the ``local.conf`` configuration file found
1446 in the :term:`Build Directory`. 1446 in the :term:`Build Directory`.
@@ -1448,7 +1448,7 @@ system and gives an overview of their function and contents.
1448 This variable replaces ``POKY_EXTRA_INSTALL``, which is no longer 1448 This variable replaces ``POKY_EXTRA_INSTALL``, which is no longer
1449 supported. 1449 supported.
1450 1450
1451 COREBASE 1451 :term:`COREBASE`
1452 Specifies the parent directory of the OpenEmbedded-Core Metadata 1452 Specifies the parent directory of the OpenEmbedded-Core Metadata
1453 layer (i.e. ``meta``). 1453 layer (i.e. ``meta``).
1454 1454
@@ -1459,7 +1459,7 @@ system and gives an overview of their function and contents.
1459 points to the ``poky`` folder because it is the parent directory of 1459 points to the ``poky`` folder because it is the parent directory of
1460 the ``poky/meta`` layer. 1460 the ``poky/meta`` layer.
1461 1461
1462 COREBASE_FILES 1462 :term:`COREBASE_FILES`
1463 Lists files from the :term:`COREBASE` directory that 1463 Lists files from the :term:`COREBASE` directory that
1464 should be copied other than the layers listed in the 1464 should be copied other than the layers listed in the
1465 ``bblayers.conf`` file. The ``COREBASE_FILES`` variable exists for 1465 ``bblayers.conf`` file. The ``COREBASE_FILES`` variable exists for
@@ -1472,10 +1472,10 @@ system and gives an overview of their function and contents.
1472 of ``COREBASE_FILES`` is used in order to only copy the files that 1472 of ``COREBASE_FILES`` is used in order to only copy the files that
1473 are actually needed. 1473 are actually needed.
1474 1474
1475 CPP 1475 :term:`CPP`
1476 The minimal command and arguments used to run the C preprocessor. 1476 The minimal command and arguments used to run the C preprocessor.
1477 1477
1478 CPPFLAGS 1478 :term:`CPPFLAGS`
1479 Specifies the flags to pass to the C pre-processor (i.e. to both the 1479 Specifies the flags to pass to the C pre-processor (i.e. to both the
1480 C and the C++ compilers). This variable is exported to an environment 1480 C and the C++ compilers). This variable is exported to an environment
1481 variable and thus made visible to the software being built during the 1481 variable and thus made visible to the software being built during the
@@ -1493,7 +1493,7 @@ system and gives an overview of their function and contents.
1493 - :term:`BUILDSDK_CPPFLAGS` when building 1493 - :term:`BUILDSDK_CPPFLAGS` when building
1494 for an SDK (i.e. ``nativesdk-``) 1494 for an SDK (i.e. ``nativesdk-``)
1495 1495
1496 CROSS_COMPILE 1496 :term:`CROSS_COMPILE`
1497 The toolchain binary prefix for the target tools. The 1497 The toolchain binary prefix for the target tools. The
1498 ``CROSS_COMPILE`` variable is the same as the 1498 ``CROSS_COMPILE`` variable is the same as the
1499 :term:`TARGET_PREFIX` variable. 1499 :term:`TARGET_PREFIX` variable.
@@ -1505,14 +1505,14 @@ system and gives an overview of their function and contents.
1505 variable only in certain contexts (e.g. when building for kernel 1505 variable only in certain contexts (e.g. when building for kernel
1506 and kernel module recipes). 1506 and kernel module recipes).
1507 1507
1508 CVSDIR 1508 :term:`CVSDIR`
1509 The directory in which files checked out under the CVS system are 1509 The directory in which files checked out under the CVS system are
1510 stored. 1510 stored.
1511 1511
1512 CXX 1512 :term:`CXX`
1513 The minimal command and arguments used to run the C++ compiler. 1513 The minimal command and arguments used to run the C++ compiler.
1514 1514
1515 CXXFLAGS 1515 :term:`CXXFLAGS`
1516 Specifies the flags to pass to the C++ compiler. This variable is 1516 Specifies the flags to pass to the C++ compiler. This variable is
1517 exported to an environment variable and thus made visible to the 1517 exported to an environment variable and thus made visible to the
1518 software being built during the compilation step. 1518 software being built during the compilation step.
@@ -1529,7 +1529,7 @@ system and gives an overview of their function and contents.
1529 - :term:`BUILDSDK_CXXFLAGS` when building 1529 - :term:`BUILDSDK_CXXFLAGS` when building
1530 for an SDK (i.e. ``nativesdk-``) 1530 for an SDK (i.e. ``nativesdk-``)
1531 1531
1532 D 1532 :term:`D`
1533 The destination directory. The location in the :term:`Build Directory` 1533 The destination directory. The location in the :term:`Build Directory`
1534 where components are installed by the 1534 where components are installed by the
1535 :ref:`ref-tasks-install` task. This location defaults 1535 :ref:`ref-tasks-install` task. This location defaults
@@ -1544,15 +1544,15 @@ system and gives an overview of their function and contents.
1544 fakeroot 1544 fakeroot
1545 . 1545 .
1546 1546
1547 DATE 1547 :term:`DATE`
1548 The date the build was started. Dates appear using the year, month, 1548 The date the build was started. Dates appear using the year, month,
1549 and day (YMD) format (e.g. "20150209" for February 9th, 2015). 1549 and day (YMD) format (e.g. "20150209" for February 9th, 2015).
1550 1550
1551 DATETIME 1551 :term:`DATETIME`
1552 The date and time on which the current build started. The format is 1552 The date and time on which the current build started. The format is
1553 suitable for timestamps. 1553 suitable for timestamps.
1554 1554
1555 DEBIAN_NOAUTONAME 1555 :term:`DEBIAN_NOAUTONAME`
1556 When the :ref:`debian <ref-classes-debian>` class is inherited, 1556 When the :ref:`debian <ref-classes-debian>` class is inherited,
1557 which is the default behavior, ``DEBIAN_NOAUTONAME`` specifies a 1557 which is the default behavior, ``DEBIAN_NOAUTONAME`` specifies a
1558 particular package should not be renamed according to Debian library 1558 particular package should not be renamed according to Debian library
@@ -1562,7 +1562,7 @@ system and gives an overview of their function and contents.
1562 1562
1563 DEBIAN_NOAUTONAME_fontconfig-utils = "1" 1563 DEBIAN_NOAUTONAME_fontconfig-utils = "1"
1564 1564
1565 DEBIANNAME 1565 :term:`DEBIANNAME`
1566 When the :ref:`debian <ref-classes-debian>` class is inherited, 1566 When the :ref:`debian <ref-classes-debian>` class is inherited,
1567 which is the default behavior, ``DEBIANNAME`` allows you to override 1567 which is the default behavior, ``DEBIANNAME`` allows you to override
1568 the library name for an individual package. Overriding the library 1568 the library name for an individual package. Overriding the library
@@ -1573,16 +1573,16 @@ system and gives an overview of their function and contents.
1573 1573
1574 DEBIANNAME_${PN} = "dbus-1" 1574 DEBIANNAME_${PN} = "dbus-1"
1575 1575
1576 DEBUG_BUILD 1576 :term:`DEBUG_BUILD`
1577 Specifies to build packages with debugging information. This 1577 Specifies to build packages with debugging information. This
1578 influences the value of the ``SELECTED_OPTIMIZATION`` variable. 1578 influences the value of the ``SELECTED_OPTIMIZATION`` variable.
1579 1579
1580 DEBUG_OPTIMIZATION 1580 :term:`DEBUG_OPTIMIZATION`
1581 The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when 1581 The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when
1582 compiling a system for debugging. This variable defaults to "-O 1582 compiling a system for debugging. This variable defaults to "-O
1583 -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe". 1583 -fno-omit-frame-pointer ${DEBUG_FLAGS} -pipe".
1584 1584
1585 DEFAULT_PREFERENCE 1585 :term:`DEFAULT_PREFERENCE`
1586 Specifies a weak bias for recipe selection priority. 1586 Specifies a weak bias for recipe selection priority.
1587 1587
1588 The most common usage of this is variable is to set it to "-1" within 1588 The most common usage of this is variable is to set it to "-1" within
@@ -1600,7 +1600,7 @@ system and gives an overview of their function and contents.
1600 if that variable is different between two layers that contain 1600 if that variable is different between two layers that contain
1601 different versions of the same recipe. 1601 different versions of the same recipe.
1602 1602
1603 DEFAULTTUNE 1603 :term:`DEFAULTTUNE`
1604 The default CPU and Application Binary Interface (ABI) tunings (i.e. 1604 The default CPU and Application Binary Interface (ABI) tunings (i.e.
1605 the "tune") used by the OpenEmbedded build system. The 1605 the "tune") used by the OpenEmbedded build system. The
1606 ``DEFAULTTUNE`` helps define 1606 ``DEFAULTTUNE`` helps define
@@ -1611,7 +1611,7 @@ system and gives an overview of their function and contents.
1611 the setting using available tunes as defined with 1611 the setting using available tunes as defined with
1612 :term:`AVAILTUNES`. 1612 :term:`AVAILTUNES`.
1613 1613
1614 DEPENDS 1614 :term:`DEPENDS`
1615 Lists a recipe's build-time dependencies. These are dependencies on 1615 Lists a recipe's build-time dependencies. These are dependencies on
1616 other recipes whose contents (e.g. headers and shared libraries) are 1616 other recipes whose contents (e.g. headers and shared libraries) are
1617 needed by the recipe at build time. 1617 needed by the recipe at build time.
@@ -1686,7 +1686,7 @@ system and gives an overview of their function and contents.
1686 BitBake User Manual for additional information on tasks and 1686 BitBake User Manual for additional information on tasks and
1687 dependencies. 1687 dependencies.
1688 1688
1689 DEPLOY_DIR 1689 :term:`DEPLOY_DIR`
1690 Points to the general area that the OpenEmbedded build system uses to 1690 Points to the general area that the OpenEmbedded build system uses to
1691 place images, packages, SDKs, and other output files that are ready 1691 place images, packages, SDKs, and other output files that are ready
1692 to be used outside of the build system. By default, this directory 1692 to be used outside of the build system. By default, this directory
@@ -1701,7 +1701,7 @@ system and gives an overview of their function and contents.
1701 ":ref:`sdk-dev-environment`" sections all in the 1701 ":ref:`sdk-dev-environment`" sections all in the
1702 Yocto Project Overview and Concepts Manual. 1702 Yocto Project Overview and Concepts Manual.
1703 1703
1704 DEPLOY_DIR_DEB 1704 :term:`DEPLOY_DIR_DEB`
1705 Points to the area that the OpenEmbedded build system uses to place 1705 Points to the area that the OpenEmbedded build system uses to place
1706 Debian packages that are ready to be used outside of the build 1706 Debian packages that are ready to be used outside of the build
1707 system. This variable applies only when 1707 system. This variable applies only when
@@ -1723,7 +1723,7 @@ system and gives an overview of their function and contents.
1723 Feeds <package-feeds-dev-environment>`" section 1723 Feeds <package-feeds-dev-environment>`" section
1724 in the Yocto Project Overview and Concepts Manual. 1724 in the Yocto Project Overview and Concepts Manual.
1725 1725
1726 DEPLOY_DIR_IMAGE 1726 :term:`DEPLOY_DIR_IMAGE`
1727 Points to the area that the OpenEmbedded build system uses to place 1727 Points to the area that the OpenEmbedded build system uses to place
1728 images and other associated output files that are ready to be 1728 images and other associated output files that are ready to be
1729 deployed onto the target machine. The directory is machine-specific 1729 deployed onto the target machine. The directory is machine-specific
@@ -1738,7 +1738,7 @@ system and gives an overview of their function and contents.
1738 ":ref:`sdk-dev-environment`" sections both in 1738 ":ref:`sdk-dev-environment`" sections both in
1739 the Yocto Project Overview and Concepts Manual. 1739 the Yocto Project Overview and Concepts Manual.
1740 1740
1741 DEPLOY_DIR_IPK 1741 :term:`DEPLOY_DIR_IPK`
1742 Points to the area that the OpenEmbedded build system uses to place 1742 Points to the area that the OpenEmbedded build system uses to place
1743 IPK packages that are ready to be used outside of the build system. 1743 IPK packages that are ready to be used outside of the build system.
1744 This variable applies only when 1744 This variable applies only when
@@ -1759,7 +1759,7 @@ system and gives an overview of their function and contents.
1759 Feeds <package-feeds-dev-environment>`" section 1759 Feeds <package-feeds-dev-environment>`" section
1760 in the Yocto Project Overview and Concepts Manual. 1760 in the Yocto Project Overview and Concepts Manual.
1761 1761
1762 DEPLOY_DIR_RPM 1762 :term:`DEPLOY_DIR_RPM`
1763 Points to the area that the OpenEmbedded build system uses to place 1763 Points to the area that the OpenEmbedded build system uses to place
1764 RPM packages that are ready to be used outside of the build system. 1764 RPM packages that are ready to be used outside of the build system.
1765 This variable applies only when 1765 This variable applies only when
@@ -1780,7 +1780,7 @@ system and gives an overview of their function and contents.
1780 Feeds <package-feeds-dev-environment>`" section 1780 Feeds <package-feeds-dev-environment>`" section
1781 in the Yocto Project Overview and Concepts Manual. 1781 in the Yocto Project Overview and Concepts Manual.
1782 1782
1783 DEPLOY_DIR_TAR 1783 :term:`DEPLOY_DIR_TAR`
1784 Points to the area that the OpenEmbedded build system uses to place 1784 Points to the area that the OpenEmbedded build system uses to place
1785 tarballs that are ready to be used outside of the build system. This 1785 tarballs that are ready to be used outside of the build system. This
1786 variable applies only when 1786 variable applies only when
@@ -1801,7 +1801,7 @@ system and gives an overview of their function and contents.
1801 Feeds <package-feeds-dev-environment>`" section 1801 Feeds <package-feeds-dev-environment>`" section
1802 in the Yocto Project Overview and Concepts Manual. 1802 in the Yocto Project Overview and Concepts Manual.
1803 1803
1804 DEPLOYDIR 1804 :term:`DEPLOYDIR`
1805 When inheriting the :ref:`deploy <ref-classes-deploy>` class, the 1805 When inheriting the :ref:`deploy <ref-classes-deploy>` class, the
1806 ``DEPLOYDIR`` points to a temporary work area for deployed files that 1806 ``DEPLOYDIR`` points to a temporary work area for deployed files that
1807 is set in the ``deploy`` class as follows: 1807 is set in the ``deploy`` class as follows:
@@ -1814,12 +1814,12 @@ system and gives an overview of their function and contents.
1814 them into :term:`DEPLOY_DIR_IMAGE` 1814 them into :term:`DEPLOY_DIR_IMAGE`
1815 afterwards. 1815 afterwards.
1816 1816
1817 DESCRIPTION 1817 :term:`DESCRIPTION`
1818 The package description used by package managers. If not set, 1818 The package description used by package managers. If not set,
1819 ``DESCRIPTION`` takes the value of the :term:`SUMMARY` 1819 ``DESCRIPTION`` takes the value of the :term:`SUMMARY`
1820 variable. 1820 variable.
1821 1821
1822 DISTRO 1822 :term:`DISTRO`
1823 The short name of the distribution. For information on the long name 1823 The short name of the distribution. For information on the long name
1824 of the distribution, see the :term:`DISTRO_NAME` 1824 of the distribution, see the :term:`DISTRO_NAME`
1825 variable. 1825 variable.
@@ -1851,10 +1851,10 @@ system and gives an overview of their function and contents.
1851 meta/conf/distro/defaultsetup.conf 1851 meta/conf/distro/defaultsetup.conf
1852 also in the Source Directory. 1852 also in the Source Directory.
1853 1853
1854 DISTRO_CODENAME 1854 :term:`DISTRO_CODENAME`
1855 Specifies a codename for the distribution being built. 1855 Specifies a codename for the distribution being built.
1856 1856
1857 DISTRO_EXTRA_RDEPENDS 1857 :term:`DISTRO_EXTRA_RDEPENDS`
1858 Specifies a list of distro-specific packages to add to all images. 1858 Specifies a list of distro-specific packages to add to all images.
1859 This variable takes affect through ``packagegroup-base`` so the 1859 This variable takes affect through ``packagegroup-base`` so the
1860 variable only really applies to the more full-featured images that 1860 variable only really applies to the more full-featured images that
@@ -1862,13 +1862,13 @@ system and gives an overview of their function and contents.
1862 distro policy out of generic images. As with all other distro 1862 distro policy out of generic images. As with all other distro
1863 variables, you set this variable in the distro ``.conf`` file. 1863 variables, you set this variable in the distro ``.conf`` file.
1864 1864
1865 DISTRO_EXTRA_RRECOMMENDS 1865 :term:`DISTRO_EXTRA_RRECOMMENDS`
1866 Specifies a list of distro-specific packages to add to all images if 1866 Specifies a list of distro-specific packages to add to all images if
1867 the packages exist. The packages might not exist or be empty (e.g. 1867 the packages exist. The packages might not exist or be empty (e.g.
1868 kernel modules). The list of packages are automatically installed but 1868 kernel modules). The list of packages are automatically installed but
1869 you can remove them. 1869 you can remove them.
1870 1870
1871 DISTRO_FEATURES 1871 :term:`DISTRO_FEATURES`
1872 The software support you want in your distribution for various 1872 The software support you want in your distribution for various
1873 features. You define your distribution features in the distribution 1873 features. You define your distribution features in the distribution
1874 configuration file. 1874 configuration file.
@@ -1887,7 +1887,7 @@ system and gives an overview of their function and contents.
1887 provide with this variable, see the "`Distro 1887 provide with this variable, see the "`Distro
1888 Features <#ref-features-distro>`__" section. 1888 Features <#ref-features-distro>`__" section.
1889 1889
1890 DISTRO_FEATURES_BACKFILL 1890 :term:`DISTRO_FEATURES_BACKFILL`
1891 Features to be added to ``DISTRO_FEATURES`` if not also present in 1891 Features to be added to ``DISTRO_FEATURES`` if not also present in
1892 ``DISTRO_FEATURES_BACKFILL_CONSIDERED``. 1892 ``DISTRO_FEATURES_BACKFILL_CONSIDERED``.
1893 1893
@@ -1898,13 +1898,13 @@ system and gives an overview of their function and contents.
1898 Backfilling <#ref-features-backfill>`__" section for more 1898 Backfilling <#ref-features-backfill>`__" section for more
1899 information. 1899 information.
1900 1900
1901 DISTRO_FEATURES_BACKFILL_CONSIDERED 1901 :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
1902 Features from ``DISTRO_FEATURES_BACKFILL`` that should not be 1902 Features from ``DISTRO_FEATURES_BACKFILL`` that should not be
1903 backfilled (i.e. added to ``DISTRO_FEATURES``) during the build. See 1903 backfilled (i.e. added to ``DISTRO_FEATURES``) during the build. See
1904 the "`Feature Backfilling <#ref-features-backfill>`__" section for 1904 the "`Feature Backfilling <#ref-features-backfill>`__" section for
1905 more information. 1905 more information.
1906 1906
1907 DISTRO_FEATURES_DEFAULT 1907 :term:`DISTRO_FEATURES_DEFAULT`
1908 A convenience variable that gives you the default list of distro 1908 A convenience variable that gives you the default list of distro
1909 features with the exception of any features specific to the C library 1909 features with the exception of any features specific to the C library
1910 (``libc``). 1910 (``libc``).
@@ -1918,7 +1918,7 @@ system and gives an overview of their function and contents.
1918 1918
1919 DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} myfeature" 1919 DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} myfeature"
1920 1920
1921 DISTRO_FEATURES_FILTER_NATIVE 1921 :term:`DISTRO_FEATURES_FILTER_NATIVE`
1922 Specifies a list of features that if present in the target 1922 Specifies a list of features that if present in the target
1923 :term:`DISTRO_FEATURES` value should be 1923 :term:`DISTRO_FEATURES` value should be
1924 included in ``DISTRO_FEATURES`` when building native recipes. This 1924 included in ``DISTRO_FEATURES`` when building native recipes. This
@@ -1926,7 +1926,7 @@ system and gives an overview of their function and contents.
1926 :term:`DISTRO_FEATURES_NATIVE` 1926 :term:`DISTRO_FEATURES_NATIVE`
1927 variable. 1927 variable.
1928 1928
1929 DISTRO_FEATURES_FILTER_NATIVESDK 1929 :term:`DISTRO_FEATURES_FILTER_NATIVESDK`
1930 Specifies a list of features that if present in the target 1930 Specifies a list of features that if present in the target
1931 :term:`DISTRO_FEATURES` value should be 1931 :term:`DISTRO_FEATURES` value should be
1932 included in ``DISTRO_FEATURES`` when building nativesdk recipes. This 1932 included in ``DISTRO_FEATURES`` when building nativesdk recipes. This
@@ -1934,7 +1934,7 @@ system and gives an overview of their function and contents.
1934 :term:`DISTRO_FEATURES_NATIVESDK` 1934 :term:`DISTRO_FEATURES_NATIVESDK`
1935 variable. 1935 variable.
1936 1936
1937 DISTRO_FEATURES_NATIVE 1937 :term:`DISTRO_FEATURES_NATIVE`
1938 Specifies a list of features that should be included in 1938 Specifies a list of features that should be included in
1939 :term:`DISTRO_FEATURES` when building native 1939 :term:`DISTRO_FEATURES` when building native
1940 recipes. This variable is used in addition to the features filtered 1940 recipes. This variable is used in addition to the features filtered
@@ -1942,7 +1942,7 @@ system and gives an overview of their function and contents.
1942 :term:`DISTRO_FEATURES_FILTER_NATIVE` 1942 :term:`DISTRO_FEATURES_FILTER_NATIVE`
1943 variable. 1943 variable.
1944 1944
1945 DISTRO_FEATURES_NATIVESDK 1945 :term:`DISTRO_FEATURES_NATIVESDK`
1946 Specifies a list of features that should be included in 1946 Specifies a list of features that should be included in
1947 :term:`DISTRO_FEATURES` when building 1947 :term:`DISTRO_FEATURES` when building
1948 nativesdk recipes. This variable is used in addition to the features 1948 nativesdk recipes. This variable is used in addition to the features
@@ -1950,7 +1950,7 @@ system and gives an overview of their function and contents.
1950 :term:`DISTRO_FEATURES_FILTER_NATIVESDK` 1950 :term:`DISTRO_FEATURES_FILTER_NATIVESDK`
1951 variable. 1951 variable.
1952 1952
1953 DISTRO_NAME 1953 :term:`DISTRO_NAME`
1954 The long name of the distribution. For information on the short name 1954 The long name of the distribution. For information on the short name
1955 of the distribution, see the :term:`DISTRO` variable. 1955 of the distribution, see the :term:`DISTRO` variable.
1956 1956
@@ -1980,10 +1980,10 @@ system and gives an overview of their function and contents.
1980 meta/conf/distro/defaultsetup.conf 1980 meta/conf/distro/defaultsetup.conf
1981 also in the Source Directory. 1981 also in the Source Directory.
1982 1982
1983 DISTRO_VERSION 1983 :term:`DISTRO_VERSION`
1984 The version of the distribution. 1984 The version of the distribution.
1985 1985
1986 DISTROOVERRIDES 1986 :term:`DISTROOVERRIDES`
1987 A colon-separated list of overrides specific to the current 1987 A colon-separated list of overrides specific to the current
1988 distribution. By default, this list includes the value of 1988 distribution. By default, this list includes the value of
1989 :term:`DISTRO`. 1989 :term:`DISTRO`.
@@ -1995,7 +1995,7 @@ system and gives an overview of their function and contents.
1995 is included in the default value of 1995 is included in the default value of
1996 :term:`OVERRIDES`. 1996 :term:`OVERRIDES`.
1997 1997
1998 DL_DIR 1998 :term:`DL_DIR`
1999 The central download directory used by the build process to store 1999 The central download directory used by the build process to store
2000 downloads. By default, ``DL_DIR`` gets files suitable for mirroring 2000 downloads. By default, ``DL_DIR`` gets files suitable for mirroring
2001 for everything except Git repositories. If you want tarballs of Git 2001 for everything except Git repositories. If you want tarballs of Git
@@ -2034,7 +2034,7 @@ system and gives an overview of their function and contents.
2034 ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`" 2034 ":yocto_wiki:`Working Behind a Network Proxy </wiki/Working_Behind_a_Network_Proxy>`"
2035 Wiki page. 2035 Wiki page.
2036 2036
2037 DOC_COMPRESS 2037 :term:`DOC_COMPRESS`
2038 When inheriting the :ref:`compress_doc <ref-classes-compress_doc>` 2038 When inheriting the :ref:`compress_doc <ref-classes-compress_doc>`
2039 class, this variable sets the compression policy used when the 2039 class, this variable sets the compression policy used when the
2040 OpenEmbedded build system compresses man pages and info pages. By 2040 OpenEmbedded build system compresses man pages and info pages. By
@@ -2044,7 +2044,7 @@ system and gives an overview of their function and contents.
2044 For information on policies and on how to use this variable, see the 2044 For information on policies and on how to use this variable, see the
2045 comments in the ``meta/classes/compress_doc.bbclass`` file. 2045 comments in the ``meta/classes/compress_doc.bbclass`` file.
2046 2046
2047 EFI_PROVIDER 2047 :term:`EFI_PROVIDER`
2048 When building bootable images (i.e. where ``hddimg``, ``iso``, or 2048 When building bootable images (i.e. where ``hddimg``, ``iso``, or
2049 ``wic.vmdk`` is in :term:`IMAGE_FSTYPES`), the 2049 ``wic.vmdk`` is in :term:`IMAGE_FSTYPES`), the
2050 ``EFI_PROVIDER`` variable specifies the EFI bootloader to use. The 2050 ``EFI_PROVIDER`` variable specifies the EFI bootloader to use. The
@@ -2054,12 +2054,12 @@ system and gives an overview of their function and contents.
2054 :ref:`image-live <ref-classes-image-live>` classes for more 2054 :ref:`image-live <ref-classes-image-live>` classes for more
2055 information. 2055 information.
2056 2056
2057 ENABLE_BINARY_LOCALE_GENERATION 2057 :term:`ENABLE_BINARY_LOCALE_GENERATION`
2058 Variable that controls which locales for ``glibc`` are generated 2058 Variable that controls which locales for ``glibc`` are generated
2059 during the build (useful if the target device has 64Mbytes of RAM or 2059 during the build (useful if the target device has 64Mbytes of RAM or
2060 less). 2060 less).
2061 2061
2062 ERR_REPORT_DIR 2062 :term:`ERR_REPORT_DIR`
2063 When used with the :ref:`report-error <ref-classes-report-error>` 2063 When used with the :ref:`report-error <ref-classes-report-error>`
2064 class, specifies the path used for storing the debug files created by 2064 class, specifies the path used for storing the debug files created by
2065 the :ref:`error reporting 2065 the :ref:`error reporting
@@ -2075,14 +2075,14 @@ system and gives an overview of their function and contents.
2075 2075
2076 ERR_REPORT_DIR = "path" 2076 ERR_REPORT_DIR = "path"
2077 2077
2078 ERROR_QA 2078 :term:`ERROR_QA`
2079 Specifies the quality assurance checks whose failures are reported as 2079 Specifies the quality assurance checks whose failures are reported as
2080 errors by the OpenEmbedded build system. You set this variable in 2080 errors by the OpenEmbedded build system. You set this variable in
2081 your distribution configuration file. For a list of the checks you 2081 your distribution configuration file. For a list of the checks you
2082 can control with this variable, see the 2082 can control with this variable, see the
2083 ":ref:`insane.bbclass <ref-classes-insane>`" section. 2083 ":ref:`insane.bbclass <ref-classes-insane>`" section.
2084 2084
2085 EXCLUDE_FROM_SHLIBS 2085 :term:`EXCLUDE_FROM_SHLIBS`
2086 Triggers the OpenEmbedded build system's shared libraries resolver to 2086 Triggers the OpenEmbedded build system's shared libraries resolver to
2087 exclude an entire package when scanning for shared libraries. 2087 exclude an entire package when scanning for shared libraries.
2088 2088
@@ -2106,7 +2106,7 @@ system and gives an overview of their function and contents.
2106 2106
2107 EXCLUDE_FROM_SHLIBS = "1" 2107 EXCLUDE_FROM_SHLIBS = "1"
2108 2108
2109 EXCLUDE_FROM_WORLD 2109 :term:`EXCLUDE_FROM_WORLD`
2110 Directs BitBake to exclude a recipe from world builds (i.e. 2110 Directs BitBake to exclude a recipe from world builds (i.e.
2111 ``bitbake world``). During world builds, BitBake locates, parses and 2111 ``bitbake world``). During world builds, BitBake locates, parses and
2112 builds all recipes found in every layer exposed in the 2112 builds all recipes found in every layer exposed in the
@@ -2125,7 +2125,7 @@ system and gives an overview of their function and contents.
2125 only ensures that the recipe is not explicitly added to the list 2125 only ensures that the recipe is not explicitly added to the list
2126 of build targets in a world build. 2126 of build targets in a world build.
2127 2127
2128 EXTENDPE 2128 :term:`EXTENDPE`
2129 Used with file and pathnames to create a prefix for a recipe's 2129 Used with file and pathnames to create a prefix for a recipe's
2130 version based on the recipe's :term:`PE` value. If ``PE`` 2130 version based on the recipe's :term:`PE` value. If ``PE``
2131 is set and greater than zero for a recipe, ``EXTENDPE`` becomes that 2131 is set and greater than zero for a recipe, ``EXTENDPE`` becomes that
@@ -2135,7 +2135,7 @@ system and gives an overview of their function and contents.
2135 2135
2136 See the :term:`STAMP` variable for an example. 2136 See the :term:`STAMP` variable for an example.
2137 2137
2138 EXTENDPKGV 2138 :term:`EXTENDPKGV`
2139 The full package version specification as it appears on the final 2139 The full package version specification as it appears on the final
2140 packages produced by a recipe. The variable's value is normally used 2140 packages produced by a recipe. The variable's value is normally used
2141 to fix a runtime dependency to the exact same version of another 2141 to fix a runtime dependency to the exact same version of another
@@ -2147,7 +2147,7 @@ system and gives an overview of their function and contents.
2147 The dependency relationships are intended to force the package 2147 The dependency relationships are intended to force the package
2148 manager to upgrade these types of packages in lock-step. 2148 manager to upgrade these types of packages in lock-step.
2149 2149
2150 EXTERNAL_KERNEL_TOOLS 2150 :term:`EXTERNAL_KERNEL_TOOLS`
2151 When set, the ``EXTERNAL_KERNEL_TOOLS`` variable indicates that these 2151 When set, the ``EXTERNAL_KERNEL_TOOLS`` variable indicates that these
2152 tools are not in the source tree. 2152 tools are not in the source tree.
2153 2153
@@ -2158,7 +2158,7 @@ system and gives an overview of their function and contents.
2158 :ref:`kernel-yocto <ref-classes-kernel-yocto>` class in 2158 :ref:`kernel-yocto <ref-classes-kernel-yocto>` class in
2159 ``meta/classes`` to see how the variable is used. 2159 ``meta/classes`` to see how the variable is used.
2160 2160
2161 EXTERNALSRC 2161 :term:`EXTERNALSRC`
2162 When inheriting the :ref:`externalsrc <ref-classes-externalsrc>` 2162 When inheriting the :ref:`externalsrc <ref-classes-externalsrc>`
2163 class, this variable points to the source tree, which is outside of 2163 class, this variable points to the source tree, which is outside of
2164 the OpenEmbedded build system. When set, this variable sets the 2164 the OpenEmbedded build system. When set, this variable sets the
@@ -2171,7 +2171,7 @@ system and gives an overview of their function and contents.
2171 ":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`" 2171 ":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`"
2172 section in the Yocto Project Development Tasks Manual. 2172 section in the Yocto Project Development Tasks Manual.
2173 2173
2174 EXTERNALSRC_BUILD 2174 :term:`EXTERNALSRC_BUILD`
2175 When inheriting the :ref:`externalsrc <ref-classes-externalsrc>` 2175 When inheriting the :ref:`externalsrc <ref-classes-externalsrc>`
2176 class, this variable points to the directory in which the recipe's 2176 class, this variable points to the directory in which the recipe's
2177 source code is built, which is outside of the OpenEmbedded build 2177 source code is built, which is outside of the OpenEmbedded build
@@ -2185,7 +2185,7 @@ system and gives an overview of their function and contents.
2185 ":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`" 2185 ":ref:`dev-manual/dev-manual-common-tasks:building software from an external source`"
2186 section in the Yocto Project Development Tasks Manual. 2186 section in the Yocto Project Development Tasks Manual.
2187 2187
2188 EXTRA_AUTORECONF 2188 :term:`EXTRA_AUTORECONF`
2189 For recipes inheriting the :ref:`autotools <ref-classes-autotools>` 2189 For recipes inheriting the :ref:`autotools <ref-classes-autotools>`
2190 class, you can use ``EXTRA_AUTORECONF`` to specify extra options to 2190 class, you can use ``EXTRA_AUTORECONF`` to specify extra options to
2191 pass to the ``autoreconf`` command that is executed during the 2191 pass to the ``autoreconf`` command that is executed during the
@@ -2193,7 +2193,7 @@ system and gives an overview of their function and contents.
2193 2193
2194 The default value is "--exclude=autopoint". 2194 The default value is "--exclude=autopoint".
2195 2195
2196 EXTRA_IMAGE_FEATURES 2196 :term:`EXTRA_IMAGE_FEATURES`
2197 A list of additional features to include in an image. When listing 2197 A list of additional features to include in an image. When listing
2198 more than one feature, separate them with a space. 2198 more than one feature, separate them with a space.
2199 2199
@@ -2237,7 +2237,7 @@ system and gives an overview of their function and contents.
2237 variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" 2237 variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`"
2238 section in the Yocto Project Development Tasks Manual. 2238 section in the Yocto Project Development Tasks Manual.
2239 2239
2240 EXTRA_IMAGECMD 2240 :term:`EXTRA_IMAGECMD`
2241 Specifies additional options for the image creation command that has 2241 Specifies additional options for the image creation command that has
2242 been specified in :term:`IMAGE_CMD`. When setting 2242 been specified in :term:`IMAGE_CMD`. When setting
2243 this variable, use an override for the associated image type. Here is 2243 this variable, use an override for the associated image type. Here is
@@ -2246,7 +2246,7 @@ system and gives an overview of their function and contents.
2246 2246
2247 EXTRA_IMAGECMD_ext3 ?= "-i 4096" 2247 EXTRA_IMAGECMD_ext3 ?= "-i 4096"
2248 2248
2249 EXTRA_IMAGEDEPENDS 2249 :term:`EXTRA_IMAGEDEPENDS`
2250 A list of recipes to build that do not provide packages for 2250 A list of recipes to build that do not provide packages for
2251 installing into the root filesystem. 2251 installing into the root filesystem.
2252 2252
@@ -2261,7 +2261,7 @@ system and gives an overview of their function and contents.
2261 \*RDEPENDS and \*RRECOMMENDS 2261 \*RDEPENDS and \*RRECOMMENDS
2262 variables. 2262 variables.
2263 2263
2264 EXTRANATIVEPATH 2264 :term:`EXTRANATIVEPATH`
2265 A list of subdirectories of 2265 A list of subdirectories of
2266 ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}`` 2266 ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}``
2267 added to the beginning of the environment variable ``PATH``. As an 2267 added to the beginning of the environment variable ``PATH``. As an
@@ -2272,16 +2272,16 @@ system and gives an overview of their function and contents.
2272 2272
2273 EXTRANATIVEPATH = "foo bar" 2273 EXTRANATIVEPATH = "foo bar"
2274 2274
2275 EXTRA_OECMAKE 2275 :term:`EXTRA_OECMAKE`
2276 Additional `CMake <https://cmake.org/overview/>`__ options. See the 2276 Additional `CMake <https://cmake.org/overview/>`__ options. See the
2277 :ref:`cmake <ref-classes-cmake>` class for additional information. 2277 :ref:`cmake <ref-classes-cmake>` class for additional information.
2278 2278
2279 EXTRA_OECONF 2279 :term:`EXTRA_OECONF`
2280 Additional ``configure`` script options. See 2280 Additional ``configure`` script options. See
2281 :term:`PACKAGECONFIG_CONFARGS` for 2281 :term:`PACKAGECONFIG_CONFARGS` for
2282 additional information on passing configure script options. 2282 additional information on passing configure script options.
2283 2283
2284 EXTRA_OEMAKE 2284 :term:`EXTRA_OEMAKE`
2285 Additional GNU ``make`` options. 2285 Additional GNU ``make`` options.
2286 2286
2287 Because the ``EXTRA_OEMAKE`` defaults to "", you need to set the 2287 Because the ``EXTRA_OEMAKE`` defaults to "", you need to set the
@@ -2291,12 +2291,12 @@ system and gives an overview of their function and contents.
2291 :term:`PARALLEL_MAKEINST` also make use of 2291 :term:`PARALLEL_MAKEINST` also make use of
2292 ``EXTRA_OEMAKE`` to pass the required flags. 2292 ``EXTRA_OEMAKE`` to pass the required flags.
2293 2293
2294 EXTRA_OESCONS 2294 :term:`EXTRA_OESCONS`
2295 When inheriting the :ref:`scons <ref-classes-scons>` class, this 2295 When inheriting the :ref:`scons <ref-classes-scons>` class, this
2296 variable specifies additional configuration options you want to pass 2296 variable specifies additional configuration options you want to pass
2297 to the ``scons`` command line. 2297 to the ``scons`` command line.
2298 2298
2299 EXTRA_USERS_PARAMS 2299 :term:`EXTRA_USERS_PARAMS`
2300 When inheriting the :ref:`extrausers <ref-classes-extrausers>` 2300 When inheriting the :ref:`extrausers <ref-classes-extrausers>`
2301 class, this variable provides image level user and group operations. 2301 class, this variable provides image level user and group operations.
2302 This is a more global method of providing user and group 2302 This is a more global method of providing user and group
@@ -2318,7 +2318,7 @@ system and gives an overview of their function and contents.
2318 # usermod -s /bin/sh tester; \ 2318 # usermod -s /bin/sh tester; \
2319 # " 2319 # "
2320 2320
2321 FEATURE_PACKAGES 2321 :term:`FEATURE_PACKAGES`
2322 Defines one or more packages to include in an image when a specific 2322 Defines one or more packages to include in an image when a specific
2323 item is included in :term:`IMAGE_FEATURES`. 2323 item is included in :term:`IMAGE_FEATURES`.
2324 When setting the value, ``FEATURE_PACKAGES`` should have the name of 2324 When setting the value, ``FEATURE_PACKAGES`` should have the name of
@@ -2340,7 +2340,7 @@ system and gives an overview of their function and contents.
2340 variable with package groups, which are discussed elsewhere in the 2340 variable with package groups, which are discussed elsewhere in the
2341 documentation. 2341 documentation.
2342 2342
2343 FEED_DEPLOYDIR_BASE_URI 2343 :term:`FEED_DEPLOYDIR_BASE_URI`
2344 Points to the base URL of the server and location within the 2344 Points to the base URL of the server and location within the
2345 document-root that provides the metadata and packages required by 2345 document-root that provides the metadata and packages required by
2346 OPKG to support runtime package management of IPK packages. You set 2346 OPKG to support runtime package management of IPK packages. You set
@@ -2358,7 +2358,7 @@ system and gives an overview of their function and contents.
2358 a set of configuration files for you in your target that work with 2358 a set of configuration files for you in your target that work with
2359 the feed. 2359 the feed.
2360 2360
2361 FILES 2361 :term:`FILES`
2362 The list of files and directories that are placed in a package. The 2362 The list of files and directories that are placed in a package. The
2363 :term:`PACKAGES` variable lists the packages 2363 :term:`PACKAGES` variable lists the packages
2364 generated by a recipe. 2364 generated by a recipe.
@@ -2395,7 +2395,7 @@ system and gives an overview of their function and contents.
2395 the :term:`CONFFILES` variable for information on 2395 the :term:`CONFFILES` variable for information on
2396 how to identify these files to the PMS. 2396 how to identify these files to the PMS.
2397 2397
2398 FILES_SOLIBSDEV 2398 :term:`FILES_SOLIBSDEV`
2399 Defines the file specification to match 2399 Defines the file specification to match
2400 :term:`SOLIBSDEV`. In other words, 2400 :term:`SOLIBSDEV`. In other words,
2401 ``FILES_SOLIBSDEV`` defines the full path name of the development 2401 ``FILES_SOLIBSDEV`` defines the full path name of the development
@@ -2407,7 +2407,7 @@ system and gives an overview of their function and contents.
2407 2407
2408 FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}" 2408 FILES_SOLIBSDEV ?= "${base_libdir}/lib*${SOLIBSDEV} ${libdir}/lib*${SOLIBSDEV}"
2409 2409
2410 FILESEXTRAPATHS 2410 :term:`FILESEXTRAPATHS`
2411 Extends the search path the OpenEmbedded build system uses when 2411 Extends the search path the OpenEmbedded build system uses when
2412 looking for files and patches as it processes recipes and append 2412 looking for files and patches as it processes recipes and append
2413 files. The default directories BitBake uses when it processes recipes 2413 files. The default directories BitBake uses when it processes recipes
@@ -2479,7 +2479,7 @@ system and gives an overview of their function and contents.
2479 files that reside in different layers but are used for the same 2479 files that reside in different layers but are used for the same
2480 recipe to correctly extend the path. 2480 recipe to correctly extend the path.
2481 2481
2482 FILESOVERRIDES 2482 :term:`FILESOVERRIDES`
2483 A subset of :term:`OVERRIDES` used by the 2483 A subset of :term:`OVERRIDES` used by the
2484 OpenEmbedded build system for creating 2484 OpenEmbedded build system for creating
2485 :term:`FILESPATH`. The ``FILESOVERRIDES`` variable 2485 :term:`FILESPATH`. The ``FILESOVERRIDES`` variable
@@ -2503,7 +2503,7 @@ system and gives an overview of their function and contents.
2503 variable. The values match up with expected overrides and are used 2503 variable. The values match up with expected overrides and are used
2504 in an expected manner by the build system. 2504 in an expected manner by the build system.
2505 2505
2506 FILESPATH 2506 :term:`FILESPATH`
2507 The default set of directories the OpenEmbedded build system uses 2507 The default set of directories the OpenEmbedded build system uses
2508 when searching for patches and files. 2508 when searching for patches and files.
2509 2509
@@ -2562,7 +2562,7 @@ system and gives an overview of their function and contents.
2562 the Yocto Project Development Tasks Manual. See the 2562 the Yocto Project Development Tasks Manual. See the
2563 :ref:`ref-tasks-patch` task as well. 2563 :ref:`ref-tasks-patch` task as well.
2564 2564
2565 FILESYSTEM_PERMS_TABLES 2565 :term:`FILESYSTEM_PERMS_TABLES`
2566 Allows you to define your own file permissions settings table as part 2566 Allows you to define your own file permissions settings table as part
2567 of your configuration for the packaging process. For example, suppose 2567 of your configuration for the packaging process. For example, suppose
2568 you need a consistent set of custom permissions for a set of groups 2568 you need a consistent set of custom permissions for a set of groups
@@ -2585,19 +2585,19 @@ system and gives an overview of their function and contents.
2585 For guidance on how to create your own file permissions settings 2585 For guidance on how to create your own file permissions settings
2586 table file, examine the existing ``fs-perms.txt``. 2586 table file, examine the existing ``fs-perms.txt``.
2587 2587
2588 FIT_HASH_ALG 2588 :term:`FIT_HASH_ALG`
2589 Specifies the hash algorithm used in creating the FIT Image. For e.g. sha256. 2589 Specifies the hash algorithm used in creating the FIT Image. For e.g. sha256.
2590 2590
2591 FIT_SIGN_ALG 2591 :term:`FIT_SIGN_ALG`
2592 Specifies the signature algorithm used in creating the FIT Image. 2592 Specifies the signature algorithm used in creating the FIT Image.
2593 For e.g. rsa2048. 2593 For e.g. rsa2048.
2594 2594
2595 FONT_EXTRA_RDEPENDS 2595 :term:`FONT_EXTRA_RDEPENDS`
2596 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, 2596 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class,
2597 this variable specifies the runtime dependencies for font packages. 2597 this variable specifies the runtime dependencies for font packages.
2598 By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils". 2598 By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils".
2599 2599
2600 FONT_PACKAGES 2600 :term:`FONT_PACKAGES`
2601 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, 2601 When inheriting the :ref:`fontcache <ref-classes-fontcache>` class,
2602 this variable identifies packages containing font files that need to 2602 this variable identifies packages containing font files that need to
2603 be cached by Fontconfig. By default, the ``fontcache`` class assumes 2603 be cached by Fontconfig. By default, the ``fontcache`` class assumes
@@ -2605,18 +2605,18 @@ system and gives an overview of their function and contents.
2605 ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you 2605 ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you
2606 need are in a package other than that main package. 2606 need are in a package other than that main package.
2607 2607
2608 FORCE_RO_REMOVE 2608 :term:`FORCE_RO_REMOVE`
2609 Forces the removal of the packages listed in ``ROOTFS_RO_UNNEEDED`` 2609 Forces the removal of the packages listed in ``ROOTFS_RO_UNNEEDED``
2610 during the generation of the root filesystem. 2610 during the generation of the root filesystem.
2611 2611
2612 Set the variable to "1" to force the removal of these packages. 2612 Set the variable to "1" to force the removal of these packages.
2613 2613
2614 FULL_OPTIMIZATION 2614 :term:`FULL_OPTIMIZATION`
2615 The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when 2615 The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when
2616 compiling an optimized system. This variable defaults to "-O2 -pipe 2616 compiling an optimized system. This variable defaults to "-O2 -pipe
2617 ${DEBUG_FLAGS}". 2617 ${DEBUG_FLAGS}".
2618 2618
2619 GCCPIE 2619 :term:`GCCPIE`
2620 Enables Position Independent Executables (PIE) within the GNU C 2620 Enables Position Independent Executables (PIE) within the GNU C
2621 Compiler (GCC). Enabling PIE in the GCC makes Return Oriented 2621 Compiler (GCC). Enabling PIE in the GCC makes Return Oriented
2622 Programming (ROP) attacks much more difficult to execute. 2622 Programming (ROP) attacks much more difficult to execute.
@@ -2627,7 +2627,7 @@ system and gives an overview of their function and contents.
2627 2627
2628 GCCPIE ?= "--enable-default-pie" 2628 GCCPIE ?= "--enable-default-pie"
2629 2629
2630 GCCVERSION 2630 :term:`GCCVERSION`
2631 Specifies the default version of the GNU C Compiler (GCC) used for 2631 Specifies the default version of the GNU C Compiler (GCC) used for
2632 compilation. By default, ``GCCVERSION`` is set to "8.x" in the 2632 compilation. By default, ``GCCVERSION`` is set to "8.x" in the
2633 ``meta/conf/distro/include/tcmode-default.inc`` include file: 2633 ``meta/conf/distro/include/tcmode-default.inc`` include file:
@@ -2638,14 +2638,14 @@ system and gives an overview of their function and contents.
2638 You can override this value by setting it in a 2638 You can override this value by setting it in a
2639 configuration file such as the ``local.conf``. 2639 configuration file such as the ``local.conf``.
2640 2640
2641 GDB 2641 :term:`GDB`
2642 The minimal command and arguments to run the GNU Debugger. 2642 The minimal command and arguments to run the GNU Debugger.
2643 2643
2644 GITDIR 2644 :term:`GITDIR`
2645 The directory in which a local copy of a Git repository is stored 2645 The directory in which a local copy of a Git repository is stored
2646 when it is cloned. 2646 when it is cloned.
2647 2647
2648 GLIBC_GENERATE_LOCALES 2648 :term:`GLIBC_GENERATE_LOCALES`
2649 Specifies the list of GLIBC locales to generate should you not wish 2649 Specifies the list of GLIBC locales to generate should you not wish
2650 to generate all LIBC locals, which can be time consuming. 2650 to generate all LIBC locals, which can be time consuming.
2651 2651
@@ -2663,7 +2663,7 @@ system and gives an overview of their function and contents.
2663 2663
2664 GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8" 2664 GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8"
2665 2665
2666 GROUPADD_PARAM 2666 :term:`GROUPADD_PARAM`
2667 When inheriting the :ref:`useradd <ref-classes-useradd>` class, 2667 When inheriting the :ref:`useradd <ref-classes-useradd>` class,
2668 this variable specifies for a package what parameters should be 2668 this variable specifies for a package what parameters should be
2669 passed to the ``groupadd`` command if you wish to add a group to the 2669 passed to the ``groupadd`` command if you wish to add a group to the
@@ -2677,7 +2677,7 @@ system and gives an overview of their function and contents.
2677 For information on the standard Linux shell command 2677 For information on the standard Linux shell command
2678 ``groupadd``, see http://linux.die.net/man/8/groupadd. 2678 ``groupadd``, see http://linux.die.net/man/8/groupadd.
2679 2679
2680 GROUPMEMS_PARAM 2680 :term:`GROUPMEMS_PARAM`
2681 When inheriting the :ref:`useradd <ref-classes-useradd>` class, 2681 When inheriting the :ref:`useradd <ref-classes-useradd>` class,
2682 this variable specifies for a package what parameters should be 2682 this variable specifies for a package what parameters should be
2683 passed to the ``groupmems`` command if you wish to modify the members 2683 passed to the ``groupmems`` command if you wish to modify the members
@@ -2686,7 +2686,7 @@ system and gives an overview of their function and contents.
2686 For information on the standard Linux shell command ``groupmems``, 2686 For information on the standard Linux shell command ``groupmems``,
2687 see http://linux.die.net/man/8/groupmems. 2687 see http://linux.die.net/man/8/groupmems.
2688 2688
2689 GRUB_GFXSERIAL 2689 :term:`GRUB_GFXSERIAL`
2690 Configures the GNU GRand Unified Bootloader (GRUB) to have graphics 2690 Configures the GNU GRand Unified Bootloader (GRUB) to have graphics
2691 and serial in the boot menu. Set this variable to "1" in your 2691 and serial in the boot menu. Set this variable to "1" in your
2692 ``local.conf`` or distribution configuration file to enable graphics 2692 ``local.conf`` or distribution configuration file to enable graphics
@@ -2695,7 +2695,7 @@ system and gives an overview of their function and contents.
2695 See the :ref:`grub-efi <ref-classes-grub-efi>` class for more 2695 See the :ref:`grub-efi <ref-classes-grub-efi>` class for more
2696 information on how this variable is used. 2696 information on how this variable is used.
2697 2697
2698 GRUB_OPTS 2698 :term:`GRUB_OPTS`
2699 Additional options to add to the GNU GRand Unified Bootloader (GRUB) 2699 Additional options to add to the GNU GRand Unified Bootloader (GRUB)
2700 configuration. Use a semi-colon character (``;``) to separate 2700 configuration. Use a semi-colon character (``;``) to separate
2701 multiple options. 2701 multiple options.
@@ -2704,7 +2704,7 @@ system and gives an overview of their function and contents.
2704 :ref:`grub-efi <ref-classes-grub-efi>` class for more information 2704 :ref:`grub-efi <ref-classes-grub-efi>` class for more information
2705 on how this variable is used. 2705 on how this variable is used.
2706 2706
2707 GRUB_TIMEOUT 2707 :term:`GRUB_TIMEOUT`
2708 Specifies the timeout before executing the default ``LABEL`` in the 2708 Specifies the timeout before executing the default ``LABEL`` in the
2709 GNU GRand Unified Bootloader (GRUB). 2709 GNU GRand Unified Bootloader (GRUB).
2710 2710
@@ -2712,18 +2712,18 @@ system and gives an overview of their function and contents.
2712 :ref:`grub-efi <ref-classes-grub-efi>` class for more information 2712 :ref:`grub-efi <ref-classes-grub-efi>` class for more information
2713 on how this variable is used. 2713 on how this variable is used.
2714 2714
2715 GTKIMMODULES_PACKAGES 2715 :term:`GTKIMMODULES_PACKAGES`
2716 When inheriting the 2716 When inheriting the
2717 :ref:`gtk-immodules-cache <ref-classes-gtk-immodules-cache>` class, 2717 :ref:`gtk-immodules-cache <ref-classes-gtk-immodules-cache>` class,
2718 this variable specifies the packages that contain the GTK+ input 2718 this variable specifies the packages that contain the GTK+ input
2719 method modules being installed when the modules are in packages other 2719 method modules being installed when the modules are in packages other
2720 than the main package. 2720 than the main package.
2721 2721
2722 HOMEPAGE 2722 :term:`HOMEPAGE`
2723 Website where more information about the software the recipe is 2723 Website where more information about the software the recipe is
2724 building can be found. 2724 building can be found.
2725 2725
2726 HOST_ARCH 2726 :term:`HOST_ARCH`
2727 The name of the target architecture, which is normally the same as 2727 The name of the target architecture, which is normally the same as
2728 :term:`TARGET_ARCH`. The OpenEmbedded build system 2728 :term:`TARGET_ARCH`. The OpenEmbedded build system
2729 supports many architectures. Here is an example list of architectures 2729 supports many architectures. Here is an example list of architectures
@@ -2738,7 +2738,7 @@ system and gives an overview of their function and contents.
2738 - mips 2738 - mips
2739 - mipsel 2739 - mipsel
2740 2740
2741 HOST_CC_ARCH 2741 :term:`HOST_CC_ARCH`
2742 Specifies architecture-specific compiler flags that are passed to the 2742 Specifies architecture-specific compiler flags that are passed to the
2743 C compiler. 2743 C compiler.
2744 2744
@@ -2754,18 +2754,18 @@ system and gives an overview of their function and contents.
2754 - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e. 2754 - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e.
2755 ``nativesdk-``) 2755 ``nativesdk-``)
2756 2756
2757 HOST_OS 2757 :term:`HOST_OS`
2758 Specifies the name of the target operating system, which is normally 2758 Specifies the name of the target operating system, which is normally
2759 the same as the :term:`TARGET_OS`. The variable can 2759 the same as the :term:`TARGET_OS`. The variable can
2760 be set to "linux" for ``glibc``-based systems and to "linux-musl" for 2760 be set to "linux" for ``glibc``-based systems and to "linux-musl" for
2761 ``musl``. For ARM/EABI targets, there are also "linux-gnueabi" and 2761 ``musl``. For ARM/EABI targets, there are also "linux-gnueabi" and
2762 "linux-musleabi" values possible. 2762 "linux-musleabi" values possible.
2763 2763
2764 HOST_PREFIX 2764 :term:`HOST_PREFIX`
2765 Specifies the prefix for the cross-compile toolchain. ``HOST_PREFIX`` 2765 Specifies the prefix for the cross-compile toolchain. ``HOST_PREFIX``
2766 is normally the same as :term:`TARGET_PREFIX`. 2766 is normally the same as :term:`TARGET_PREFIX`.
2767 2767
2768 HOST_SYS 2768 :term:`HOST_SYS`
2769 Specifies the system, including the architecture and the operating 2769 Specifies the system, including the architecture and the operating
2770 system, for which the build is occurring in the context of the 2770 system, for which the build is occurring in the context of the
2771 current recipe. 2771 current recipe.
@@ -2787,7 +2787,7 @@ system and gives an overview of their function and contents.
2787 - Given a recipe being built for a little-endian MIPS target running 2787 - Given a recipe being built for a little-endian MIPS target running
2788 Linux, the value might be "mipsel-linux". 2788 Linux, the value might be "mipsel-linux".
2789 2789
2790 HOSTTOOLS 2790 :term:`HOSTTOOLS`
2791 A space-separated list (filter) of tools on the build host that 2791 A space-separated list (filter) of tools on the build host that
2792 should be allowed to be called from within build tasks. Using this 2792 should be allowed to be called from within build tasks. Using this
2793 filter helps reduce the possibility of host contamination. If a tool 2793 filter helps reduce the possibility of host contamination. If a tool
@@ -2798,7 +2798,7 @@ system and gives an overview of their function and contents.
2798 For additional information, see 2798 For additional information, see
2799 :term:`HOSTTOOLS_NONFATAL`. 2799 :term:`HOSTTOOLS_NONFATAL`.
2800 2800
2801 HOSTTOOLS_NONFATAL 2801 :term:`HOSTTOOLS_NONFATAL`
2802 A space-separated list (filter) of tools on the build host that 2802 A space-separated list (filter) of tools on the build host that
2803 should be allowed to be called from within build tasks. Using this 2803 should be allowed to be called from within build tasks. Using this
2804 filter helps reduce the possibility of host contamination. Unlike 2804 filter helps reduce the possibility of host contamination. Unlike
@@ -2807,11 +2807,11 @@ system and gives an overview of their function and contents.
2807 ``HOSTTOOLS_NONFATAL`` is not found on the build host. Thus, you can 2807 ``HOSTTOOLS_NONFATAL`` is not found on the build host. Thus, you can
2808 use ``HOSTTOOLS_NONFATAL`` to filter optional host tools. 2808 use ``HOSTTOOLS_NONFATAL`` to filter optional host tools.
2809 2809
2810 HOST_VENDOR 2810 :term:`HOST_VENDOR`
2811 Specifies the name of the vendor. ``HOST_VENDOR`` is normally the 2811 Specifies the name of the vendor. ``HOST_VENDOR`` is normally the
2812 same as :term:`TARGET_VENDOR`. 2812 same as :term:`TARGET_VENDOR`.
2813 2813
2814 ICECC_DISABLED 2814 :term:`ICECC_DISABLED`
2815 Disables or enables the ``icecc`` (Icecream) function. For more 2815 Disables or enables the ``icecc`` (Icecream) function. For more
2816 information on this function and best practices for using this 2816 information on this function and best practices for using this
2817 variable, see the ":ref:`icecc.bbclass <ref-classes-icecc>`" 2817 variable, see the ":ref:`icecc.bbclass <ref-classes-icecc>`"
@@ -2828,7 +2828,7 @@ system and gives an overview of their function and contents.
2828 2828
2829 ICECC_DISABLED = "" 2829 ICECC_DISABLED = ""
2830 2830
2831 ICECC_ENV_EXEC 2831 :term:`ICECC_ENV_EXEC`
2832 Points to the ``icecc-create-env`` script that you provide. This 2832 Points to the ``icecc-create-env`` script that you provide. This
2833 variable is used by the :ref:`icecc <ref-classes-icecc>` class. You 2833 variable is used by the :ref:`icecc <ref-classes-icecc>` class. You
2834 set this variable in your ``local.conf`` file. 2834 set this variable in your ``local.conf`` file.
@@ -2838,7 +2838,7 @@ system and gives an overview of their function and contents.
2838 ``icecc-create-env.bb`` recipe, which is a modified version and not 2838 ``icecc-create-env.bb`` recipe, which is a modified version and not
2839 the one that comes with ``icecc``. 2839 the one that comes with ``icecc``.
2840 2840
2841 ICECC_PARALLEL_MAKE 2841 :term:`ICECC_PARALLEL_MAKE`
2842 Extra options passed to the ``make`` command during the 2842 Extra options passed to the ``make`` command during the
2843 :ref:`ref-tasks-compile` task that specify parallel 2843 :ref:`ref-tasks-compile` task that specify parallel
2844 compilation. This variable usually takes the form of "-j x", where x 2844 compilation. This variable usually takes the form of "-j x", where x
@@ -2864,13 +2864,13 @@ system and gives an overview of their function and contents.
2864 use it (i.e. the system does not detect and assign the number of 2864 use it (i.e. the system does not detect and assign the number of
2865 cores as is done with ``PARALLEL_MAKE``). 2865 cores as is done with ``PARALLEL_MAKE``).
2866 2866
2867 ICECC_PATH 2867 :term:`ICECC_PATH`
2868 The location of the ``icecc`` binary. You can set this variable in 2868 The location of the ``icecc`` binary. You can set this variable in
2869 your ``local.conf`` file. If your ``local.conf`` file does not define 2869 your ``local.conf`` file. If your ``local.conf`` file does not define
2870 this variable, the :ref:`icecc <ref-classes-icecc>` class attempts 2870 this variable, the :ref:`icecc <ref-classes-icecc>` class attempts
2871 to define it by locating ``icecc`` using ``which``. 2871 to define it by locating ``icecc`` using ``which``.
2872 2872
2873 ICECC_USER_CLASS_BL 2873 :term:`ICECC_USER_CLASS_BL`
2874 Identifies user classes that you do not want the Icecream distributed 2874 Identifies user classes that you do not want the Icecream distributed
2875 compile support to consider. This variable is used by the 2875 compile support to consider. This variable is used by the
2876 :ref:`icecc <ref-classes-icecc>` class. You set this variable in 2876 :ref:`icecc <ref-classes-icecc>` class. You set this variable in
@@ -2880,7 +2880,7 @@ system and gives an overview of their function and contents.
2880 them from distributed compilation across remote hosts. Any classes 2880 them from distributed compilation across remote hosts. Any classes
2881 you list will be distributed and compiled locally. 2881 you list will be distributed and compiled locally.
2882 2882
2883 ICECC_USER_PACKAGE_BL 2883 :term:`ICECC_USER_PACKAGE_BL`
2884 Identifies user recipes that you do not want the Icecream distributed 2884 Identifies user recipes that you do not want the Icecream distributed
2885 compile support to consider. This variable is used by the 2885 compile support to consider. This variable is used by the
2886 :ref:`icecc <ref-classes-icecc>` class. You set this variable in 2886 :ref:`icecc <ref-classes-icecc>` class. You set this variable in
@@ -2890,7 +2890,7 @@ system and gives an overview of their function and contents.
2890 them from distributed compilation across remote hosts. Any packages 2890 them from distributed compilation across remote hosts. Any packages
2891 you list will be distributed and compiled locally. 2891 you list will be distributed and compiled locally.
2892 2892
2893 ICECC_USER_PACKAGE_WL 2893 :term:`ICECC_USER_PACKAGE_WL`
2894 Identifies user recipes that use an empty 2894 Identifies user recipes that use an empty
2895 :term:`PARALLEL_MAKE` variable that you want to 2895 :term:`PARALLEL_MAKE` variable that you want to
2896 force remote distributed compilation on using the Icecream 2896 force remote distributed compilation on using the Icecream
@@ -2898,11 +2898,11 @@ system and gives an overview of their function and contents.
2898 :ref:`icecc <ref-classes-icecc>` class. You set this variable in 2898 :ref:`icecc <ref-classes-icecc>` class. You set this variable in
2899 your ``local.conf`` file. 2899 your ``local.conf`` file.
2900 2900
2901 IMAGE_BASENAME 2901 :term:`IMAGE_BASENAME`
2902 The base name of image output files. This variable defaults to the 2902 The base name of image output files. This variable defaults to the
2903 recipe name (``${``\ :term:`PN`\ ``}``). 2903 recipe name (``${``\ :term:`PN`\ ``}``).
2904 2904
2905 IMAGE_BOOT_FILES 2905 :term:`IMAGE_BOOT_FILES`
2906 A space-separated list of files installed into the boot partition 2906 A space-separated list of files installed into the boot partition
2907 when preparing an image using the Wic tool with the 2907 when preparing an image using the Wic tool with the
2908 ``bootimg-partition`` or ``bootimg-efi`` source plugin. By default, 2908 ``bootimg-partition`` or ``bootimg-efi`` source plugin. By default,
@@ -2938,7 +2938,7 @@ system and gives an overview of their function and contents.
2938 material for Wic is located in the 2938 material for Wic is located in the
2939 ":doc:`../ref-manual/ref-kickstart`" chapter. 2939 ":doc:`../ref-manual/ref-kickstart`" chapter.
2940 2940
2941 IMAGE_CLASSES 2941 :term:`IMAGE_CLASSES`
2942 A list of classes that all images should inherit. You typically use 2942 A list of classes that all images should inherit. You typically use
2943 this variable to specify the list of classes that register the 2943 this variable to specify the list of classes that register the
2944 different types of images the OpenEmbedded build system creates. 2944 different types of images the OpenEmbedded build system creates.
@@ -2950,7 +2950,7 @@ system and gives an overview of their function and contents.
2950 For more information, see ``meta/classes/image_types.bbclass`` in the 2950 For more information, see ``meta/classes/image_types.bbclass`` in the
2951 :term:`Source Directory`. 2951 :term:`Source Directory`.
2952 2952
2953 IMAGE_CMD 2953 :term:`IMAGE_CMD`
2954 Specifies the command to create the image file for a specific image 2954 Specifies the command to create the image file for a specific image
2955 type, which corresponds to the value set set in 2955 type, which corresponds to the value set set in
2956 :term:`IMAGE_FSTYPES`, (e.g. ``ext3``, 2956 :term:`IMAGE_FSTYPES`, (e.g. ``ext3``,
@@ -2967,7 +2967,7 @@ system and gives an overview of their function and contents.
2967 variable, see the :ref:`image_types <ref-classes-image_types>` 2967 variable, see the :ref:`image_types <ref-classes-image_types>`
2968 class file, which is ``meta/classes/image_types.bbclass``. 2968 class file, which is ``meta/classes/image_types.bbclass``.
2969 2969
2970 IMAGE_DEVICE_TABLES 2970 :term:`IMAGE_DEVICE_TABLES`
2971 Specifies one or more files that contain custom device tables that 2971 Specifies one or more files that contain custom device tables that
2972 are passed to the ``makedevs`` command as part of creating an image. 2972 are passed to the ``makedevs`` command as part of creating an image.
2973 These files list basic device nodes that should be created under 2973 These files list basic device nodes that should be created under
@@ -2977,7 +2977,7 @@ system and gives an overview of their function and contents.
2977 device table files, see ``meta/files/device_table-minimal.txt`` as an 2977 device table files, see ``meta/files/device_table-minimal.txt`` as an
2978 example. 2978 example.
2979 2979
2980 IMAGE_FEATURES 2980 :term:`IMAGE_FEATURES`
2981 The primary list of features to include in an image. Typically, you 2981 The primary list of features to include in an image. Typically, you
2982 configure this variable in an image recipe. Although you can use this 2982 configure this variable in an image recipe. Although you can use this
2983 variable from your ``local.conf`` file, which is found in the 2983 variable from your ``local.conf`` file, which is found in the
@@ -2997,7 +2997,7 @@ system and gives an overview of their function and contents.
2997 variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" 2997 variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`"
2998 section in the Yocto Project Development Tasks Manual. 2998 section in the Yocto Project Development Tasks Manual.
2999 2999
3000 IMAGE_FSTYPES 3000 :term:`IMAGE_FSTYPES`
3001 Specifies the formats the OpenEmbedded build system uses during the 3001 Specifies the formats the OpenEmbedded build system uses during the
3002 build when creating the root filesystem. For example, setting 3002 build when creating the root filesystem. For example, setting
3003 ``IMAGE_FSTYPES`` as follows causes the build system to create root 3003 ``IMAGE_FSTYPES`` as follows causes the build system to create root
@@ -3020,7 +3020,7 @@ system and gives an overview of their function and contents.
3020 or ``_prepend``. You must use the ``+=`` operator to add one or 3020 or ``_prepend``. You must use the ``+=`` operator to add one or
3021 more options to the ``IMAGE_FSTYPES`` variable. 3021 more options to the ``IMAGE_FSTYPES`` variable.
3022 3022
3023 IMAGE_INSTALL 3023 :term:`IMAGE_INSTALL`
3024 Used by recipes to specify the packages to install into an image 3024 Used by recipes to specify the packages to install into an image
3025 through the :ref:`image <ref-classes-image>` class. Use the 3025 through the :ref:`image <ref-classes-image>` class. Use the
3026 ``IMAGE_INSTALL`` variable with care to avoid ordering issues. 3026 ``IMAGE_INSTALL`` variable with care to avoid ordering issues.
@@ -3070,7 +3070,7 @@ system and gives an overview of their function and contents.
3070 specific situation. In both these cases, the behavior is 3070 specific situation. In both these cases, the behavior is
3071 contrary to how most users expect the ``+=`` operator to work. 3071 contrary to how most users expect the ``+=`` operator to work.
3072 3072
3073 IMAGE_LINGUAS 3073 :term:`IMAGE_LINGUAS`
3074 Specifies the list of locales to install into the image during the 3074 Specifies the list of locales to install into the image during the
3075 root filesystem construction process. The OpenEmbedded build system 3075 root filesystem construction process. The OpenEmbedded build system
3076 automatically splits locale files, which are used for localization, 3076 automatically splits locale files, which are used for localization,
@@ -3092,7 +3092,7 @@ system and gives an overview of their function and contents.
3092 See the :term:`GLIBC_GENERATE_LOCALES` 3092 See the :term:`GLIBC_GENERATE_LOCALES`
3093 variable for information on generating GLIBC locales. 3093 variable for information on generating GLIBC locales.
3094 3094
3095 IMAGE_MANIFEST 3095 :term:`IMAGE_MANIFEST`
3096 The manifest file for the image. This file lists all the installed 3096 The manifest file for the image. This file lists all the installed
3097 packages that make up the image. The file contains package 3097 packages that make up the image. The file contains package
3098 information on a line-per-package basis as follows: 3098 information on a line-per-package basis as follows:
@@ -3112,7 +3112,7 @@ system and gives an overview of their function and contents.
3112 information on how the image is created in the ":ref:`image-generation-dev-environment`" 3112 information on how the image is created in the ":ref:`image-generation-dev-environment`"
3113 section in the Yocto Project Overview and Concepts Manual. 3113 section in the Yocto Project Overview and Concepts Manual.
3114 3114
3115 IMAGE_NAME 3115 :term:`IMAGE_NAME`
3116 The name of the output image files minus the extension. This variable 3116 The name of the output image files minus the extension. This variable
3117 is derived using the :term:`IMAGE_BASENAME`, 3117 is derived using the :term:`IMAGE_BASENAME`,
3118 :term:`MACHINE`, and :term:`DATETIME` 3118 :term:`MACHINE`, and :term:`DATETIME`
@@ -3121,7 +3121,7 @@ system and gives an overview of their function and contents.
3121 3121
3122 IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}" 3122 IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}"
3123 3123
3124 IMAGE_OVERHEAD_FACTOR 3124 :term:`IMAGE_OVERHEAD_FACTOR`
3125 Defines a multiplier that the build system applies to the initial 3125 Defines a multiplier that the build system applies to the initial
3126 image size for cases when the multiplier times the returned disk 3126 image size for cases when the multiplier times the returned disk
3127 usage value for the image is greater than the sum of 3127 usage value for the image is greater than the sum of
@@ -3150,7 +3150,7 @@ system and gives an overview of their function and contents.
3150 added to the image by using the ``IMAGE_ROOTFS_EXTRA_SPACE`` 3150 added to the image by using the ``IMAGE_ROOTFS_EXTRA_SPACE``
3151 variable. 3151 variable.
3152 3152
3153 IMAGE_PKGTYPE 3153 :term:`IMAGE_PKGTYPE`
3154 Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the 3154 Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the
3155 OpenEmbedded build system. The variable is defined appropriately by 3155 OpenEmbedded build system. The variable is defined appropriately by
3156 the :ref:`package_deb <ref-classes-package_deb>`, 3156 the :ref:`package_deb <ref-classes-package_deb>`,
@@ -3183,7 +3183,7 @@ system and gives an overview of their function and contents.
3183 format are never used as a substitute packaging format for DEB, 3183 format are never used as a substitute packaging format for DEB,
3184 RPM, and IPK formatted files for your image or SDK. 3184 RPM, and IPK formatted files for your image or SDK.
3185 3185
3186 IMAGE_POSTPROCESS_COMMAND 3186 :term:`IMAGE_POSTPROCESS_COMMAND`
3187 Specifies a list of functions to call once the OpenEmbedded build 3187 Specifies a list of functions to call once the OpenEmbedded build
3188 system creates the final image output files. You can specify 3188 system creates the final image output files. You can specify
3189 functions separated by semicolons: 3189 functions separated by semicolons:
@@ -3197,7 +3197,7 @@ system and gives an overview of their function and contents.
3197 :term:`IMAGE_ROOTFS` variable for more 3197 :term:`IMAGE_ROOTFS` variable for more
3198 information. 3198 information.
3199 3199
3200 IMAGE_PREPROCESS_COMMAND 3200 :term:`IMAGE_PREPROCESS_COMMAND`
3201 Specifies a list of functions to call before the OpenEmbedded build 3201 Specifies a list of functions to call before the OpenEmbedded build
3202 system creates the final image output files. You can specify 3202 system creates the final image output files. You can specify
3203 functions separated by semicolons: 3203 functions separated by semicolons:
@@ -3211,19 +3211,19 @@ system and gives an overview of their function and contents.
3211 :term:`IMAGE_ROOTFS` variable for more 3211 :term:`IMAGE_ROOTFS` variable for more
3212 information. 3212 information.
3213 3213
3214 IMAGE_ROOTFS 3214 :term:`IMAGE_ROOTFS`
3215 The location of the root filesystem while it is under construction 3215 The location of the root filesystem while it is under construction
3216 (i.e. during the :ref:`ref-tasks-rootfs` task). This 3216 (i.e. during the :ref:`ref-tasks-rootfs` task). This
3217 variable is not configurable. Do not change it. 3217 variable is not configurable. Do not change it.
3218 3218
3219 IMAGE_ROOTFS_ALIGNMENT 3219 :term:`IMAGE_ROOTFS_ALIGNMENT`
3220 Specifies the alignment for the output image file in Kbytes. If the 3220 Specifies the alignment for the output image file in Kbytes. If the
3221 size of the image is not a multiple of this value, then the size is 3221 size of the image is not a multiple of this value, then the size is
3222 rounded up to the nearest multiple of the value. The default value is 3222 rounded up to the nearest multiple of the value. The default value is
3223 "1". See :term:`IMAGE_ROOTFS_SIZE` for 3223 "1". See :term:`IMAGE_ROOTFS_SIZE` for
3224 additional information. 3224 additional information.
3225 3225
3226 IMAGE_ROOTFS_EXTRA_SPACE 3226 :term:`IMAGE_ROOTFS_EXTRA_SPACE`
3227 Defines additional free disk space created in the image in Kbytes. By 3227 Defines additional free disk space created in the image in Kbytes. By
3228 default, this variable is set to "0". This free disk space is added 3228 default, this variable is set to "0". This free disk space is added
3229 to the image after the build system determines the image size as 3229 to the image after the build system determines the image size as
@@ -3243,7 +3243,7 @@ system and gives an overview of their function and contents.
3243 3243
3244 IMAGE_ROOTFS_EXTRA_SPACE = "41943040" 3244 IMAGE_ROOTFS_EXTRA_SPACE = "41943040"
3245 3245
3246 IMAGE_ROOTFS_SIZE 3246 :term:`IMAGE_ROOTFS_SIZE`
3247 Defines the size in Kbytes for the generated image. The OpenEmbedded 3247 Defines the size in Kbytes for the generated image. The OpenEmbedded
3248 build system determines the final size for the generated image using 3248 build system determines the final size for the generated image using
3249 an algorithm that takes into account the initial disk space used for 3249 an algorithm that takes into account the initial disk space used for
@@ -3268,7 +3268,7 @@ system and gives an overview of their function and contents.
3268 and :term:`IMAGE_ROOTFS_EXTRA_SPACE` 3268 and :term:`IMAGE_ROOTFS_EXTRA_SPACE`
3269 variables for related information. 3269 variables for related information.
3270 3270
3271 IMAGE_TYPEDEP 3271 :term:`IMAGE_TYPEDEP`
3272 Specifies a dependency from one image type on another. Here is an 3272 Specifies a dependency from one image type on another. Here is an
3273 example from the :ref:`image-live <ref-classes-image-live>` class: 3273 example from the :ref:`image-live <ref-classes-image-live>` class:
3274 :: 3274 ::
@@ -3281,7 +3281,7 @@ system and gives an overview of their function and contents.
3281 one of the components of the live image is an ``ext3`` formatted 3281 one of the components of the live image is an ``ext3`` formatted
3282 partition containing the root filesystem. 3282 partition containing the root filesystem.
3283 3283
3284 IMAGE_TYPES 3284 :term:`IMAGE_TYPES`
3285 Specifies the complete list of supported image types by default: 3285 Specifies the complete list of supported image types by default:
3286 3286
3287 - btrfs 3287 - btrfs
@@ -3326,7 +3326,7 @@ system and gives an overview of their function and contents.
3326 For more information about these types of images, see 3326 For more information about these types of images, see
3327 ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`. 3327 ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`.
3328 3328
3329 INC_PR 3329 :term:`INC_PR`
3330 Helps define the recipe revision for recipes that share a common 3330 Helps define the recipe revision for recipes that share a common
3331 ``include`` file. You can think of this variable as part of the 3331 ``include`` file. You can think of this variable as part of the
3332 recipe revision as set from within an include file. 3332 recipe revision as set from within an include file.
@@ -3364,7 +3364,7 @@ system and gives an overview of their function and contents.
3364 lines in the example are from individual recipes and show how the 3364 lines in the example are from individual recipes and show how the
3365 ``PR`` value is set. 3365 ``PR`` value is set.
3366 3366
3367 INCOMPATIBLE_LICENSE 3367 :term:`INCOMPATIBLE_LICENSE`
3368 Specifies a space-separated list of license names (as they would 3368 Specifies a space-separated list of license names (as they would
3369 appear in :term:`LICENSE`) that should be excluded 3369 appear in :term:`LICENSE`) that should be excluded
3370 from the build. Recipes that provide no alternatives to listed 3370 from the build. Recipes that provide no alternatives to listed
@@ -3406,7 +3406,7 @@ system and gives an overview of their function and contents.
3406 COMPATIBLE_LICENSES 3406 COMPATIBLE_LICENSES
3407 , thus only allowing the latter licences to be used. 3407 , thus only allowing the latter licences to be used.
3408 3408
3409 INHERIT 3409 :term:`INHERIT`
3410 Causes the named class or classes to be inherited globally. Anonymous 3410 Causes the named class or classes to be inherited globally. Anonymous
3411 functions in the class or classes are not executed for the base 3411 functions in the class or classes are not executed for the base
3412 configuration and in each individual recipe. The OpenEmbedded build 3412 configuration and in each individual recipe. The OpenEmbedded build
@@ -3416,7 +3416,7 @@ system and gives an overview of their function and contents.
3416 :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" 3416 :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`"
3417 section in the Bitbake User Manual. 3417 section in the Bitbake User Manual.
3418 3418
3419 INHERIT_DISTRO 3419 :term:`INHERIT_DISTRO`
3420 Lists classes that will be inherited at the distribution level. It is 3420 Lists classes that will be inherited at the distribution level. It is
3421 unlikely that you want to edit this variable. 3421 unlikely that you want to edit this variable.
3422 3422
@@ -3426,7 +3426,7 @@ system and gives an overview of their function and contents.
3426 3426
3427 INHERIT_DISTRO ?= "debian devshell sstate license" 3427 INHERIT_DISTRO ?= "debian devshell sstate license"
3428 3428
3429 INHIBIT_DEFAULT_DEPS 3429 :term:`INHIBIT_DEFAULT_DEPS`
3430 Prevents the default dependencies, namely the C compiler and standard 3430 Prevents the default dependencies, namely the C compiler and standard
3431 C library (libc), from being added to :term:`DEPENDS`. 3431 C library (libc), from being added to :term:`DEPENDS`.
3432 This variable is usually used within recipes that do not require any 3432 This variable is usually used within recipes that do not require any
@@ -3435,7 +3435,7 @@ system and gives an overview of their function and contents.
3435 Set the variable to "1" to prevent the default dependencies from 3435 Set the variable to "1" to prevent the default dependencies from
3436 being added. 3436 being added.
3437 3437
3438 INHIBIT_PACKAGE_DEBUG_SPLIT 3438 :term:`INHIBIT_PACKAGE_DEBUG_SPLIT`
3439 Prevents the OpenEmbedded build system from splitting out debug 3439 Prevents the OpenEmbedded build system from splitting out debug
3440 information during packaging. By default, the build system splits out 3440 information during packaging. By default, the build system splits out
3441 debugging information during the 3441 debugging information during the
@@ -3451,7 +3451,7 @@ system and gives an overview of their function and contents.
3451 3451
3452 INHIBIT_PACKAGE_DEBUG_SPLIT = "1" 3452 INHIBIT_PACKAGE_DEBUG_SPLIT = "1"
3453 3453
3454 INHIBIT_PACKAGE_STRIP 3454 :term:`INHIBIT_PACKAGE_STRIP`
3455 If set to "1", causes the build to not strip binaries in resulting 3455 If set to "1", causes the build to not strip binaries in resulting
3456 packages and prevents the ``-dbg`` package from containing the source 3456 packages and prevents the ``-dbg`` package from containing the source
3457 files. 3457 files.
@@ -3461,7 +3461,7 @@ system and gives an overview of their function and contents.
3461 Consequently, you should not set ``INHIBIT_PACKAGE_STRIP`` when you 3461 Consequently, you should not set ``INHIBIT_PACKAGE_STRIP`` when you
3462 plan to debug in general. 3462 plan to debug in general.
3463 3463
3464 INHIBIT_SYSROOT_STRIP 3464 :term:`INHIBIT_SYSROOT_STRIP`
3465 If set to "1", causes the build to not strip binaries in the 3465 If set to "1", causes the build to not strip binaries in the
3466 resulting sysroot. 3466 resulting sysroot.
3467 3467
@@ -3485,7 +3485,7 @@ system and gives an overview of their function and contents.
3485 strippable, other files exist that are needed for the build that 3485 strippable, other files exist that are needed for the build that
3486 are not strippable. 3486 are not strippable.
3487 3487
3488 INITRAMFS_FSTYPES 3488 :term:`INITRAMFS_FSTYPES`
3489 Defines the format for the output image of an initial RAM filesystem 3489 Defines the format for the output image of an initial RAM filesystem
3490 (initramfs), which is used during boot. Supported formats are the 3490 (initramfs), which is used during boot. Supported formats are the
3491 same as those supported by the 3491 same as those supported by the
@@ -3498,7 +3498,7 @@ system and gives an overview of their function and contents.
3498 `initrd <https://en.wikipedia.org/wiki/Initrd>`__ mechanism, expects 3498 `initrd <https://en.wikipedia.org/wiki/Initrd>`__ mechanism, expects
3499 an optionally compressed cpio archive. 3499 an optionally compressed cpio archive.
3500 3500
3501 INITRAMFS_IMAGE 3501 :term:`INITRAMFS_IMAGE`
3502 Specifies the :term:`PROVIDES` name of an image 3502 Specifies the :term:`PROVIDES` name of an image
3503 recipe that is used to build an initial RAM filesystem (initramfs) 3503 recipe that is used to build an initial RAM filesystem (initramfs)
3504 image. In other words, the ``INITRAMFS_IMAGE`` variable causes an 3504 image. In other words, the ``INITRAMFS_IMAGE`` variable causes an
@@ -3539,7 +3539,7 @@ system and gives an overview of their function and contents.
3539 image, see the ":ref:`building-an-initramfs-image`" section 3539 image, see the ":ref:`building-an-initramfs-image`" section
3540 in the Yocto Project Development Tasks Manual. 3540 in the Yocto Project Development Tasks Manual.
3541 3541
3542 INITRAMFS_IMAGE_BUNDLE 3542 :term:`INITRAMFS_IMAGE_BUNDLE`
3543 Controls whether or not the image recipe specified by 3543 Controls whether or not the image recipe specified by
3544 :term:`INITRAMFS_IMAGE` is run through an 3544 :term:`INITRAMFS_IMAGE` is run through an
3545 extra pass 3545 extra pass
@@ -3589,7 +3589,7 @@ system and gives an overview of their function and contents.
3589 initramfs, see the ":ref:`building-an-initramfs-image`" section 3589 initramfs, see the ":ref:`building-an-initramfs-image`" section
3590 in the Yocto Project Development Tasks Manual. 3590 in the Yocto Project Development Tasks Manual.
3591 3591
3592 INITRAMFS_LINK_NAME 3592 :term:`INITRAMFS_LINK_NAME`
3593 The link name of the initial RAM filesystem image. This variable is 3593 The link name of the initial RAM filesystem image. This variable is
3594 set in the ``meta/classes/kernel-artifact-names.bbclass`` file as 3594 set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
3595 follows: 3595 follows:
@@ -3607,7 +3607,7 @@ system and gives an overview of their function and contents.
3607 See the :term:`MACHINE` variable for additional 3607 See the :term:`MACHINE` variable for additional
3608 information. 3608 information.
3609 3609
3610 INITRAMFS_NAME 3610 :term:`INITRAMFS_NAME`
3611 The base name of the initial RAM filesystem image. This variable is 3611 The base name of the initial RAM filesystem image. This variable is
3612 set in the ``meta/classes/kernel-artifact-names.bbclass`` file as 3612 set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
3613 follows: 3613 follows:
@@ -3621,14 +3621,14 @@ system and gives an overview of their function and contents.
3621 3621
3622 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 3622 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
3623 3623
3624 INITRD 3624 :term:`INITRD`
3625 Indicates list of filesystem images to concatenate and use as an 3625 Indicates list of filesystem images to concatenate and use as an
3626 initial RAM disk (``initrd``). 3626 initial RAM disk (``initrd``).
3627 3627
3628 The ``INITRD`` variable is an optional variable used with the 3628 The ``INITRD`` variable is an optional variable used with the
3629 :ref:`image-live <ref-classes-image-live>` class. 3629 :ref:`image-live <ref-classes-image-live>` class.
3630 3630
3631 INITRD_IMAGE 3631 :term:`INITRD_IMAGE`
3632 When building a "live" bootable image (i.e. when 3632 When building a "live" bootable image (i.e. when
3633 :term:`IMAGE_FSTYPES` contains "live"), 3633 :term:`IMAGE_FSTYPES` contains "live"),
3634 ``INITRD_IMAGE`` specifies the image recipe that should be built to 3634 ``INITRD_IMAGE`` specifies the image recipe that should be built to
@@ -3638,14 +3638,14 @@ system and gives an overview of their function and contents.
3638 See the :ref:`image-live <ref-classes-image-live>` class for more 3638 See the :ref:`image-live <ref-classes-image-live>` class for more
3639 information. 3639 information.
3640 3640
3641 INITSCRIPT_NAME 3641 :term:`INITSCRIPT_NAME`
3642 The filename of the initialization script as installed to 3642 The filename of the initialization script as installed to
3643 ``${sysconfdir}/init.d``. 3643 ``${sysconfdir}/init.d``.
3644 3644
3645 This variable is used in recipes when using ``update-rc.d.bbclass``. 3645 This variable is used in recipes when using ``update-rc.d.bbclass``.
3646 The variable is mandatory. 3646 The variable is mandatory.
3647 3647
3648 INITSCRIPT_PACKAGES 3648 :term:`INITSCRIPT_PACKAGES`
3649 A list of the packages that contain initscripts. If multiple packages 3649 A list of the packages that contain initscripts. If multiple packages
3650 are specified, you need to append the package name to the other 3650 are specified, you need to append the package name to the other
3651 ``INITSCRIPT_*`` as an override. 3651 ``INITSCRIPT_*`` as an override.
@@ -3654,7 +3654,7 @@ system and gives an overview of their function and contents.
3654 The variable is optional and defaults to the :term:`PN` 3654 The variable is optional and defaults to the :term:`PN`
3655 variable. 3655 variable.
3656 3656
3657 INITSCRIPT_PARAMS 3657 :term:`INITSCRIPT_PARAMS`
3658 Specifies the options to pass to ``update-rc.d``. Here is an example: 3658 Specifies the options to pass to ``update-rc.d``. Here is an example:
3659 :: 3659 ::
3660 3660
@@ -3671,7 +3671,7 @@ system and gives an overview of their function and contents.
3671 please see the ``update-rc.d`` manual page at 3671 please see the ``update-rc.d`` manual page at
3672 https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html 3672 https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html
3673 3673
3674 INSANE_SKIP 3674 :term:`INSANE_SKIP`
3675 Specifies the QA checks to skip for a specific package within a 3675 Specifies the QA checks to skip for a specific package within a
3676 recipe. For example, to skip the check for symbolic link ``.so`` 3676 recipe. For example, to skip the check for symbolic link ``.so``
3677 files in the main package of a recipe, add the following to the 3677 files in the main package of a recipe, add the following to the
@@ -3684,19 +3684,19 @@ system and gives an overview of their function and contents.
3684 See the ":ref:`insane.bbclass <ref-classes-insane>`" section for a 3684 See the ":ref:`insane.bbclass <ref-classes-insane>`" section for a
3685 list of the valid QA checks you can specify using this variable. 3685 list of the valid QA checks you can specify using this variable.
3686 3686
3687 INSTALL_TIMEZONE_FILE 3687 :term:`INSTALL_TIMEZONE_FILE`
3688 By default, the ``tzdata`` recipe packages an ``/etc/timezone`` file. 3688 By default, the ``tzdata`` recipe packages an ``/etc/timezone`` file.
3689 Set the ``INSTALL_TIMEZONE_FILE`` variable to "0" at the 3689 Set the ``INSTALL_TIMEZONE_FILE`` variable to "0" at the
3690 configuration level to disable this behavior. 3690 configuration level to disable this behavior.
3691 3691
3692 IPK_FEED_URIS 3692 :term:`IPK_FEED_URIS`
3693 When the IPK backend is in use and package management is enabled on 3693 When the IPK backend is in use and package management is enabled on
3694 the target, you can use this variable to set up ``opkg`` in the 3694 the target, you can use this variable to set up ``opkg`` in the
3695 target image to point to package feeds on a nominated server. Once 3695 target image to point to package feeds on a nominated server. Once
3696 the feed is established, you can perform installations or upgrades 3696 the feed is established, you can perform installations or upgrades
3697 using the package manager at runtime. 3697 using the package manager at runtime.
3698 3698
3699 KARCH 3699 :term:`KARCH`
3700 Defines the kernel architecture used when assembling the 3700 Defines the kernel architecture used when assembling the
3701 configuration. Architectures supported for this release are: 3701 configuration. Architectures supported for this release are:
3702 3702
@@ -3709,7 +3709,7 @@ system and gives an overview of their function and contents.
3709 3709
3710 You define the ``KARCH`` variable in the :ref:`kernel-dev/kernel-dev-advanced:bsp descriptions`. 3710 You define the ``KARCH`` variable in the :ref:`kernel-dev/kernel-dev-advanced:bsp descriptions`.
3711 3711
3712 KBRANCH 3712 :term:`KBRANCH`
3713 A regular expression used by the build process to explicitly identify 3713 A regular expression used by the build process to explicitly identify
3714 the kernel branch that is validated, patched, and configured during a 3714 the kernel branch that is validated, patched, and configured during a
3715 build. You must set this variable to ensure the exact kernel branch 3715 build. You must set this variable to ensure the exact kernel branch
@@ -3744,7 +3744,7 @@ system and gives an overview of their function and contents.
3744 identify the kernel branch to use when building for each supported 3744 identify the kernel branch to use when building for each supported
3745 BSP. 3745 BSP.
3746 3746
3747 KBUILD_DEFCONFIG 3747 :term:`KBUILD_DEFCONFIG`
3748 When used with the :ref:`kernel-yocto <ref-classes-kernel-yocto>` 3748 When used with the :ref:`kernel-yocto <ref-classes-kernel-yocto>`
3749 class, specifies an "in-tree" kernel configuration file for use 3749 class, specifies an "in-tree" kernel configuration file for use
3750 during a kernel build. 3750 during a kernel build.
@@ -3780,12 +3780,12 @@ system and gives an overview of their function and contents.
3780 ":ref:`kernel-dev/kernel-dev-common:using an "in-tree" \`\`defconfig\`\` file`" 3780 ":ref:`kernel-dev/kernel-dev-common:using an "in-tree" \`\`defconfig\`\` file`"
3781 section in the Yocto Project Linux Kernel Development Manual. 3781 section in the Yocto Project Linux Kernel Development Manual.
3782 3782
3783 KERNEL_ALT_IMAGETYPE 3783 :term:`KERNEL_ALT_IMAGETYPE`
3784 Specifies an alternate kernel image type for creation in addition to 3784 Specifies an alternate kernel image type for creation in addition to
3785 the kernel image type specified using the 3785 the kernel image type specified using the
3786 :term:`KERNEL_IMAGETYPE` variable. 3786 :term:`KERNEL_IMAGETYPE` variable.
3787 3787
3788 KERNEL_ARTIFACT_NAME 3788 :term:`KERNEL_ARTIFACT_NAME`
3789 Specifies the name of all of the build artifacts. You can change the 3789 Specifies the name of all of the build artifacts. You can change the
3790 name of the artifacts by changing the ``KERNEL_ARTIFACT_NAME`` 3790 name of the artifacts by changing the ``KERNEL_ARTIFACT_NAME``
3791 variable. 3791 variable.
@@ -3804,7 +3804,7 @@ system and gives an overview of their function and contents.
3804 3804
3805 The IMAGE_VERSION_SUFFIX variable is set to DATETIME. 3805 The IMAGE_VERSION_SUFFIX variable is set to DATETIME.
3806 3806
3807 KERNEL_CLASSES 3807 :term:`KERNEL_CLASSES`
3808 A list of classes defining kernel image types that the 3808 A list of classes defining kernel image types that the
3809 :ref:`kernel <ref-classes-kernel>` class should inherit. You 3809 :ref:`kernel <ref-classes-kernel>` class should inherit. You
3810 typically append this variable to enable extended image types. An 3810 typically append this variable to enable extended image types. An
@@ -3813,7 +3813,7 @@ system and gives an overview of their function and contents.
3813 custom kernel image types with the ``kernel`` class using this 3813 custom kernel image types with the ``kernel`` class using this
3814 variable. 3814 variable.
3815 3815
3816 KERNEL_DEVICETREE 3816 :term:`KERNEL_DEVICETREE`
3817 Specifies the name of the generated Linux kernel device tree (i.e. 3817 Specifies the name of the generated Linux kernel device tree (i.e.
3818 the ``.dtb``) file. 3818 the ``.dtb``) file.
3819 3819
@@ -3826,7 +3826,7 @@ system and gives an overview of their function and contents.
3826 :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must 3826 :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must
3827 be inherited. 3827 be inherited.
3828 3828
3829 KERNEL_DTB_LINK_NAME 3829 :term:`KERNEL_DTB_LINK_NAME`
3830 The link name of the kernel device tree binary (DTB). This variable 3830 The link name of the kernel device tree binary (DTB). This variable
3831 is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as 3831 is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
3832 follows: 3832 follows:
@@ -3844,7 +3844,7 @@ system and gives an overview of their function and contents.
3844 See the :term:`MACHINE` variable for additional 3844 See the :term:`MACHINE` variable for additional
3845 information. 3845 information.
3846 3846
3847 KERNEL_DTB_NAME 3847 :term:`KERNEL_DTB_NAME`
3848 The base name of the kernel device tree binary (DTB). This variable 3848 The base name of the kernel device tree binary (DTB). This variable
3849 is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as 3849 is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
3850 follows: 3850 follows:
@@ -3858,11 +3858,11 @@ system and gives an overview of their function and contents.
3858 3858
3859 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 3859 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
3860 3860
3861 KERNEL_EXTRA_ARGS 3861 :term:`KERNEL_EXTRA_ARGS`
3862 Specifies additional ``make`` command-line arguments the OpenEmbedded 3862 Specifies additional ``make`` command-line arguments the OpenEmbedded
3863 build system passes on when compiling the kernel. 3863 build system passes on when compiling the kernel.
3864 3864
3865 KERNEL_FEATURES 3865 :term:`KERNEL_FEATURES`
3866 Includes additional kernel metadata. In the OpenEmbedded build 3866 Includes additional kernel metadata. In the OpenEmbedded build
3867 system, the default Board Support Packages (BSPs) 3867 system, the default Board Support Packages (BSPs)
3868 :term:`Metadata` is provided through the 3868 :term:`Metadata` is provided through the
@@ -3889,7 +3889,7 @@ system and gives an overview of their function and contents.
3889 KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc" 3889 KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc"
3890 KERNEL_FEATURES_append_qemux86-64 = "cfg/sound.scc" 3890 KERNEL_FEATURES_append_qemux86-64 = "cfg/sound.scc"
3891 3891
3892 KERNEL_FIT_LINK_NAME 3892 :term:`KERNEL_FIT_LINK_NAME`
3893 The link name of the kernel flattened image tree (FIT) image. This 3893 The link name of the kernel flattened image tree (FIT) image. This
3894 variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` 3894 variable is set in the ``meta/classes/kernel-artifact-names.bbclass``
3895 file as follows: 3895 file as follows:
@@ -3907,7 +3907,7 @@ system and gives an overview of their function and contents.
3907 See the :term:`MACHINE` variable for additional 3907 See the :term:`MACHINE` variable for additional
3908 information. 3908 information.
3909 3909
3910 KERNEL_FIT_NAME 3910 :term:`KERNEL_FIT_NAME`
3911 The base name of the kernel flattened image tree (FIT) image. This 3911 The base name of the kernel flattened image tree (FIT) image. This
3912 variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` 3912 variable is set in the ``meta/classes/kernel-artifact-names.bbclass``
3913 file as follows: 3913 file as follows:
@@ -3921,7 +3921,7 @@ system and gives an overview of their function and contents.
3921 3921
3922 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 3922 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
3923 3923
3924 KERNEL_IMAGE_LINK_NAME 3924 :term:`KERNEL_IMAGE_LINK_NAME`
3925 The link name for the kernel image. This variable is set in the 3925 The link name for the kernel image. This variable is set in the
3926 ``meta/classes/kernel-artifact-names.bbclass`` file as follows: 3926 ``meta/classes/kernel-artifact-names.bbclass`` file as follows:
3927 :: 3927 ::
@@ -3938,7 +3938,7 @@ system and gives an overview of their function and contents.
3938 See the :term:`MACHINE` variable for additional 3938 See the :term:`MACHINE` variable for additional
3939 information. 3939 information.
3940 3940
3941 KERNEL_IMAGE_MAXSIZE 3941 :term:`KERNEL_IMAGE_MAXSIZE`
3942 Specifies the maximum size of the kernel image file in kilobytes. If 3942 Specifies the maximum size of the kernel image file in kilobytes. If
3943 ``KERNEL_IMAGE_MAXSIZE`` is set, the size of the kernel image file is 3943 ``KERNEL_IMAGE_MAXSIZE`` is set, the size of the kernel image file is
3944 checked against the set value during the 3944 checked against the set value during the
@@ -3951,7 +3951,7 @@ system and gives an overview of their function and contents.
3951 By default, this variable is not set, which means the size of the 3951 By default, this variable is not set, which means the size of the
3952 kernel image is not checked. 3952 kernel image is not checked.
3953 3953
3954 KERNEL_IMAGE_NAME 3954 :term:`KERNEL_IMAGE_NAME`
3955 The base name of the kernel image. This variable is set in the 3955 The base name of the kernel image. This variable is set in the
3956 ``meta/classes/kernel-artifact-names.bbclass`` file as follows: 3956 ``meta/classes/kernel-artifact-names.bbclass`` file as follows:
3957 :: 3957 ::
@@ -3965,7 +3965,7 @@ system and gives an overview of their function and contents.
3965 3965
3966 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 3966 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
3967 3967
3968 KERNEL_IMAGETYPE 3968 :term:`KERNEL_IMAGETYPE`
3969 The type of kernel to build for a device, usually set by the machine 3969 The type of kernel to build for a device, usually set by the machine
3970 configuration files and defaults to "zImage". This variable is used 3970 configuration files and defaults to "zImage". This variable is used
3971 when building the kernel and is passed to ``make`` as the target to 3971 when building the kernel and is passed to ``make`` as the target to
@@ -3974,7 +3974,7 @@ system and gives an overview of their function and contents.
3974 If you want to build an alternate kernel image type, use the 3974 If you want to build an alternate kernel image type, use the
3975 :term:`KERNEL_ALT_IMAGETYPE` variable. 3975 :term:`KERNEL_ALT_IMAGETYPE` variable.
3976 3976
3977 KERNEL_MODULE_AUTOLOAD 3977 :term:`KERNEL_MODULE_AUTOLOAD`
3978 Lists kernel modules that need to be auto-loaded during boot. 3978 Lists kernel modules that need to be auto-loaded during boot.
3979 3979
3980 .. note:: 3980 .. note::
@@ -4006,14 +4006,14 @@ system and gives an overview of their function and contents.
4006 For information on how to populate the ``modname.conf`` file with 4006 For information on how to populate the ``modname.conf`` file with
4007 ``modprobe.d`` syntax lines, see the :term:`KERNEL_MODULE_PROBECONF` variable. 4007 ``modprobe.d`` syntax lines, see the :term:`KERNEL_MODULE_PROBECONF` variable.
4008 4008
4009 KERNEL_MODULE_PROBECONF 4009 :term:`KERNEL_MODULE_PROBECONF`
4010 Provides a list of modules for which the OpenEmbedded build system 4010 Provides a list of modules for which the OpenEmbedded build system
4011 expects to find ``module_conf_``\ modname values that specify 4011 expects to find ``module_conf_``\ modname values that specify
4012 configuration for each of the modules. For information on how to 4012 configuration for each of the modules. For information on how to
4013 provide those module configurations, see the 4013 provide those module configurations, see the
4014 :term:`module_conf_* <module_conf>` variable. 4014 :term:`module_conf_* <module_conf>` variable.
4015 4015
4016 KERNEL_PATH 4016 :term:`KERNEL_PATH`
4017 The location of the kernel sources. This variable is set to the value 4017 The location of the kernel sources. This variable is set to the value
4018 of the :term:`STAGING_KERNEL_DIR` within 4018 of the :term:`STAGING_KERNEL_DIR` within
4019 the :ref:`module <ref-classes-module>` class. For information on 4019 the :ref:`module <ref-classes-module>` class. For information on
@@ -4027,7 +4027,7 @@ system and gives an overview of their function and contents.
4027 the ``KERNEL_PATH`` variable. Both variables are common variables 4027 the ``KERNEL_PATH`` variable. Both variables are common variables
4028 used by external Makefiles to point to the kernel source directory. 4028 used by external Makefiles to point to the kernel source directory.
4029 4029
4030 KERNEL_SRC 4030 :term:`KERNEL_SRC`
4031 The location of the kernel sources. This variable is set to the value 4031 The location of the kernel sources. This variable is set to the value
4032 of the :term:`STAGING_KERNEL_DIR` within 4032 of the :term:`STAGING_KERNEL_DIR` within
4033 the :ref:`module <ref-classes-module>` class. For information on 4033 the :ref:`module <ref-classes-module>` class. For information on
@@ -4041,14 +4041,14 @@ system and gives an overview of their function and contents.
4041 to the ``KERNEL_SRC`` variable. Both variables are common variables 4041 to the ``KERNEL_SRC`` variable. Both variables are common variables
4042 used by external Makefiles to point to the kernel source directory. 4042 used by external Makefiles to point to the kernel source directory.
4043 4043
4044 KERNEL_VERSION 4044 :term:`KERNEL_VERSION`
4045 Specifies the version of the kernel as extracted from ``version.h`` 4045 Specifies the version of the kernel as extracted from ``version.h``
4046 or ``utsrelease.h`` within the kernel sources. Effects of setting 4046 or ``utsrelease.h`` within the kernel sources. Effects of setting
4047 this variable do not take affect until the kernel has been 4047 this variable do not take affect until the kernel has been
4048 configured. Consequently, attempting to refer to this variable in 4048 configured. Consequently, attempting to refer to this variable in
4049 contexts prior to configuration will not work. 4049 contexts prior to configuration will not work.
4050 4050
4051 KERNELDEPMODDEPEND 4051 :term:`KERNELDEPMODDEPEND`
4052 Specifies whether the data referenced through 4052 Specifies whether the data referenced through
4053 :term:`PKGDATA_DIR` is needed or not. The 4053 :term:`PKGDATA_DIR` is needed or not. The
4054 ``KERNELDEPMODDEPEND`` does not control whether or not that data 4054 ``KERNELDEPMODDEPEND`` does not control whether or not that data
@@ -4057,7 +4057,7 @@ system and gives an overview of their function and contents.
4057 ``initramfs`` recipe. Setting the variable there when the data is not 4057 ``initramfs`` recipe. Setting the variable there when the data is not
4058 needed avoids a potential dependency loop. 4058 needed avoids a potential dependency loop.
4059 4059
4060 KFEATURE_DESCRIPTION 4060 :term:`KFEATURE_DESCRIPTION`
4061 Provides a short description of a configuration fragment. You use 4061 Provides a short description of a configuration fragment. You use
4062 this variable in the ``.scc`` file that describes a configuration 4062 this variable in the ``.scc`` file that describes a configuration
4063 fragment file. Here is the variable used in a file named ``smp.scc`` 4063 fragment file. Here is the variable used in a file named ``smp.scc``
@@ -4066,7 +4066,7 @@ system and gives an overview of their function and contents.
4066 4066
4067 define KFEATURE_DESCRIPTION "Enable SMP" 4067 define KFEATURE_DESCRIPTION "Enable SMP"
4068 4068
4069 KMACHINE 4069 :term:`KMACHINE`
4070 The machine as known by the kernel. Sometimes the machine name used 4070 The machine as known by the kernel. Sometimes the machine name used
4071 by the kernel does not match the machine name used by the 4071 by the kernel does not match the machine name used by the
4072 OpenEmbedded build system. For example, the machine name that the 4072 OpenEmbedded build system. For example, the machine name that the
@@ -4094,7 +4094,7 @@ system and gives an overview of their function and contents.
4094 However, the OpenEmbedded build system understands the machine as 4094 However, the OpenEmbedded build system understands the machine as
4095 "core2-32-intel-common". 4095 "core2-32-intel-common".
4096 4096
4097 KTYPE 4097 :term:`KTYPE`
4098 Defines the kernel type to be used in assembling the configuration. 4098 Defines the kernel type to be used in assembling the configuration.
4099 The linux-yocto recipes define "standard", "tiny", and "preempt-rt" 4099 The linux-yocto recipes define "standard", "tiny", and "preempt-rt"
4100 kernel types. See the ":ref:`kernel-dev/kernel-dev-advanced:kernel types`" 4100 kernel types. See the ":ref:`kernel-dev/kernel-dev-advanced:kernel types`"
@@ -4108,13 +4108,13 @@ system and gives an overview of their function and contents.
4108 :term:`LINUX_KERNEL_TYPE` value used by the 4108 :term:`LINUX_KERNEL_TYPE` value used by the
4109 kernel recipe. 4109 kernel recipe.
4110 4110
4111 LABELS 4111 :term:`LABELS`
4112 Provides a list of targets for automatic configuration. 4112 Provides a list of targets for automatic configuration.
4113 4113
4114 See the :ref:`grub-efi <ref-classes-grub-efi>` class for more 4114 See the :ref:`grub-efi <ref-classes-grub-efi>` class for more
4115 information on how this variable is used. 4115 information on how this variable is used.
4116 4116
4117 LAYERDEPENDS 4117 :term:`LAYERDEPENDS`
4118 Lists the layers, separated by spaces, on which this recipe depends. 4118 Lists the layers, separated by spaces, on which this recipe depends.
4119 Optionally, you can specify a specific layer version for a dependency 4119 Optionally, you can specify a specific layer version for a dependency
4120 by adding it to the end of the layer name. Here is an example: 4120 by adding it to the end of the layer name. Here is an example:
@@ -4131,13 +4131,13 @@ system and gives an overview of their function and contents.
4131 the ``conf/layer.conf`` file and must be suffixed with the name of 4131 the ``conf/layer.conf`` file and must be suffixed with the name of
4132 the specific layer (e.g. ``LAYERDEPENDS_mylayer``). 4132 the specific layer (e.g. ``LAYERDEPENDS_mylayer``).
4133 4133
4134 LAYERDIR 4134 :term:`LAYERDIR`
4135 When used inside the ``layer.conf`` configuration file, this variable 4135 When used inside the ``layer.conf`` configuration file, this variable
4136 provides the path of the current layer. This variable is not 4136 provides the path of the current layer. This variable is not
4137 available outside of ``layer.conf`` and references are expanded 4137 available outside of ``layer.conf`` and references are expanded
4138 immediately when parsing of the file completes. 4138 immediately when parsing of the file completes.
4139 4139
4140 LAYERRECOMMENDS 4140 :term:`LAYERRECOMMENDS`
4141 Lists the layers, separated by spaces, recommended for use with this 4141 Lists the layers, separated by spaces, recommended for use with this
4142 layer. 4142 layer.
4143 4143
@@ -4155,7 +4155,7 @@ system and gives an overview of their function and contents.
4155 suffixed with the name of the specific layer (e.g. 4155 suffixed with the name of the specific layer (e.g.
4156 ``LAYERRECOMMENDS_mylayer``). 4156 ``LAYERRECOMMENDS_mylayer``).
4157 4157
4158 LAYERSERIES_COMPAT 4158 :term:`LAYERSERIES_COMPAT`
4159 Lists the versions of the :term:`OpenEmbedded-Core (OE-Core)` for which 4159 Lists the versions of the :term:`OpenEmbedded-Core (OE-Core)` for which
4160 a layer is compatible. Using the ``LAYERSERIES_COMPAT`` variable 4160 a layer is compatible. Using the ``LAYERSERIES_COMPAT`` variable
4161 allows the layer maintainer to indicate which combinations of the 4161 allows the layer maintainer to indicate which combinations of the
@@ -4184,7 +4184,7 @@ system and gives an overview of their function and contents.
4184 See the ":ref:`dev-manual/dev-manual-common-tasks:creating your own layer`" 4184 See the ":ref:`dev-manual/dev-manual-common-tasks:creating your own layer`"
4185 section in the Yocto Project Development Tasks Manual. 4185 section in the Yocto Project Development Tasks Manual.
4186 4186
4187 LAYERVERSION 4187 :term:`LAYERVERSION`
4188 Optionally specifies the version of a layer as a single number. You 4188 Optionally specifies the version of a layer as a single number. You
4189 can use this within :term:`LAYERDEPENDS` for 4189 can use this within :term:`LAYERDEPENDS` for
4190 another layer in order to depend on a specific version of the layer. 4190 another layer in order to depend on a specific version of the layer.
@@ -4192,10 +4192,10 @@ system and gives an overview of their function and contents.
4192 suffixed with the name of the specific layer (e.g. 4192 suffixed with the name of the specific layer (e.g.
4193 ``LAYERVERSION_mylayer``). 4193 ``LAYERVERSION_mylayer``).
4194 4194
4195 LD 4195 :term:`LD`
4196 The minimal command and arguments used to run the linker. 4196 The minimal command and arguments used to run the linker.
4197 4197
4198 LDFLAGS 4198 :term:`LDFLAGS`
4199 Specifies the flags to pass to the linker. This variable is exported 4199 Specifies the flags to pass to the linker. This variable is exported
4200 to an environment variable and thus made visible to the software 4200 to an environment variable and thus made visible to the software
4201 being built during the compilation step. 4201 being built during the compilation step.
@@ -4212,14 +4212,14 @@ system and gives an overview of their function and contents.
4212 - :term:`BUILDSDK_LDFLAGS` when building for 4212 - :term:`BUILDSDK_LDFLAGS` when building for
4213 an SDK (i.e. ``nativesdk-``) 4213 an SDK (i.e. ``nativesdk-``)
4214 4214
4215 LEAD_SONAME 4215 :term:`LEAD_SONAME`
4216 Specifies the lead (or primary) compiled library file (i.e. ``.so``) 4216 Specifies the lead (or primary) compiled library file (i.e. ``.so``)
4217 that the :ref:`debian <ref-classes-debian>` class applies its 4217 that the :ref:`debian <ref-classes-debian>` class applies its
4218 naming policy to given a recipe that packages multiple libraries. 4218 naming policy to given a recipe that packages multiple libraries.
4219 4219
4220 This variable works in conjunction with the ``debian`` class. 4220 This variable works in conjunction with the ``debian`` class.
4221 4221
4222 LIC_FILES_CHKSUM 4222 :term:`LIC_FILES_CHKSUM`
4223 Checksums of the license text in the recipe source code. 4223 Checksums of the license text in the recipe source code.
4224 4224
4225 This variable tracks changes in license text of the source code 4225 This variable tracks changes in license text of the source code
@@ -4233,7 +4233,7 @@ system and gives an overview of their function and contents.
4233 For more information, see the ":ref:`usingpoky-configuring-lic_files_chksum`" 4233 For more information, see the ":ref:`usingpoky-configuring-lic_files_chksum`"
4234 section in the Yocto Project Development Tasks Manual. 4234 section in the Yocto Project Development Tasks Manual.
4235 4235
4236 LICENSE 4236 :term:`LICENSE`
4237 The list of source licenses for the recipe. Follow these rules: 4237 The list of source licenses for the recipe. Follow these rules:
4238 4238
4239 - Do not use spaces within individual license names. 4239 - Do not use spaces within individual license names.
@@ -4276,7 +4276,7 @@ system and gives an overview of their function and contents.
4276 LICENSE_${PN} = "GPLv2" 4276 LICENSE_${PN} = "GPLv2"
4277 LICENSE_${PN}-doc = "GFDL-1.2" 4277 LICENSE_${PN}-doc = "GFDL-1.2"
4278 4278
4279 LICENSE_CREATE_PACKAGE 4279 :term:`LICENSE_CREATE_PACKAGE`
4280 Setting ``LICENSE_CREATE_PACKAGE`` to "1" causes the OpenEmbedded 4280 Setting ``LICENSE_CREATE_PACKAGE`` to "1" causes the OpenEmbedded
4281 build system to create an extra package (i.e. 4281 build system to create an extra package (i.e.
4282 ``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add 4282 ``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add
@@ -4299,7 +4299,7 @@ system and gives an overview of their function and contents.
4299 ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" 4299 ":ref:`dev-manual/dev-manual-common-tasks:providing license text`"
4300 section in the Yocto Project Development Tasks Manual. 4300 section in the Yocto Project Development Tasks Manual.
4301 4301
4302 LICENSE_FLAGS 4302 :term:`LICENSE_FLAGS`
4303 Specifies additional flags for a recipe you must whitelist through 4303 Specifies additional flags for a recipe you must whitelist through
4304 :term:`LICENSE_FLAGS_WHITELIST` in 4304 :term:`LICENSE_FLAGS_WHITELIST` in
4305 order to allow the recipe to be built. When providing multiple flags, 4305 order to allow the recipe to be built. When providing multiple flags,
@@ -4312,7 +4312,7 @@ system and gives an overview of their function and contents.
4312 ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" 4312 ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`"
4313 section in the Yocto Project Development Tasks Manual. 4313 section in the Yocto Project Development Tasks Manual.
4314 4314
4315 LICENSE_FLAGS_WHITELIST 4315 :term:`LICENSE_FLAGS_WHITELIST`
4316 Lists license flags that when specified in 4316 Lists license flags that when specified in
4317 :term:`LICENSE_FLAGS` within a recipe should not 4317 :term:`LICENSE_FLAGS` within a recipe should not
4318 prevent that recipe from being built. This practice is otherwise 4318 prevent that recipe from being built. This practice is otherwise
@@ -4320,7 +4320,7 @@ system and gives an overview of their function and contents.
4320 ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" 4320 ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`"
4321 section in the Yocto Project Development Tasks Manual. 4321 section in the Yocto Project Development Tasks Manual.
4322 4322
4323 LICENSE_PATH 4323 :term:`LICENSE_PATH`
4324 Path to additional licenses used during the build. By default, the 4324 Path to additional licenses used during the build. By default, the
4325 OpenEmbedded build system uses ``COMMON_LICENSE_DIR`` to define the 4325 OpenEmbedded build system uses ``COMMON_LICENSE_DIR`` to define the
4326 directory that holds common license text used during the build. The 4326 directory that holds common license text used during the build. The
@@ -4330,7 +4330,7 @@ system and gives an overview of their function and contents.
4330 4330
4331 LICENSE_PATH += "path-to-additional-common-licenses" 4331 LICENSE_PATH += "path-to-additional-common-licenses"
4332 4332
4333 LINUX_KERNEL_TYPE 4333 :term:`LINUX_KERNEL_TYPE`
4334 Defines the kernel type to be used in assembling the configuration. 4334 Defines the kernel type to be used in assembling the configuration.
4335 The linux-yocto recipes define "standard", "tiny", and "preempt-rt" 4335 The linux-yocto recipes define "standard", "tiny", and "preempt-rt"
4336 kernel types. See the ":ref:`kernel-dev/kernel-dev-advanced:kernel types`" 4336 kernel types. See the ":ref:`kernel-dev/kernel-dev-advanced:kernel types`"
@@ -4345,7 +4345,7 @@ system and gives an overview of their function and contents.
4345 kernel :term:`Metadata` with which to build out the sources 4345 kernel :term:`Metadata` with which to build out the sources
4346 and configuration. 4346 and configuration.
4347 4347
4348 LINUX_VERSION 4348 :term:`LINUX_VERSION`
4349 The Linux version from ``kernel.org`` on which the Linux kernel image 4349 The Linux version from ``kernel.org`` on which the Linux kernel image
4350 being built using the OpenEmbedded build system is based. You define 4350 being built using the OpenEmbedded build system is based. You define
4351 this variable in the kernel recipe. For example, the 4351 this variable in the kernel recipe. For example, the
@@ -4361,7 +4361,7 @@ system and gives an overview of their function and contents.
4361 4361
4362 PV = "${LINUX_VERSION}+git${SRCPV}" 4362 PV = "${LINUX_VERSION}+git${SRCPV}"
4363 4363
4364 LINUX_VERSION_EXTENSION 4364 :term:`LINUX_VERSION_EXTENSION`
4365 A string extension compiled into the version string of the Linux 4365 A string extension compiled into the version string of the Linux
4366 kernel built with the OpenEmbedded build system. You define this 4366 kernel built with the OpenEmbedded build system. You define this
4367 variable in the kernel recipe. For example, the linux-yocto kernel 4367 variable in the kernel recipe. For example, the linux-yocto kernel
@@ -4379,14 +4379,14 @@ system and gives an overview of their function and contents.
4379 $ uname -r 4379 $ uname -r
4380 3.7.0-rc8-custom 4380 3.7.0-rc8-custom
4381 4381
4382 LOG_DIR 4382 :term:`LOG_DIR`
4383 Specifies the directory to which the OpenEmbedded build system writes 4383 Specifies the directory to which the OpenEmbedded build system writes
4384 overall log files. The default directory is ``${TMPDIR}/log``. 4384 overall log files. The default directory is ``${TMPDIR}/log``.
4385 4385
4386 For the directory containing logs specific to each task, see the 4386 For the directory containing logs specific to each task, see the
4387 :term:`T` variable. 4387 :term:`T` variable.
4388 4388
4389 MACHINE 4389 :term:`MACHINE`
4390 Specifies the target device for which the image is built. You define 4390 Specifies the target device for which the image is built. You define
4391 ``MACHINE`` in the ``local.conf`` file found in the 4391 ``MACHINE`` in the ``local.conf`` file found in the
4392 :term:`Build Directory`. By default, ``MACHINE`` is set to 4392 :term:`Build Directory`. By default, ``MACHINE`` is set to
@@ -4429,13 +4429,13 @@ system and gives an overview of their function and contents.
4429 MACHINE 4429 MACHINE
4430 . 4430 .
4431 4431
4432 MACHINE_ARCH 4432 :term:`MACHINE_ARCH`
4433 Specifies the name of the machine-specific architecture. This 4433 Specifies the name of the machine-specific architecture. This
4434 variable is set automatically from :term:`MACHINE` or 4434 variable is set automatically from :term:`MACHINE` or
4435 :term:`TUNE_PKGARCH`. You should not hand-edit 4435 :term:`TUNE_PKGARCH`. You should not hand-edit
4436 the ``MACHINE_ARCH`` variable. 4436 the ``MACHINE_ARCH`` variable.
4437 4437
4438 MACHINE_ESSENTIAL_EXTRA_RDEPENDS 4438 :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS`
4439 A list of required machine-specific packages to install as part of 4439 A list of required machine-specific packages to install as part of
4440 the image being built. The build process depends on these packages 4440 the image being built. The build process depends on these packages
4441 being present. Furthermore, because this is a "machine-essential" 4441 being present. Furthermore, because this is a "machine-essential"
@@ -4458,7 +4458,7 @@ system and gives an overview of their function and contents.
4458 4458
4459 MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init" 4459 MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init"
4460 4460
4461 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS 4461 :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS`
4462 A list of recommended machine-specific packages to install as part of 4462 A list of recommended machine-specific packages to install as part of
4463 the image being built. The build process does not depend on these 4463 the image being built. The build process does not depend on these
4464 packages being present. However, because this is a 4464 packages being present. However, because this is a
@@ -4503,7 +4503,7 @@ system and gives an overview of their function and contents.
4503 Some examples of these machine essentials are flash, screen, 4503 Some examples of these machine essentials are flash, screen,
4504 keyboard, mouse, or touchscreen drivers (depending on the machine). 4504 keyboard, mouse, or touchscreen drivers (depending on the machine).
4505 4505
4506 MACHINE_EXTRA_RDEPENDS 4506 :term:`MACHINE_EXTRA_RDEPENDS`
4507 A list of machine-specific packages to install as part of the image 4507 A list of machine-specific packages to install as part of the image
4508 being built that are not essential for the machine to boot. However, 4508 being built that are not essential for the machine to boot. However,
4509 the build process for more fully-featured images depends on the 4509 the build process for more fully-featured images depends on the
@@ -4530,7 +4530,7 @@ system and gives an overview of their function and contents.
4530 4530
4531 MACHINE_EXTRA_RDEPENDS += "wifidriver-firmware" 4531 MACHINE_EXTRA_RDEPENDS += "wifidriver-firmware"
4532 4532
4533 MACHINE_EXTRA_RRECOMMENDS 4533 :term:`MACHINE_EXTRA_RRECOMMENDS`
4534 A list of machine-specific packages to install as part of the image 4534 A list of machine-specific packages to install as part of the image
4535 being built that are not essential for booting the machine. The image 4535 being built that are not essential for booting the machine. The image
4536 being built has no build dependency on this list of packages. 4536 being built has no build dependency on this list of packages.
@@ -4557,7 +4557,7 @@ system and gives an overview of their function and contents.
4557 4557
4558 MACHINE_EXTRA_RRECOMMENDS += "kernel-module-examplewifi" 4558 MACHINE_EXTRA_RRECOMMENDS += "kernel-module-examplewifi"
4559 4559
4560 MACHINE_FEATURES 4560 :term:`MACHINE_FEATURES`
4561 Specifies the list of hardware features the 4561 Specifies the list of hardware features the
4562 :term:`MACHINE` is capable of supporting. For related 4562 :term:`MACHINE` is capable of supporting. For related
4563 information on enabling features, see the 4563 information on enabling features, see the
@@ -4569,7 +4569,7 @@ system and gives an overview of their function and contents.
4569 shipped, see the "`Machine Features <#ref-features-machine>`__" 4569 shipped, see the "`Machine Features <#ref-features-machine>`__"
4570 section. 4570 section.
4571 4571
4572 MACHINE_FEATURES_BACKFILL 4572 :term:`MACHINE_FEATURES_BACKFILL`
4573 Features to be added to ``MACHINE_FEATURES`` if not also present in 4573 Features to be added to ``MACHINE_FEATURES`` if not also present in
4574 ``MACHINE_FEATURES_BACKFILL_CONSIDERED``. 4574 ``MACHINE_FEATURES_BACKFILL_CONSIDERED``.
4575 4575
@@ -4580,13 +4580,13 @@ system and gives an overview of their function and contents.
4580 Backfilling <#ref-features-backfill>`__" section for more 4580 Backfilling <#ref-features-backfill>`__" section for more
4581 information. 4581 information.
4582 4582
4583 MACHINE_FEATURES_BACKFILL_CONSIDERED 4583 :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`
4584 Features from ``MACHINE_FEATURES_BACKFILL`` that should not be 4584 Features from ``MACHINE_FEATURES_BACKFILL`` that should not be
4585 backfilled (i.e. added to ``MACHINE_FEATURES``) during the build. See 4585 backfilled (i.e. added to ``MACHINE_FEATURES``) during the build. See
4586 the "`Feature Backfilling <#ref-features-backfill>`__" section for 4586 the "`Feature Backfilling <#ref-features-backfill>`__" section for
4587 more information. 4587 more information.
4588 4588
4589 MACHINEOVERRIDES 4589 :term:`MACHINEOVERRIDES`
4590 A colon-separated list of overrides that apply to the current 4590 A colon-separated list of overrides that apply to the current
4591 machine. By default, this list includes the value of 4591 machine. By default, this list includes the value of
4592 :term:`MACHINE`. 4592 :term:`MACHINE`.
@@ -4614,10 +4614,10 @@ system and gives an overview of their function and contents.
4614 ``MACHINEOVERRIDES`` is simply that it is included in the default 4614 ``MACHINEOVERRIDES`` is simply that it is included in the default
4615 value of :term:`OVERRIDES`. 4615 value of :term:`OVERRIDES`.
4616 4616
4617 MAINTAINER 4617 :term:`MAINTAINER`
4618 The email address of the distribution maintainer. 4618 The email address of the distribution maintainer.
4619 4619
4620 MIRRORS 4620 :term:`MIRRORS`
4621 Specifies additional paths from which the OpenEmbedded build system 4621 Specifies additional paths from which the OpenEmbedded build system
4622 gets source code. When the build system searches for source code, it 4622 gets source code. When the build system searches for source code, it
4623 first tries the local download directory. If that location fails, the 4623 first tries the local download directory. If that location fails, the
@@ -4629,7 +4629,7 @@ system and gives an overview of their function and contents.
4629 the default value for ``MIRRORS`` is defined in the 4629 the default value for ``MIRRORS`` is defined in the
4630 ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. 4630 ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository.
4631 4631
4632 MLPREFIX 4632 :term:`MLPREFIX`
4633 Specifies a prefix has been added to :term:`PN` to create a 4633 Specifies a prefix has been added to :term:`PN` to create a
4634 special version of a recipe or package (i.e. a Multilib version). The 4634 special version of a recipe or package (i.e. a Multilib version). The
4635 variable is used in places where the prefix needs to be added to or 4635 variable is used in places where the prefix needs to be added to or
@@ -4716,12 +4716,12 @@ system and gives an overview of their function and contents.
4716 For information on how to specify kernel modules to auto-load on 4716 For information on how to specify kernel modules to auto-load on
4717 boot, see the :term:`KERNEL_MODULE_AUTOLOAD` variable. 4717 boot, see the :term:`KERNEL_MODULE_AUTOLOAD` variable.
4718 4718
4719 MODULE_TARBALL_DEPLOY 4719 :term:`MODULE_TARBALL_DEPLOY`
4720 Controls creation of the ``modules-*.tgz`` file. Set this variable to 4720 Controls creation of the ``modules-*.tgz`` file. Set this variable to
4721 "0" to disable creation of this file, which contains all of the 4721 "0" to disable creation of this file, which contains all of the
4722 kernel modules resulting from a kernel build. 4722 kernel modules resulting from a kernel build.
4723 4723
4724 MODULE_TARBALL_LINK_NAME 4724 :term:`MODULE_TARBALL_LINK_NAME`
4725 The link name of the kernel module tarball. This variable is set in 4725 The link name of the kernel module tarball. This variable is set in
4726 the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: 4726 the ``meta/classes/kernel-artifact-names.bbclass`` file as follows:
4727 :: 4727 ::
@@ -4737,7 +4737,7 @@ system and gives an overview of their function and contents.
4737 4737
4738 See the :term:`MACHINE` variable for additional information. 4738 See the :term:`MACHINE` variable for additional information.
4739 4739
4740 MODULE_TARBALL_NAME 4740 :term:`MODULE_TARBALL_NAME`
4741 The base name of the kernel module tarball. This variable is set in 4741 The base name of the kernel module tarball. This variable is set in
4742 the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: 4742 the ``meta/classes/kernel-artifact-names.bbclass`` file as follows:
4743 :: 4743 ::
@@ -4750,7 +4750,7 @@ system and gives an overview of their function and contents.
4750 4750
4751 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 4751 KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
4752 4752
4753 MULTIMACH_TARGET_SYS 4753 :term:`MULTIMACH_TARGET_SYS`
4754 Uniquely identifies the type of the target system for which packages 4754 Uniquely identifies the type of the target system for which packages
4755 are being built. This variable allows output for different types of 4755 are being built. This variable allows output for different types of
4756 target systems to be put into different subdirectories of the same 4756 target systems to be put into different subdirectories of the same
@@ -4768,7 +4768,7 @@ system and gives an overview of their function and contents.
4768 See the :term:`STAMP` variable for an example. See the 4768 See the :term:`STAMP` variable for an example. See the
4769 :term:`STAGING_DIR_TARGET` variable for more information. 4769 :term:`STAGING_DIR_TARGET` variable for more information.
4770 4770
4771 NATIVELSBSTRING 4771 :term:`NATIVELSBSTRING`
4772 A string identifying the host distribution. Strings consist of the 4772 A string identifying the host distribution. Strings consist of the
4773 host distributor ID followed by the release, as reported by the 4773 host distributor ID followed by the release, as reported by the
4774 ``lsb_release`` tool or as read from ``/etc/lsb-release``. For 4774 ``lsb_release`` tool or as read from ``/etc/lsb-release``. For
@@ -4783,10 +4783,10 @@ system and gives an overview of their function and contents.
4783 :term:`SANITY_TESTED_DISTROS` if that 4783 :term:`SANITY_TESTED_DISTROS` if that
4784 variable is set. 4784 variable is set.
4785 4785
4786 NM 4786 :term:`NM`
4787 The minimal command and arguments to run ``nm``. 4787 The minimal command and arguments to run ``nm``.
4788 4788
4789 NO_GENERIC_LICENSE 4789 :term:`NO_GENERIC_LICENSE`
4790 Avoids QA errors when you use a non-common, non-CLOSED license in a 4790 Avoids QA errors when you use a non-common, non-CLOSED license in a
4791 recipe. Packages exist, such as the linux-firmware package, with many 4791 recipe. Packages exist, such as the linux-firmware package, with many
4792 licenses that are not in any way common. Also, new licenses are added 4792 licenses that are not in any way common. Also, new licenses are added
@@ -4808,7 +4808,7 @@ system and gives an overview of their function and contents.
4808 4808
4809 NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" 4809 NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt"
4810 4810
4811 NO_RECOMMENDATIONS 4811 :term:`NO_RECOMMENDATIONS`
4812 Prevents installation of all "recommended-only" packages. 4812 Prevents installation of all "recommended-only" packages.
4813 Recommended-only packages are packages installed only through the 4813 Recommended-only packages are packages installed only through the
4814 :term:`RRECOMMENDS` variable). Setting the 4814 :term:`RRECOMMENDS` variable). Setting the
@@ -4841,7 +4841,7 @@ system and gives an overview of their function and contents.
4841 the :term:`PACKAGE_EXCLUDE` variables for 4841 the :term:`PACKAGE_EXCLUDE` variables for
4842 related information. 4842 related information.
4843 4843
4844 NOAUTOPACKAGEDEBUG 4844 :term:`NOAUTOPACKAGEDEBUG`
4845 Disables auto package from splitting ``.debug`` files. If a recipe 4845 Disables auto package from splitting ``.debug`` files. If a recipe
4846 requires ``FILES_${PN}-dbg`` to be set manually, the 4846 requires ``FILES_${PN}-dbg`` to be set manually, the
4847 ``NOAUTOPACKAGEDEBUG`` can be defined allowing you to define the 4847 ``NOAUTOPACKAGEDEBUG`` can be defined allowing you to define the
@@ -4853,13 +4853,13 @@ system and gives an overview of their function and contents.
4853 FILES_${PN}-dbg = "/usr/src/debug/" 4853 FILES_${PN}-dbg = "/usr/src/debug/"
4854 FILES_${QT_BASE_NAME}-demos-doc = "${docdir}/${QT_DIR_NAME}/qch/qt.qch" 4854 FILES_${QT_BASE_NAME}-demos-doc = "${docdir}/${QT_DIR_NAME}/qch/qt.qch"
4855 4855
4856 OBJCOPY 4856 :term:`OBJCOPY`
4857 The minimal command and arguments to run ``objcopy``. 4857 The minimal command and arguments to run ``objcopy``.
4858 4858
4859 OBJDUMP 4859 :term:`OBJDUMP`
4860 The minimal command and arguments to run ``objdump``. 4860 The minimal command and arguments to run ``objdump``.
4861 4861
4862 OE_BINCONFIG_EXTRA_MANGLE 4862 :term:`OE_BINCONFIG_EXTRA_MANGLE`
4863 When inheriting the :ref:`binconfig <ref-classes-binconfig>` class, 4863 When inheriting the :ref:`binconfig <ref-classes-binconfig>` class,
4864 this variable specifies additional arguments passed to the "sed" 4864 this variable specifies additional arguments passed to the "sed"
4865 command. The sed command alters any paths in configuration scripts 4865 command. The sed command alters any paths in configuration scripts
@@ -4874,7 +4874,7 @@ system and gives an overview of their function and contents.
4874 information on the ``binconfig`` class, see the 4874 information on the ``binconfig`` class, see the
4875 ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section. 4875 ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section.
4876 4876
4877 OE_IMPORTS 4877 :term:`OE_IMPORTS`
4878 An internal variable used to tell the OpenEmbedded build system what 4878 An internal variable used to tell the OpenEmbedded build system what
4879 Python modules to import for every Python function run by the system. 4879 Python modules to import for every Python function run by the system.
4880 4880
@@ -4882,7 +4882,7 @@ system and gives an overview of their function and contents.
4882 4882
4883 Do not set this variable. It is for internal use only. 4883 Do not set this variable. It is for internal use only.
4884 4884
4885 OE_INIT_ENV_SCRIPT 4885 :term:`OE_INIT_ENV_SCRIPT`
4886 The name of the build environment setup script for the purposes of 4886 The name of the build environment setup script for the purposes of
4887 setting up the environment within the extensible SDK. The default 4887 setting up the environment within the extensible SDK. The default
4888 value is "oe-init-build-env". 4888 value is "oe-init-build-env".
@@ -4890,7 +4890,7 @@ system and gives an overview of their function and contents.
4890 If you use a custom script to set up your build environment, set the 4890 If you use a custom script to set up your build environment, set the
4891 ``OE_INIT_ENV_SCRIPT`` variable to its name. 4891 ``OE_INIT_ENV_SCRIPT`` variable to its name.
4892 4892
4893 OE_TERMINAL 4893 :term:`OE_TERMINAL`
4894 Controls how the OpenEmbedded build system spawns interactive 4894 Controls how the OpenEmbedded build system spawns interactive
4895 terminals on the host development system (e.g. using the BitBake 4895 terminals on the host development system (e.g. using the BitBake
4896 command with the ``-c devshell`` command-line option). For more 4896 command with the ``-c devshell`` command-line option). For more
@@ -4907,7 +4907,7 @@ system and gives an overview of their function and contents.
4907 - konsole 4907 - konsole
4908 - none 4908 - none
4909 4909
4910 OEROOT 4910 :term:`OEROOT`
4911 The directory from which the top-level build environment setup script 4911 The directory from which the top-level build environment setup script
4912 is sourced. The Yocto Project provides a top-level build environment 4912 is sourced. The Yocto Project provides a top-level build environment
4913 setup script: ````` <#structure-core-script>`__. When you run this 4913 setup script: ````` <#structure-core-script>`__. When you run this
@@ -4917,7 +4917,7 @@ system and gives an overview of their function and contents.
4917 For additional information on how this variable is used, see the 4917 For additional information on how this variable is used, see the
4918 initialization script. 4918 initialization script.
4919 4919
4920 OLDEST_KERNEL 4920 :term:`OLDEST_KERNEL`
4921 Declares the oldest version of the Linux kernel that the produced 4921 Declares the oldest version of the Linux kernel that the produced
4922 binaries must support. This variable is passed into the build of the 4922 binaries must support. This variable is passed into the build of the
4923 Embedded GNU C Library (``glibc``). 4923 Embedded GNU C Library (``glibc``).
@@ -4927,7 +4927,7 @@ system and gives an overview of their function and contents.
4927 default by setting the variable in a custom distribution 4927 default by setting the variable in a custom distribution
4928 configuration file. 4928 configuration file.
4929 4929
4930 OVERRIDES 4930 :term:`OVERRIDES`
4931 A colon-separated list of overrides that currently apply. Overrides 4931 A colon-separated list of overrides that currently apply. Overrides
4932 are a BitBake mechanism that allows variables to be selectively 4932 are a BitBake mechanism that allows variables to be selectively
4933 overridden at the end of parsing. The set of overrides in 4933 overridden at the end of parsing. The set of overrides in
@@ -4970,13 +4970,13 @@ system and gives an overview of their function and contents.
4970 " section in the Yocto Project Development Tasks Manual for more 4970 " section in the Yocto Project Development Tasks Manual for more
4971 information. 4971 information.
4972 4972
4973 P 4973 :term:`P`
4974 The recipe name and version. ``P`` is comprised of the following: 4974 The recipe name and version. ``P`` is comprised of the following:
4975 :: 4975 ::
4976 4976
4977 ${PN}-${PV} 4977 ${PN}-${PV}
4978 4978
4979 PACKAGE_ADD_METADATA 4979 :term:`PACKAGE_ADD_METADATA`
4980 This variable defines additional metdata to add to packages. 4980 This variable defines additional metdata to add to packages.
4981 4981
4982 You may find you need to inject additional metadata into packages. 4982 You may find you need to inject additional metadata into packages.
@@ -4992,7 +4992,7 @@ system and gives an overview of their function and contents.
4992 ":ref:`dev-manual/dev-manual-common-tasks:adding custom metadata to packages`" 4992 ":ref:`dev-manual/dev-manual-common-tasks:adding custom metadata to packages`"
4993 section in the Yocto Project Development Tasks Manual. 4993 section in the Yocto Project Development Tasks Manual.
4994 4994
4995 PACKAGE_ARCH 4995 :term:`PACKAGE_ARCH`
4996 The architecture of the resulting package or packages. 4996 The architecture of the resulting package or packages.
4997 4997
4998 By default, the value of this variable is set to 4998 By default, the value of this variable is set to
@@ -5015,19 +5015,19 @@ system and gives an overview of their function and contents.
5015 5015
5016 PACKAGE_ARCH = "${MACHINE_ARCH}" 5016 PACKAGE_ARCH = "${MACHINE_ARCH}"
5017 5017
5018 PACKAGE_ARCHS 5018 :term:`PACKAGE_ARCHS`
5019 Specifies a list of architectures compatible with the target machine. 5019 Specifies a list of architectures compatible with the target machine.
5020 This variable is set automatically and should not normally be 5020 This variable is set automatically and should not normally be
5021 hand-edited. Entries are separated using spaces and listed in order 5021 hand-edited. Entries are separated using spaces and listed in order
5022 of priority. The default value for ``PACKAGE_ARCHS`` is "all any 5022 of priority. The default value for ``PACKAGE_ARCHS`` is "all any
5023 noarch ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}". 5023 noarch ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}".
5024 5024
5025 PACKAGE_BEFORE_PN 5025 :term:`PACKAGE_BEFORE_PN`
5026 Enables easily adding packages to ``PACKAGES`` before ``${PN}`` so 5026 Enables easily adding packages to ``PACKAGES`` before ``${PN}`` so
5027 that those added packages can pick up files that would normally be 5027 that those added packages can pick up files that would normally be
5028 included in the default package. 5028 included in the default package.
5029 5029
5030 PACKAGE_CLASSES 5030 :term:`PACKAGE_CLASSES`
5031 This variable, which is set in the ``local.conf`` configuration file 5031 This variable, which is set in the ``local.conf`` configuration file
5032 found in the ``conf`` folder of the 5032 found in the ``conf`` folder of the
5033 :term:`Build Directory`, specifies the package manager the 5033 :term:`Build Directory`, specifies the package manager the
@@ -5060,7 +5060,7 @@ system and gives an overview of their function and contents.
5060 result of the package manager in use, see the 5060 result of the package manager in use, see the
5061 ":ref:`package.bbclass <ref-classes-package>`" section. 5061 ":ref:`package.bbclass <ref-classes-package>`" section.
5062 5062
5063 PACKAGE_DEBUG_SPLIT_STYLE 5063 :term:`PACKAGE_DEBUG_SPLIT_STYLE`
5064 Determines how to split up the binary and debug information when 5064 Determines how to split up the binary and debug information when
5065 creating ``*-dbg`` packages to be used with the GNU Project Debugger 5065 creating ``*-dbg`` packages to be used with the GNU Project Debugger
5066 (GDB). 5066 (GDB).
@@ -5093,7 +5093,7 @@ system and gives an overview of their function and contents.
5093 ":ref:`platdev-gdb-remotedebug`" section 5093 ":ref:`platdev-gdb-remotedebug`" section
5094 in the Yocto Project Development Tasks Manual. 5094 in the Yocto Project Development Tasks Manual.
5095 5095
5096 PACKAGE_EXCLUDE_COMPLEMENTARY 5096 :term:`PACKAGE_EXCLUDE_COMPLEMENTARY`
5097 Prevents specific packages from being installed when you are 5097 Prevents specific packages from being installed when you are
5098 installing complementary packages. 5098 installing complementary packages.
5099 5099
@@ -5105,7 +5105,7 @@ system and gives an overview of their function and contents.
5105 use the ``PACKAGE_EXCLUDE_COMPLEMENTARY`` variable to specify regular 5105 use the ``PACKAGE_EXCLUDE_COMPLEMENTARY`` variable to specify regular
5106 expressions to match the packages you want to exclude. 5106 expressions to match the packages you want to exclude.
5107 5107
5108 PACKAGE_EXCLUDE 5108 :term:`PACKAGE_EXCLUDE`
5109 Lists packages that should not be installed into an image. For 5109 Lists packages that should not be installed into an image. For
5110 example: 5110 example:
5111 :: 5111 ::
@@ -5134,12 +5134,12 @@ system and gives an overview of their function and contents.
5134 :term:`BAD_RECOMMENDATIONS` variables for 5134 :term:`BAD_RECOMMENDATIONS` variables for
5135 related information. 5135 related information.
5136 5136
5137 PACKAGE_EXTRA_ARCHS 5137 :term:`PACKAGE_EXTRA_ARCHS`
5138 Specifies the list of architectures compatible with the device CPU. 5138 Specifies the list of architectures compatible with the device CPU.
5139 This variable is useful when you build for several different devices 5139 This variable is useful when you build for several different devices
5140 that use miscellaneous processors such as XScale and ARM926-EJS. 5140 that use miscellaneous processors such as XScale and ARM926-EJS.
5141 5141
5142 PACKAGE_FEED_ARCHS 5142 :term:`PACKAGE_FEED_ARCHS`
5143 Optionally specifies the package architectures used as part of the 5143 Optionally specifies the package architectures used as part of the
5144 package feed URIs during the build. When used, the 5144 package feed URIs during the build. When used, the
5145 ``PACKAGE_FEED_ARCHS`` variable is appended to the final package feed 5145 ``PACKAGE_FEED_ARCHS`` variable is appended to the final package feed
@@ -5180,7 +5180,7 @@ system and gives an overview of their function and contents.
5180 https://example.com/packagerepos/updates/rpm-dev/all 5180 https://example.com/packagerepos/updates/rpm-dev/all
5181 https://example.com/packagerepos/updates/rpm-dev/core2-64 5181 https://example.com/packagerepos/updates/rpm-dev/core2-64
5182 5182
5183 PACKAGE_FEED_BASE_PATHS 5183 :term:`PACKAGE_FEED_BASE_PATHS`
5184 Specifies the base path used when constructing package feed URIs. The 5184 Specifies the base path used when constructing package feed URIs. The
5185 ``PACKAGE_FEED_BASE_PATHS`` variable makes up the middle portion of a 5185 ``PACKAGE_FEED_BASE_PATHS`` variable makes up the middle portion of a
5186 package feed URI used by the OpenEmbedded build system. The base path 5186 package feed URI used by the OpenEmbedded build system. The base path
@@ -5209,7 +5209,7 @@ system and gives an overview of their function and contents.
5209 https://example.com/packagerepos/updates/rpm-dev/all 5209 https://example.com/packagerepos/updates/rpm-dev/all
5210 https://example.com/packagerepos/updates/rpm-dev/core2-64 5210 https://example.com/packagerepos/updates/rpm-dev/core2-64
5211 5211
5212 PACKAGE_FEED_URIS 5212 :term:`PACKAGE_FEED_URIS`
5213 Specifies the front portion of the package feed URI used by the 5213 Specifies the front portion of the package feed URI used by the
5214 OpenEmbedded build system. Each final package feed URI is comprised 5214 OpenEmbedded build system. Each final package feed URI is comprised
5215 of ``PACKAGE_FEED_URIS``, 5215 of ``PACKAGE_FEED_URIS``,
@@ -5238,7 +5238,7 @@ system and gives an overview of their function and contents.
5238 https://example.com/packagerepos/updates/rpm-dev/all 5238 https://example.com/packagerepos/updates/rpm-dev/all
5239 https://example.com/packagerepos/updates/rpm-dev/core2-64 5239 https://example.com/packagerepos/updates/rpm-dev/core2-64
5240 5240
5241 PACKAGE_INSTALL 5241 :term:`PACKAGE_INSTALL`
5242 The final list of packages passed to the package manager for 5242 The final list of packages passed to the package manager for
5243 installation into the image. 5243 installation into the image.
5244 5244
@@ -5256,18 +5256,18 @@ system and gives an overview of their function and contents.
5256 initramfs, see the ":ref:`building-an-initramfs-image`" section 5256 initramfs, see the ":ref:`building-an-initramfs-image`" section
5257 in the Yocto Project Development Tasks Manual. 5257 in the Yocto Project Development Tasks Manual.
5258 5258
5259 PACKAGE_INSTALL_ATTEMPTONLY 5259 :term:`PACKAGE_INSTALL_ATTEMPTONLY`
5260 Specifies a list of packages the OpenEmbedded build system attempts 5260 Specifies a list of packages the OpenEmbedded build system attempts
5261 to install when creating an image. If a listed package fails to 5261 to install when creating an image. If a listed package fails to
5262 install, the build system does not generate an error. This variable 5262 install, the build system does not generate an error. This variable
5263 is generally not user-defined. 5263 is generally not user-defined.
5264 5264
5265 PACKAGE_PREPROCESS_FUNCS 5265 :term:`PACKAGE_PREPROCESS_FUNCS`
5266 Specifies a list of functions run to pre-process the 5266 Specifies a list of functions run to pre-process the
5267 :term:`PKGD` directory prior to splitting the files out 5267 :term:`PKGD` directory prior to splitting the files out
5268 to individual packages. 5268 to individual packages.
5269 5269
5270 PACKAGE_WRITE_DEPS 5270 :term:`PACKAGE_WRITE_DEPS`
5271 Specifies a list of dependencies for post-installation and 5271 Specifies a list of dependencies for post-installation and
5272 pre-installation scripts on native/cross tools. If your 5272 pre-installation scripts on native/cross tools. If your
5273 post-installation or pre-installation script can execute at rootfs 5273 post-installation or pre-installation script can execute at rootfs
@@ -5279,7 +5279,7 @@ system and gives an overview of their function and contents.
5279 ":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`" 5279 ":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`"
5280 section in the Yocto Project Development Tasks Manual. 5280 section in the Yocto Project Development Tasks Manual.
5281 5281
5282 PACKAGECONFIG 5282 :term:`PACKAGECONFIG`
5283 This variable provides a means of enabling or disabling features of a 5283 This variable provides a means of enabling or disabling features of a
5284 recipe on a per-recipe basis. ``PACKAGECONFIG`` blocks are defined in 5284 recipe on a per-recipe basis. ``PACKAGECONFIG`` blocks are defined in
5285 recipes when you specify features and then arguments that define 5285 recipes when you specify features and then arguments that define
@@ -5371,7 +5371,7 @@ system and gives an overview of their function and contents.
5371 5371
5372 PACKAGECONFIG_append_pn-recipename = " f4" 5372 PACKAGECONFIG_append_pn-recipename = " f4"
5373 5373
5374 PACKAGECONFIG_CONFARGS 5374 :term:`PACKAGECONFIG_CONFARGS`
5375 A space-separated list of configuration options generated from the 5375 A space-separated list of configuration options generated from the
5376 :term:`PACKAGECONFIG` setting. 5376 :term:`PACKAGECONFIG` setting.
5377 5377
@@ -5382,7 +5382,7 @@ system and gives an overview of their function and contents.
5382 handles the ``do_configure`` task, then you need to use 5382 handles the ``do_configure`` task, then you need to use
5383 ``PACKAGECONFIG_CONFARGS`` appropriately. 5383 ``PACKAGECONFIG_CONFARGS`` appropriately.
5384 5384
5385 PACKAGEGROUP_DISABLE_COMPLEMENTARY 5385 :term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY`
5386 For recipes inheriting the 5386 For recipes inheriting the
5387 :ref:`packagegroup <ref-classes-packagegroup>` class, setting 5387 :ref:`packagegroup <ref-classes-packagegroup>` class, setting
5388 ``PACKAGEGROUP_DISABLE_COMPLEMENTARY`` to "1" specifies that the 5388 ``PACKAGEGROUP_DISABLE_COMPLEMENTARY`` to "1" specifies that the
@@ -5390,7 +5390,7 @@ system and gives an overview of their function and contents.
5390 should not be automatically created by the ``packagegroup`` recipe, 5390 should not be automatically created by the ``packagegroup`` recipe,
5391 which is the default behavior. 5391 which is the default behavior.
5392 5392
5393 PACKAGES 5393 :term:`PACKAGES`
5394 The list of packages the recipe creates. The default value is the 5394 The list of packages the recipe creates. The default value is the
5395 following: 5395 following:
5396 :: 5396 ::
@@ -5410,7 +5410,7 @@ system and gives an overview of their function and contents.
5410 unless generation is forced through the 5410 unless generation is forced through the
5411 :term:`ALLOW_EMPTY` variable. 5411 :term:`ALLOW_EMPTY` variable.
5412 5412
5413 PACKAGES_DYNAMIC 5413 :term:`PACKAGES_DYNAMIC`
5414 A promise that your recipe satisfies runtime dependencies for 5414 A promise that your recipe satisfies runtime dependencies for
5415 optional modules that are found in other recipes. 5415 optional modules that are found in other recipes.
5416 ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it 5416 ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it
@@ -5433,7 +5433,7 @@ system and gives an overview of their function and contents.
5433 ":ref:`dev-manual/dev-manual-common-tasks:handling optional module packaging`" 5433 ":ref:`dev-manual/dev-manual-common-tasks:handling optional module packaging`"
5434 section in the Yocto Project Development Tasks Manual. 5434 section in the Yocto Project Development Tasks Manual.
5435 5435
5436 PACKAGESPLITFUNCS 5436 :term:`PACKAGESPLITFUNCS`
5437 Specifies a list of functions run to perform additional splitting of 5437 Specifies a list of functions run to perform additional splitting of
5438 files into individual packages. Recipes can either prepend to this 5438 files into individual packages. Recipes can either prepend to this
5439 variable or prepend to the ``populate_packages`` function in order to 5439 variable or prepend to the ``populate_packages`` function in order to
@@ -5443,7 +5443,7 @@ system and gives an overview of their function and contents.
5443 other packaging variables appropriately in order to perform the 5443 other packaging variables appropriately in order to perform the
5444 desired splitting. 5444 desired splitting.
5445 5445
5446 PARALLEL_MAKE 5446 :term:`PARALLEL_MAKE`
5447 Extra options passed to the ``make`` command during the 5447 Extra options passed to the ``make`` command during the
5448 :ref:`ref-tasks-compile` task in order to specify 5448 :ref:`ref-tasks-compile` task in order to specify
5449 parallel compilation on the local build host. This variable is 5449 parallel compilation on the local build host. This variable is
@@ -5489,7 +5489,7 @@ system and gives an overview of their function and contents.
5489 ":ref:`dev-manual/dev-manual-common-tasks:speeding up a build`" 5489 ":ref:`dev-manual/dev-manual-common-tasks:speeding up a build`"
5490 section in the Yocto Project Development Tasks Manual. 5490 section in the Yocto Project Development Tasks Manual.
5491 5491
5492 PARALLEL_MAKEINST 5492 :term:`PARALLEL_MAKEINST`
5493 Extra options passed to the ``make install`` command during the 5493 Extra options passed to the ``make install`` command during the
5494 :ref:`ref-tasks-install` task in order to specify 5494 :ref:`ref-tasks-install` task in order to specify
5495 parallel installation. This variable defaults to the value of 5495 parallel installation. This variable defaults to the value of
@@ -5509,7 +5509,7 @@ system and gives an overview of their function and contents.
5509 ":ref:`dev-manual/dev-manual-common-tasks:debugging parallel make races`" 5509 ":ref:`dev-manual/dev-manual-common-tasks:debugging parallel make races`"
5510 section in the Yocto Project Development Tasks Manual. 5510 section in the Yocto Project Development Tasks Manual.
5511 5511
5512 PATCHRESOLVE 5512 :term:`PATCHRESOLVE`
5513 Determines the action to take when a patch fails. You can set this 5513 Determines the action to take when a patch fails. You can set this
5514 variable to one of two values: "noop" and "user". 5514 variable to one of two values: "noop" and "user".
5515 5515
@@ -5521,7 +5521,7 @@ system and gives an overview of their function and contents.
5521 5521
5522 Set this variable in your ``local.conf`` file. 5522 Set this variable in your ``local.conf`` file.
5523 5523
5524 PATCHTOOL 5524 :term:`PATCHTOOL`
5525 Specifies the utility used to apply patches for a recipe during the 5525 Specifies the utility used to apply patches for a recipe during the
5526 :ref:`ref-tasks-patch` task. You can specify one of 5526 :ref:`ref-tasks-patch` task. You can specify one of
5527 three utilities: "patch", "quilt", or "git". The default utility used 5527 three utilities: "patch", "quilt", or "git". The default utility used
@@ -5537,20 +5537,20 @@ system and gives an overview of their function and contents.
5537 PATCHTOOL = "quilt" 5537 PATCHTOOL = "quilt"
5538 PATCHTOOL = "git" 5538 PATCHTOOL = "git"
5539 5539
5540 PE 5540 :term:`PE`
5541 The epoch of the recipe. By default, this variable is unset. The 5541 The epoch of the recipe. By default, this variable is unset. The
5542 variable is used to make upgrades possible when the versioning scheme 5542 variable is used to make upgrades possible when the versioning scheme
5543 changes in some backwards incompatible way. 5543 changes in some backwards incompatible way.
5544 5544
5545 ``PE`` is the default value of the :term:`PKGE` variable. 5545 ``PE`` is the default value of the :term:`PKGE` variable.
5546 5546
5547 PF 5547 :term:`PF`
5548 Specifies the recipe or package name and includes all version and 5548 Specifies the recipe or package name and includes all version and
5549 revision numbers (i.e. ``glibc-2.13-r20+svnr15508/`` and 5549 revision numbers (i.e. ``glibc-2.13-r20+svnr15508/`` and
5550 ``bash-4.2-r1/``). This variable is comprised of the following: 5550 ``bash-4.2-r1/``). This variable is comprised of the following:
5551 ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`} 5551 ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`}
5552 5552
5553 PIXBUF_PACKAGES 5553 :term:`PIXBUF_PACKAGES`
5554 When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>` 5554 When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>`
5555 class, this variable identifies packages that contain the pixbuf 5555 class, this variable identifies packages that contain the pixbuf
5556 loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache`` 5556 loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache``
@@ -5558,7 +5558,7 @@ system and gives an overview of their function and contents.
5558 ``${``\ :term:`PN`\ ``}``). Use this variable if the 5558 ``${``\ :term:`PN`\ ``}``). Use this variable if the
5559 loaders you need are in a package other than that main package. 5559 loaders you need are in a package other than that main package.
5560 5560
5561 PKG 5561 :term:`PKG`
5562 The name of the resulting package created by the OpenEmbedded build 5562 The name of the resulting package created by the OpenEmbedded build
5563 system. 5563 system.
5564 5564
@@ -5572,11 +5572,11 @@ system and gives an overview of their function and contents.
5572 renames the output package, it does so by setting 5572 renames the output package, it does so by setting
5573 ``PKG_packagename``. 5573 ``PKG_packagename``.
5574 5574
5575 PKG_CONFIG_PATH 5575 :term:`PKG_CONFIG_PATH`
5576 The path to ``pkg-config`` files for the current build context. 5576 The path to ``pkg-config`` files for the current build context.
5577 ``pkg-config`` reads this variable from the environment. 5577 ``pkg-config`` reads this variable from the environment.
5578 5578
5579 PKGD 5579 :term:`PKGD`
5580 Points to the destination directory for files to be packaged before 5580 Points to the destination directory for files to be packaged before
5581 they are split into individual packages. This directory defaults to 5581 they are split into individual packages. This directory defaults to
5582 the following: 5582 the following:
@@ -5586,7 +5586,7 @@ system and gives an overview of their function and contents.
5586 5586
5587 Do not change this default. 5587 Do not change this default.
5588 5588
5589 PKGDATA_DIR 5589 :term:`PKGDATA_DIR`
5590 Points to a shared, global-state directory that holds data generated 5590 Points to a shared, global-state directory that holds data generated
5591 during the packaging process. During the packaging process, the 5591 during the packaging process. During the packaging process, the
5592 :ref:`ref-tasks-packagedata` task packages data 5592 :ref:`ref-tasks-packagedata` task packages data
@@ -5605,7 +5605,7 @@ system and gives an overview of their function and contents.
5605 information on the shared, global-state directory, see 5605 information on the shared, global-state directory, see
5606 :term:`STAGING_DIR_HOST`. 5606 :term:`STAGING_DIR_HOST`.
5607 5607
5608 PKGDEST 5608 :term:`PKGDEST`
5609 Points to the parent directory for files to be packaged after they 5609 Points to the parent directory for files to be packaged after they
5610 have been split into individual packages. This directory defaults to 5610 have been split into individual packages. This directory defaults to
5611 the following: 5611 the following:
@@ -5617,7 +5617,7 @@ system and gives an overview of their function and contents.
5617 package specified in :term:`PACKAGES`. Do not change 5617 package specified in :term:`PACKAGES`. Do not change
5618 this default. 5618 this default.
5619 5619
5620 PKGDESTWORK 5620 :term:`PKGDESTWORK`
5621 Points to a temporary work area where the 5621 Points to a temporary work area where the
5622 :ref:`ref-tasks-package` task saves package metadata. 5622 :ref:`ref-tasks-package` task saves package metadata.
5623 The ``PKGDESTWORK`` location defaults to the following: 5623 The ``PKGDESTWORK`` location defaults to the following:
@@ -5631,19 +5631,19 @@ system and gives an overview of their function and contents.
5631 package metadata from ``PKGDESTWORK`` to 5631 package metadata from ``PKGDESTWORK`` to
5632 :term:`PKGDATA_DIR` to make it available globally. 5632 :term:`PKGDATA_DIR` to make it available globally.
5633 5633
5634 PKGE 5634 :term:`PKGE`
5635 The epoch of the package(s) built by the recipe. By default, ``PKGE`` 5635 The epoch of the package(s) built by the recipe. By default, ``PKGE``
5636 is set to :term:`PE`. 5636 is set to :term:`PE`.
5637 5637
5638 PKGR 5638 :term:`PKGR`
5639 The revision of the package(s) built by the recipe. By default, 5639 The revision of the package(s) built by the recipe. By default,
5640 ``PKGR`` is set to :term:`PR`. 5640 ``PKGR`` is set to :term:`PR`.
5641 5641
5642 PKGV 5642 :term:`PKGV`
5643 The version of the package(s) built by the recipe. By default, 5643 The version of the package(s) built by the recipe. By default,
5644 ``PKGV`` is set to :term:`PV`. 5644 ``PKGV`` is set to :term:`PV`.
5645 5645
5646 PN 5646 :term:`PN`
5647 This variable can have two separate functions depending on the 5647 This variable can have two separate functions depending on the
5648 context: a recipe name or a resulting package name. 5648 context: a recipe name or a resulting package name.
5649 5649
@@ -5662,7 +5662,7 @@ system and gives an overview of their function and contents.
5662 packages for the target and for Multilib, ``PN`` would be ``bash`` 5662 packages for the target and for Multilib, ``PN`` would be ``bash``
5663 and ``lib64-bash``, respectively. 5663 and ``lib64-bash``, respectively.
5664 5664
5665 PNBLACKLIST 5665 :term:`PNBLACKLIST`
5666 Lists recipes you do not want the OpenEmbedded build system to build. 5666 Lists recipes you do not want the OpenEmbedded build system to build.
5667 This variable works in conjunction with the 5667 This variable works in conjunction with the
5668 :ref:`blacklist <ref-classes-blacklist>` class, which is inherited 5668 :ref:`blacklist <ref-classes-blacklist>` class, which is inherited
@@ -5675,7 +5675,7 @@ system and gives an overview of their function and contents.
5675 5675
5676 PNBLACKLIST[myrecipe] = "Not supported by our organization." 5676 PNBLACKLIST[myrecipe] = "Not supported by our organization."
5677 5677
5678 POPULATE_SDK_POST_HOST_COMMAND 5678 :term:`POPULATE_SDK_POST_HOST_COMMAND`
5679 Specifies a list of functions to call once the OpenEmbedded build 5679 Specifies a list of functions to call once the OpenEmbedded build
5680 system has created the host part of the SDK. You can specify 5680 system has created the host part of the SDK. You can specify
5681 functions separated by semicolons: 5681 functions separated by semicolons:
@@ -5688,7 +5688,7 @@ system and gives an overview of their function and contents.
5688 the OpenEmbedded build system when creating SDK output. See the 5688 the OpenEmbedded build system when creating SDK output. See the
5689 :term:`SDK_DIR` variable for more information. 5689 :term:`SDK_DIR` variable for more information.
5690 5690
5691 POPULATE_SDK_POST_TARGET_COMMAND 5691 :term:`POPULATE_SDK_POST_TARGET_COMMAND`
5692 Specifies a list of functions to call once the OpenEmbedded build 5692 Specifies a list of functions to call once the OpenEmbedded build
5693 system has created the target part of the SDK. You can specify 5693 system has created the target part of the SDK. You can specify
5694 functions separated by semicolons: 5694 functions separated by semicolons:
@@ -5701,7 +5701,7 @@ system and gives an overview of their function and contents.
5701 the OpenEmbedded build system when creating SDK output. See the 5701 the OpenEmbedded build system when creating SDK output. See the
5702 :term:`SDK_DIR` variable for more information. 5702 :term:`SDK_DIR` variable for more information.
5703 5703
5704 PR 5704 :term:`PR`
5705 The revision of the recipe. The default value for this variable is 5705 The revision of the recipe. The default value for this variable is
5706 "r0". Subsequent revisions of the recipe conventionally have the 5706 "r0". Subsequent revisions of the recipe conventionally have the
5707 values "r1", "r2", and so forth. When :term:`PV` increases, 5707 values "r1", "r2", and so forth. When :term:`PV` increases,
@@ -5740,7 +5740,7 @@ system and gives an overview of their function and contents.
5740 ":ref:`dev-manual/dev-manual-common-tasks:working with a pr service`" section 5740 ":ref:`dev-manual/dev-manual-common-tasks:working with a pr service`" section
5741 in the Yocto Project Development Tasks Manual for more information. 5741 in the Yocto Project Development Tasks Manual for more information.
5742 5742
5743 PREFERRED_PROVIDER 5743 :term:`PREFERRED_PROVIDER`
5744 If multiple recipes provide the same item, this variable determines 5744 If multiple recipes provide the same item, this variable determines
5745 which recipe is preferred and thus provides the item (i.e. the 5745 which recipe is preferred and thus provides the item (i.e. the
5746 preferred provider). You should always suffix this variable with the 5746 preferred provider). You should always suffix this variable with the
@@ -5779,7 +5779,7 @@ system and gives an overview of their function and contents.
5779 mechanism is designed to select between mutually exclusive 5779 mechanism is designed to select between mutually exclusive
5780 alternative providers. 5780 alternative providers.
5781 5781
5782 PREFERRED_VERSION 5782 :term:`PREFERRED_VERSION`
5783 If multiple versions of recipes exist, this variable determines which 5783 If multiple versions of recipes exist, this variable determines which
5784 version is given preference. You must always suffix the variable with 5784 version is given preference. You must always suffix the variable with
5785 the :term:`PN` you want to select, and you should set the 5785 the :term:`PN` you want to select, and you should set the
@@ -5841,7 +5841,7 @@ system and gives an overview of their function and contents.
5841 The \_forcevariable override is not handled specially. This override 5841 The \_forcevariable override is not handled specially. This override
5842 only works because the default value of OVERRIDES includes "forcevariable". 5842 only works because the default value of OVERRIDES includes "forcevariable".
5843 5843
5844 PREMIRRORS 5844 :term:`PREMIRRORS`
5845 Specifies additional paths from which the OpenEmbedded build system 5845 Specifies additional paths from which the OpenEmbedded build system
5846 gets source code. When the build system searches for source code, it 5846 gets source code. When the build system searches for source code, it
5847 first tries the local download directory. If that location fails, the 5847 first tries the local download directory. If that location fails, the
@@ -5871,7 +5871,7 @@ system and gives an overview of their function and contents.
5871 ``file://`` URLs to point to local directories or network shares as 5871 ``file://`` URLs to point to local directories or network shares as
5872 well. 5872 well.
5873 5873
5874 PRIORITY 5874 :term:`PRIORITY`
5875 Indicates the importance of a package. 5875 Indicates the importance of a package.
5876 5876
5877 ``PRIORITY`` is considered to be part of the distribution policy 5877 ``PRIORITY`` is considered to be part of the distribution policy
@@ -5882,7 +5882,7 @@ system and gives an overview of their function and contents.
5882 You can set ``PRIORITY`` to "required", "standard", "extra", and 5882 You can set ``PRIORITY`` to "required", "standard", "extra", and
5883 "optional", which is the default. 5883 "optional", which is the default.
5884 5884
5885 PRIVATE_LIBS 5885 :term:`PRIVATE_LIBS`
5886 Specifies libraries installed within a recipe that should be ignored 5886 Specifies libraries installed within a recipe that should be ignored
5887 by the OpenEmbedded build system's shared library resolver. This 5887 by the OpenEmbedded build system's shared library resolver. This
5888 variable is typically used when software being built by a recipe has 5888 variable is typically used when software being built by a recipe has
@@ -5908,7 +5908,7 @@ system and gives an overview of their function and contents.
5908 ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" 5908 ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`"
5909 section in the Yocto Project Overview and Concepts Manual. 5909 section in the Yocto Project Overview and Concepts Manual.
5910 5910
5911 PROVIDES 5911 :term:`PROVIDES`
5912 A list of aliases by which a particular recipe can be known. By 5912 A list of aliases by which a particular recipe can be known. By
5913 default, a recipe's own ``PN`` is implicitly already in its 5913 default, a recipe's own ``PN`` is implicitly already in its
5914 ``PROVIDES`` list and therefore does not need to mention that it 5914 ``PROVIDES`` list and therefore does not need to mention that it
@@ -5971,7 +5971,7 @@ system and gives an overview of their function and contents.
5971 VIRTUAL-RUNTIME_dev_manager = "udev" 5971 VIRTUAL-RUNTIME_dev_manager = "udev"
5972 5972
5973 5973
5974 PRSERV_HOST 5974 :term:`PRSERV_HOST`
5975 The network based :term:`PR` service host and port. 5975 The network based :term:`PR` service host and port.
5976 5976
5977 The ``conf/local.conf.sample.extended`` configuration file in the 5977 The ``conf/local.conf.sample.extended`` configuration file in the
@@ -5986,7 +5986,7 @@ system and gives an overview of their function and contents.
5986 service <dev-manual/dev-manual-common-tasks:working with a pr service>`. You can 5986 service <dev-manual/dev-manual-common-tasks:working with a pr service>`. You can
5987 set ``PRSERV_HOST`` to other values to use a remote PR service. 5987 set ``PRSERV_HOST`` to other values to use a remote PR service.
5988 5988
5989 PTEST_ENABLED 5989 :term:`PTEST_ENABLED`
5990 Specifies whether or not :ref:`Package 5990 Specifies whether or not :ref:`Package
5991 Test <dev-manual/dev-manual-common-tasks:testing packages with ptest>` (ptest) 5991 Test <dev-manual/dev-manual-common-tasks:testing packages with ptest>` (ptest)
5992 functionality is enabled when building a recipe. You should not set 5992 functionality is enabled when building a recipe. You should not set
@@ -5994,7 +5994,7 @@ system and gives an overview of their function and contents.
5994 at build time should be done by adding "ptest" to (or removing it 5994 at build time should be done by adding "ptest" to (or removing it
5995 from) :term:`DISTRO_FEATURES`. 5995 from) :term:`DISTRO_FEATURES`.
5996 5996
5997 PV 5997 :term:`PV`
5998 The version of the recipe. The version is normally extracted from the 5998 The version of the recipe. The version is normally extracted from the
5999 recipe filename. For example, if the recipe is named 5999 recipe filename. For example, if the recipe is named
6000 ``expat_2.0.1.bb``, then the default value of ``PV`` will be "2.0.1". 6000 ``expat_2.0.1.bb``, then the default value of ``PV`` will be "2.0.1".
@@ -6004,7 +6004,7 @@ system and gives an overview of their function and contents.
6004 6004
6005 ``PV`` is the default value of the :term:`PKGV` variable. 6005 ``PV`` is the default value of the :term:`PKGV` variable.
6006 6006
6007 PYTHON_ABI 6007 :term:`PYTHON_ABI`
6008 When used by recipes that inherit the 6008 When used by recipes that inherit the
6009 :ref:`distutils3 <ref-classes-distutils3>`, 6009 :ref:`distutils3 <ref-classes-distutils3>`,
6010 :ref:`setuptools3 <ref-classes-setuptools3>`, 6010 :ref:`setuptools3 <ref-classes-setuptools3>`,
@@ -6022,7 +6022,7 @@ system and gives an overview of their function and contents.
6022 use this variable to locate the headers and libraries of the 6022 use this variable to locate the headers and libraries of the
6023 appropriate Python that the extension is targeting. 6023 appropriate Python that the extension is targeting.
6024 6024
6025 PYTHON_PN 6025 :term:`PYTHON_PN`
6026 When used by recipes that inherit the 6026 When used by recipes that inherit the
6027 `distutils3 <ref-classes-distutils3>`, 6027 `distutils3 <ref-classes-distutils3>`,
6028 :ref:`setuptools3 <ref-classes-setuptools3>`, 6028 :ref:`setuptools3 <ref-classes-setuptools3>`,
@@ -6041,10 +6041,10 @@ system and gives an overview of their function and contents.
6041 In the previous example, 6041 In the previous example,
6042 the version of the dependency is ``PYTHON_PN``. 6042 the version of the dependency is ``PYTHON_PN``.
6043 6043
6044 RANLIB 6044 :term:`RANLIB`
6045 The minimal command and arguments to run ``ranlib``. 6045 The minimal command and arguments to run ``ranlib``.
6046 6046
6047 RCONFLICTS 6047 :term:`RCONFLICTS`
6048 The list of packages that conflict with packages. Note that packages 6048 The list of packages that conflict with packages. Note that packages
6049 will not be installed if conflicting packages are not first removed. 6049 will not be installed if conflicting packages are not first removed.
6050 6050
@@ -6070,7 +6070,7 @@ system and gives an overview of their function and contents.
6070 6070
6071 RCONFLICTS_${PN} = "foo (>= 1.2)" 6071 RCONFLICTS_${PN} = "foo (>= 1.2)"
6072 6072
6073 RDEPENDS 6073 :term:`RDEPENDS`
6074 Lists runtime dependencies of a package. These dependencies are other 6074 Lists runtime dependencies of a package. These dependencies are other
6075 packages that must be installed in order for the package to function 6075 packages that must be installed in order for the package to function
6076 correctly. As an example, the following assignment declares that the 6076 correctly. As an example, the following assignment declares that the
@@ -6182,7 +6182,7 @@ system and gives an overview of their function and contents.
6182 BitBake User Manual for additional information on tasks and 6182 BitBake User Manual for additional information on tasks and
6183 dependencies. 6183 dependencies.
6184 6184
6185 REQUIRED_DISTRO_FEATURES 6185 :term:`REQUIRED_DISTRO_FEATURES`
6186 When inheriting the 6186 When inheriting the
6187 :ref:`distro_features_check <ref-classes-distro_features_check>` 6187 :ref:`distro_features_check <ref-classes-distro_features_check>`
6188 class, this variable identifies distribution features that must exist 6188 class, this variable identifies distribution features that must exist
@@ -6192,13 +6192,13 @@ system and gives an overview of their function and contents.
6192 appear in ``DISTRO_FEATURES`` within the current configuration, an 6192 appear in ``DISTRO_FEATURES`` within the current configuration, an
6193 error occurs and the build stops. 6193 error occurs and the build stops.
6194 6194
6195 RM_WORK_EXCLUDE 6195 :term:`RM_WORK_EXCLUDE`
6196 With ``rm_work`` enabled, this variable specifies a list of recipes 6196 With ``rm_work`` enabled, this variable specifies a list of recipes
6197 whose work directories should not be removed. See the 6197 whose work directories should not be removed. See the
6198 ":ref:`rm_work.bbclass <ref-classes-rm-work>`" section for more 6198 ":ref:`rm_work.bbclass <ref-classes-rm-work>`" section for more
6199 details. 6199 details.
6200 6200
6201 ROOT_HOME 6201 :term:`ROOT_HOME`
6202 Defines the root home directory. By default, this directory is set as 6202 Defines the root home directory. By default, this directory is set as
6203 follows in the BitBake configuration file: 6203 follows in the BitBake configuration file:
6204 :: 6204 ::
@@ -6224,13 +6224,13 @@ system and gives an overview of their function and contents.
6224 override examples use ``/root``, which is probably the most commonly 6224 override examples use ``/root``, which is probably the most commonly
6225 used override. 6225 used override.
6226 6226
6227 ROOTFS 6227 :term:`ROOTFS`
6228 Indicates a filesystem image to include as the root filesystem. 6228 Indicates a filesystem image to include as the root filesystem.
6229 6229
6230 The ``ROOTFS`` variable is an optional variable used with the 6230 The ``ROOTFS`` variable is an optional variable used with the
6231 :ref:`image-live <ref-classes-image-live>` class. 6231 :ref:`image-live <ref-classes-image-live>` class.
6232 6232
6233 ROOTFS_POSTINSTALL_COMMAND 6233 :term:`ROOTFS_POSTINSTALL_COMMAND`
6234 Specifies a list of functions to call after the OpenEmbedded build 6234 Specifies a list of functions to call after the OpenEmbedded build
6235 system has installed packages. You can specify functions separated by 6235 system has installed packages. You can specify functions separated by
6236 semicolons: 6236 semicolons:
@@ -6244,7 +6244,7 @@ system and gives an overview of their function and contents.
6244 :term:`IMAGE_ROOTFS` variable for more 6244 :term:`IMAGE_ROOTFS` variable for more
6245 information. 6245 information.
6246 6246
6247 ROOTFS_POSTPROCESS_COMMAND 6247 :term:`ROOTFS_POSTPROCESS_COMMAND`
6248 Specifies a list of functions to call once the OpenEmbedded build 6248 Specifies a list of functions to call once the OpenEmbedded build
6249 system has created the root filesystem. You can specify functions 6249 system has created the root filesystem. You can specify functions
6250 separated by semicolons: 6250 separated by semicolons:
@@ -6258,7 +6258,7 @@ system and gives an overview of their function and contents.
6258 :term:`IMAGE_ROOTFS` variable for more 6258 :term:`IMAGE_ROOTFS` variable for more
6259 information. 6259 information.
6260 6260
6261 ROOTFS_POSTUNINSTALL_COMMAND 6261 :term:`ROOTFS_POSTUNINSTALL_COMMAND`
6262 Specifies a list of functions to call after the OpenEmbedded build 6262 Specifies a list of functions to call after the OpenEmbedded build
6263 system has removed unnecessary packages. When runtime package 6263 system has removed unnecessary packages. When runtime package
6264 management is disabled in the image, several packages are removed 6264 management is disabled in the image, several packages are removed
@@ -6274,7 +6274,7 @@ system and gives an overview of their function and contents.
6274 :term:`IMAGE_ROOTFS` variable for more 6274 :term:`IMAGE_ROOTFS` variable for more
6275 information. 6275 information.
6276 6276
6277 ROOTFS_PREPROCESS_COMMAND 6277 :term:`ROOTFS_PREPROCESS_COMMAND`
6278 Specifies a list of functions to call before the OpenEmbedded build 6278 Specifies a list of functions to call before the OpenEmbedded build
6279 system has created the root filesystem. You can specify functions 6279 system has created the root filesystem. You can specify functions
6280 separated by semicolons: 6280 separated by semicolons:
@@ -6288,7 +6288,7 @@ system and gives an overview of their function and contents.
6288 :term:`IMAGE_ROOTFS` variable for more 6288 :term:`IMAGE_ROOTFS` variable for more
6289 information. 6289 information.
6290 6290
6291 RPROVIDES 6291 :term:`RPROVIDES`
6292 A list of package name aliases that a package also provides. These 6292 A list of package name aliases that a package also provides. These
6293 aliases are useful for satisfying runtime dependencies of other 6293 aliases are useful for satisfying runtime dependencies of other
6294 packages both during the build and on the target (as specified by 6294 packages both during the build and on the target (as specified by
@@ -6307,7 +6307,7 @@ system and gives an overview of their function and contents.
6307 6307
6308 RPROVIDES_${PN} = "widget-abi-2" 6308 RPROVIDES_${PN} = "widget-abi-2"
6309 6309
6310 RRECOMMENDS 6310 :term:`RRECOMMENDS`
6311 A list of packages that extends the usability of a package being 6311 A list of packages that extends the usability of a package being
6312 built. The package being built does not depend on this list of 6312 built. The package being built does not depend on this list of
6313 packages in order to successfully build, but rather uses them for 6313 packages in order to successfully build, but rather uses them for
@@ -6367,7 +6367,7 @@ system and gives an overview of their function and contents.
6367 6367
6368 RRECOMMENDS_${PN} = "foo (>= 1.2)" 6368 RRECOMMENDS_${PN} = "foo (>= 1.2)"
6369 6369
6370 RREPLACES 6370 :term:`RREPLACES`
6371 A list of packages replaced by a package. The package manager uses 6371 A list of packages replaced by a package. The package manager uses
6372 this variable to determine which package should be installed to 6372 this variable to determine which package should be installed to
6373 replace other package(s) during an upgrade. In order to also have the 6373 replace other package(s) during an upgrade. In order to also have the
@@ -6403,7 +6403,7 @@ system and gives an overview of their function and contents.
6403 6403
6404 RREPLACES_${PN} = "foo (>= 1.2)" 6404 RREPLACES_${PN} = "foo (>= 1.2)"
6405 6405
6406 RSUGGESTS 6406 :term:`RSUGGESTS`
6407 A list of additional packages that you can suggest for installation 6407 A list of additional packages that you can suggest for installation
6408 by the package manager at the time a package is installed. Not all 6408 by the package manager at the time a package is installed. Not all
6409 package managers support this functionality. 6409 package managers support this functionality.
@@ -6415,7 +6415,7 @@ system and gives an overview of their function and contents.
6415 6415
6416 RSUGGESTS_${PN} = "useful_package another_package" 6416 RSUGGESTS_${PN} = "useful_package another_package"
6417 6417
6418 S 6418 :term:`S`
6419 The location in the :term:`Build Directory` where 6419 The location in the :term:`Build Directory` where
6420 unpacked recipe source code resides. By default, this directory is 6420 unpacked recipe source code resides. By default, this directory is
6421 ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, 6421 ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``,
@@ -6446,13 +6446,13 @@ system and gives an overview of their function and contents.
6446 SRC_URI = "git://path/to/repo.git" 6446 SRC_URI = "git://path/to/repo.git"
6447 S = "${WORKDIR}/git" 6447 S = "${WORKDIR}/git"
6448 6448
6449 SANITY_REQUIRED_UTILITIES 6449 :term:`SANITY_REQUIRED_UTILITIES`
6450 Specifies a list of command-line utilities that should be checked for 6450 Specifies a list of command-line utilities that should be checked for
6451 during the initial sanity checking process when running BitBake. If 6451 during the initial sanity checking process when running BitBake. If
6452 any of the utilities are not installed on the build host, then 6452 any of the utilities are not installed on the build host, then
6453 BitBake immediately exits with an error. 6453 BitBake immediately exits with an error.
6454 6454
6455 SANITY_TESTED_DISTROS 6455 :term:`SANITY_TESTED_DISTROS`
6456 A list of the host distribution identifiers that the build system has 6456 A list of the host distribution identifiers that the build system has
6457 been tested against. Identifiers consist of the host distributor ID 6457 been tested against. Identifiers consist of the host distributor ID
6458 followed by the release, as reported by the ``lsb_release`` tool or 6458 followed by the release, as reported by the ``lsb_release`` tool or
@@ -6463,11 +6463,11 @@ system and gives an overview of their function and contents.
6463 list, then the build system reports a warning that indicates the 6463 list, then the build system reports a warning that indicates the
6464 current host distribution has not been tested as a build host. 6464 current host distribution has not been tested as a build host.
6465 6465
6466 SDK_ARCH 6466 :term:`SDK_ARCH`
6467 The target architecture for the SDK. Typically, you do not directly 6467 The target architecture for the SDK. Typically, you do not directly
6468 set this variable. Instead, use :term:`SDKMACHINE`. 6468 set this variable. Instead, use :term:`SDKMACHINE`.
6469 6469
6470 SDK_DEPLOY 6470 :term:`SDK_DEPLOY`
6471 The directory set up and used by the 6471 The directory set up and used by the
6472 :ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which 6472 :ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which
6473 the SDK is deployed. The ``populate_sdk_base`` class defines 6473 the SDK is deployed. The ``populate_sdk_base`` class defines
@@ -6476,7 +6476,7 @@ system and gives an overview of their function and contents.
6476 6476
6477 SDK_DEPLOY = "${TMPDIR}/deploy/sdk" 6477 SDK_DEPLOY = "${TMPDIR}/deploy/sdk"
6478 6478
6479 SDK_DIR 6479 :term:`SDK_DIR`
6480 The parent directory used by the OpenEmbedded build system when 6480 The parent directory used by the OpenEmbedded build system when
6481 creating SDK output. The 6481 creating SDK output. The
6482 :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class defines 6482 :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class defines
@@ -6495,7 +6495,7 @@ system and gives an overview of their function and contents.
6495 SDK_DEPLOY 6495 SDK_DEPLOY
6496 . 6496 .
6497 6497
6498 SDK_EXT_TYPE 6498 :term:`SDK_EXT_TYPE`
6499 Controls whether or not shared state artifacts are copied into the 6499 Controls whether or not shared state artifacts are copied into the
6500 extensible SDK. The default value of "full" copies all of the 6500 extensible SDK. The default value of "full" copies all of the
6501 required shared state artifacts into the extensible SDK. The value 6501 required shared state artifacts into the extensible SDK. The value
@@ -6508,7 +6508,7 @@ system and gives an overview of their function and contents.
6508 is set in the SDK's configuration to enable the artifacts to be 6508 is set in the SDK's configuration to enable the artifacts to be
6509 fetched as needed. 6509 fetched as needed.
6510 6510
6511 SDK_HOST_MANIFEST 6511 :term:`SDK_HOST_MANIFEST`
6512 The manifest file for the host part of the SDK. This file lists all 6512 The manifest file for the host part of the SDK. This file lists all
6513 the installed packages that make up the host part of the SDK. The 6513 the installed packages that make up the host part of the SDK. The
6514 file contains package information on a line-per-package basis as 6514 file contains package information on a line-per-package basis as
@@ -6526,7 +6526,7 @@ system and gives an overview of their function and contents.
6526 The location is derived using the :term:`SDK_DEPLOY` and 6526 The location is derived using the :term:`SDK_DEPLOY` and
6527 :term:`TOOLCHAIN_OUTPUTNAME` variables. 6527 :term:`TOOLCHAIN_OUTPUTNAME` variables.
6528 6528
6529 SDK_INCLUDE_PKGDATA 6529 :term:`SDK_INCLUDE_PKGDATA`
6530 When set to "1", specifies to include the packagedata for all recipes 6530 When set to "1", specifies to include the packagedata for all recipes
6531 in the "world" target in the extensible SDK. Including this data 6531 in the "world" target in the extensible SDK. Including this data
6532 allows the ``devtool search`` command to find these recipes in search 6532 allows the ``devtool search`` command to find these recipes in search
@@ -6541,7 +6541,7 @@ system and gives an overview of their function and contents.
6541 needs to be built. Enabling the variable also slightly increases 6541 needs to be built. Enabling the variable also slightly increases
6542 the size of the extensible SDK. 6542 the size of the extensible SDK.
6543 6543
6544 SDK_INCLUDE_TOOLCHAIN 6544 :term:`SDK_INCLUDE_TOOLCHAIN`
6545 When set to "1", specifies to include the toolchain in the extensible 6545 When set to "1", specifies to include the toolchain in the extensible
6546 SDK. Including the toolchain is useful particularly when 6546 SDK. Including the toolchain is useful particularly when
6547 :term:`SDK_EXT_TYPE` is set to "minimal" to keep 6547 :term:`SDK_EXT_TYPE` is set to "minimal" to keep
@@ -6554,7 +6554,7 @@ system and gives an overview of their function and contents.
6554 ``SDK_EXT_TYPE`` is set to "minimal", and defaults to "1" if 6554 ``SDK_EXT_TYPE`` is set to "minimal", and defaults to "1" if
6555 ``SDK_EXT_TYPE`` is set to "full". 6555 ``SDK_EXT_TYPE`` is set to "full".
6556 6556
6557 SDK_INHERIT_BLACKLIST 6557 :term:`SDK_INHERIT_BLACKLIST`
6558 A list of classes to remove from the :term:`INHERIT` 6558 A list of classes to remove from the :term:`INHERIT`
6559 value globally within the extensible SDK configuration. The 6559 value globally within the extensible SDK configuration. The
6560 :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the 6560 :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the
@@ -6572,7 +6572,7 @@ system and gives an overview of their function and contents.
6572 section in the Yocto Project Application Development and the 6572 section in the Yocto Project Application Development and the
6573 Extensible Software Development Kit (eSDK) manual. 6573 Extensible Software Development Kit (eSDK) manual.
6574 6574
6575 SDK_LOCAL_CONF_BLACKLIST 6575 :term:`SDK_LOCAL_CONF_BLACKLIST`
6576 A list of variables not allowed through from the OpenEmbedded build 6576 A list of variables not allowed through from the OpenEmbedded build
6577 system configuration into the extensible SDK configuration. Usually, 6577 system configuration into the extensible SDK configuration. Usually,
6578 these are variables that are specific to the machine on which the 6578 these are variables that are specific to the machine on which the
@@ -6598,7 +6598,7 @@ system and gives an overview of their function and contents.
6598 section in the Yocto Project Application Development and the 6598 section in the Yocto Project Application Development and the
6599 Extensible Software Development Kit (eSDK) manual. 6599 Extensible Software Development Kit (eSDK) manual.
6600 6600
6601 SDK_LOCAL_CONF_WHITELIST 6601 :term:`SDK_LOCAL_CONF_WHITELIST`
6602 A list of variables allowed through from the OpenEmbedded build 6602 A list of variables allowed through from the OpenEmbedded build
6603 system configuration into the extensible SDK configuration. By 6603 system configuration into the extensible SDK configuration. By
6604 default, the list of variables is empty and is set in the 6604 default, the list of variables is empty and is set in the
@@ -6617,7 +6617,7 @@ system and gives an overview of their function and contents.
6617 section in the Yocto Project Application Development and the 6617 section in the Yocto Project Application Development and the
6618 Extensible Software Development Kit (eSDK) manual. 6618 Extensible Software Development Kit (eSDK) manual.
6619 6619
6620 SDK_NAME 6620 :term:`SDK_NAME`
6621 The base name for SDK output files. The name is derived from the 6621 The base name for SDK output files. The name is derived from the
6622 :term:`DISTRO`, :term:`TCLIBC`, 6622 :term:`DISTRO`, :term:`TCLIBC`,
6623 :term:`SDK_ARCH`, 6623 :term:`SDK_ARCH`,
@@ -6627,11 +6627,11 @@ system and gives an overview of their function and contents.
6627 6627
6628 SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}" 6628 SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}"
6629 6629
6630 SDK_OS 6630 :term:`SDK_OS`
6631 Specifies the operating system for which the SDK will be built. The 6631 Specifies the operating system for which the SDK will be built. The
6632 default value is the value of :term:`BUILD_OS`. 6632 default value is the value of :term:`BUILD_OS`.
6633 6633
6634 SDK_OUTPUT 6634 :term:`SDK_OUTPUT`
6635 The location used by the OpenEmbedded build system when creating SDK 6635 The location used by the OpenEmbedded build system when creating SDK
6636 output. The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` 6636 output. The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>`
6637 class defines the variable as follows: 6637 class defines the variable as follows:
@@ -6647,14 +6647,14 @@ system and gives an overview of their function and contents.
6647 WORKDIR by way of SDK_DIR. The final output directory is 6647 WORKDIR by way of SDK_DIR. The final output directory is
6648 SDK_DEPLOY. 6648 SDK_DEPLOY.
6649 6649
6650 SDK_PACKAGE_ARCHS 6650 :term:`SDK_PACKAGE_ARCHS`
6651 Specifies a list of architectures compatible with the SDK machine. 6651 Specifies a list of architectures compatible with the SDK machine.
6652 This variable is set automatically and should not normally be 6652 This variable is set automatically and should not normally be
6653 hand-edited. Entries are separated using spaces and listed in order 6653 hand-edited. Entries are separated using spaces and listed in order
6654 of priority. The default value for ``SDK_PACKAGE_ARCHS`` is "all any 6654 of priority. The default value for ``SDK_PACKAGE_ARCHS`` is "all any
6655 noarch ${SDK_ARCH}-${SDKPKGSUFFIX}". 6655 noarch ${SDK_ARCH}-${SDKPKGSUFFIX}".
6656 6656
6657 SDK_POSTPROCESS_COMMAND 6657 :term:`SDK_POSTPROCESS_COMMAND`
6658 Specifies a list of functions to call once the OpenEmbedded build 6658 Specifies a list of functions to call once the OpenEmbedded build
6659 system creates the SDK. You can specify functions separated by 6659 system creates the SDK. You can specify functions separated by
6660 semicolons: SDK_POSTPROCESS_COMMAND += "function; ... " 6660 semicolons: SDK_POSTPROCESS_COMMAND += "function; ... "
@@ -6664,13 +6664,13 @@ system and gives an overview of their function and contents.
6664 the OpenEmbedded build system when creating SDK output. See the 6664 the OpenEmbedded build system when creating SDK output. See the
6665 :term:`SDK_DIR` variable for more information. 6665 :term:`SDK_DIR` variable for more information.
6666 6666
6667 SDK_PREFIX 6667 :term:`SDK_PREFIX`
6668 The toolchain binary prefix used for ``nativesdk`` recipes. The 6668 The toolchain binary prefix used for ``nativesdk`` recipes. The
6669 OpenEmbedded build system uses the ``SDK_PREFIX`` value to set the 6669 OpenEmbedded build system uses the ``SDK_PREFIX`` value to set the
6670 :term:`TARGET_PREFIX` when building 6670 :term:`TARGET_PREFIX` when building
6671 ``nativesdk`` recipes. The default value is "${SDK_SYS}-". 6671 ``nativesdk`` recipes. The default value is "${SDK_SYS}-".
6672 6672
6673 SDK_RECRDEP_TASKS 6673 :term:`SDK_RECRDEP_TASKS`
6674 A list of shared state tasks added to the extensible SDK. By default, 6674 A list of shared state tasks added to the extensible SDK. By default,
6675 the following tasks are added: 6675 the following tasks are added:
6676 6676
@@ -6686,7 +6686,7 @@ system and gives an overview of their function and contents.
6686 tasks that are needed in order to build 6686 tasks that are needed in order to build
6687 :term:`SDK_TARGETS`). 6687 :term:`SDK_TARGETS`).
6688 6688
6689 SDK_SYS 6689 :term:`SDK_SYS`
6690 Specifies the system, including the architecture and the operating 6690 Specifies the system, including the architecture and the operating
6691 system, for which the SDK will be built. 6691 system, for which the SDK will be built.
6692 6692
@@ -6696,7 +6696,7 @@ system and gives an overview of their function and contents.
6696 :term:`SDK_OS`. You do not need to set the ``SDK_SYS`` 6696 :term:`SDK_OS`. You do not need to set the ``SDK_SYS``
6697 variable yourself. 6697 variable yourself.
6698 6698
6699 SDK_TARGET_MANIFEST 6699 :term:`SDK_TARGET_MANIFEST`
6700 The manifest file for the target part of the SDK. This file lists all 6700 The manifest file for the target part of the SDK. This file lists all
6701 the installed packages that make up the target part of the SDK. The 6701 the installed packages that make up the target part of the SDK. The
6702 file contains package information on a line-per-package basis as 6702 file contains package information on a line-per-package basis as
@@ -6714,7 +6714,7 @@ system and gives an overview of their function and contents.
6714 The location is derived using the :term:`SDK_DEPLOY` and 6714 The location is derived using the :term:`SDK_DEPLOY` and
6715 :term:`TOOLCHAIN_OUTPUTNAME` variables. 6715 :term:`TOOLCHAIN_OUTPUTNAME` variables.
6716 6716
6717 SDK_TARGETS 6717 :term:`SDK_TARGETS`
6718 A list of targets to install from shared state as part of the 6718 A list of targets to install from shared state as part of the
6719 standard or extensible SDK installation. The default value is "${PN}" 6719 standard or extensible SDK installation. The default value is "${PN}"
6720 (i.e. the image from which the SDK is built). 6720 (i.e. the image from which the SDK is built).
@@ -6722,7 +6722,7 @@ system and gives an overview of their function and contents.
6722 The ``SDK_TARGETS`` variable is an internal variable and typically 6722 The ``SDK_TARGETS`` variable is an internal variable and typically
6723 would not be changed. 6723 would not be changed.
6724 6724
6725 SDK_TITLE 6725 :term:`SDK_TITLE`
6726 The title to be printed when running the SDK installer. By default, 6726 The title to be printed when running the SDK installer. By default,
6727 this title is based on the :term:`DISTRO_NAME` or 6727 this title is based on the :term:`DISTRO_NAME` or
6728 :term:`DISTRO` variable and is set in the 6728 :term:`DISTRO` variable and is set in the
@@ -6740,15 +6740,15 @@ system and gives an overview of their function and contents.
6740 section in the Yocto Project Application Development and the 6740 section in the Yocto Project Application Development and the
6741 Extensible Software Development Kit (eSDK) manual. 6741 Extensible Software Development Kit (eSDK) manual.
6742 6742
6743 SDK_UPDATE_URL 6743 :term:`SDK_UPDATE_URL`
6744 An optional URL for an update server for the extensible SDK. If set, 6744 An optional URL for an update server for the extensible SDK. If set,
6745 the value is used as the default update server when running 6745 the value is used as the default update server when running
6746 ``devtool sdk-update`` within the extensible SDK. 6746 ``devtool sdk-update`` within the extensible SDK.
6747 6747
6748 SDK_VENDOR 6748 :term:`SDK_VENDOR`
6749 Specifies the name of the SDK vendor. 6749 Specifies the name of the SDK vendor.
6750 6750
6751 SDK_VERSION 6751 :term:`SDK_VERSION`
6752 Specifies the version of the SDK. The distribution configuration file 6752 Specifies the version of the SDK. The distribution configuration file
6753 (e.g. ``/meta-poky/conf/distro/poky.conf``) defines the 6753 (e.g. ``/meta-poky/conf/distro/poky.conf``) defines the
6754 ``SDK_VERSION`` as follows: 6754 ``SDK_VERSION`` as follows:
@@ -6760,7 +6760,7 @@ system and gives an overview of their function and contents.
6760 :term:`DISTRO_VERSION` and 6760 :term:`DISTRO_VERSION` and
6761 :term:`DATE` variables. 6761 :term:`DATE` variables.
6762 6762
6763 SDKEXTPATH 6763 :term:`SDKEXTPATH`
6764 The default installation directory for the Extensible SDK. By 6764 The default installation directory for the Extensible SDK. By
6765 default, this directory is based on the :term:`DISTRO` 6765 default, this directory is based on the :term:`DISTRO`
6766 variable and is set in the 6766 variable and is set in the
@@ -6778,14 +6778,14 @@ system and gives an overview of their function and contents.
6778 section in the Yocto Project Application Development and the 6778 section in the Yocto Project Application Development and the
6779 Extensible Software Development Kit (eSDK) manual. 6779 Extensible Software Development Kit (eSDK) manual.
6780 6780
6781 SDKIMAGE_FEATURES 6781 :term:`SDKIMAGE_FEATURES`
6782 Equivalent to ``IMAGE_FEATURES``. However, this variable applies to 6782 Equivalent to ``IMAGE_FEATURES``. However, this variable applies to
6783 the SDK generated from an image using the following command: 6783 the SDK generated from an image using the following command:
6784 :: 6784 ::
6785 6785
6786 $ bitbake -c populate_sdk imagename 6786 $ bitbake -c populate_sdk imagename
6787 6787
6788 SDKMACHINE 6788 :term:`SDKMACHINE`
6789 The machine for which the SDK is built. In other words, the SDK is 6789 The machine for which the SDK is built. In other words, the SDK is
6790 built such that it runs on the target you specify with the 6790 built such that it runs on the target you specify with the
6791 ``SDKMACHINE`` value. The value points to a corresponding ``.conf`` 6791 ``SDKMACHINE`` value. The value points to a corresponding ``.conf``
@@ -6805,23 +6805,23 @@ system and gives an overview of their function and contents.
6805 variable in your distribution configuration file. If you do, the 6805 variable in your distribution configuration file. If you do, the
6806 configuration will not take affect. 6806 configuration will not take affect.
6807 6807
6808 SDKPATH 6808 :term:`SDKPATH`
6809 Defines the path offered to the user for installation of the SDK that 6809 Defines the path offered to the user for installation of the SDK that
6810 is generated by the OpenEmbedded build system. The path appears as 6810 is generated by the OpenEmbedded build system. The path appears as
6811 the default location for installing the SDK when you run the SDK's 6811 the default location for installing the SDK when you run the SDK's
6812 installation script. You can override the offered path when you run 6812 installation script. You can override the offered path when you run
6813 the script. 6813 the script.
6814 6814
6815 SDKTARGETSYSROOT 6815 :term:`SDKTARGETSYSROOT`
6816 The full path to the sysroot used for cross-compilation within an SDK 6816 The full path to the sysroot used for cross-compilation within an SDK
6817 as it will be when installed into the default 6817 as it will be when installed into the default
6818 :term:`SDKPATH`. 6818 :term:`SDKPATH`.
6819 6819
6820 SECTION 6820 :term:`SECTION`
6821 The section in which packages should be categorized. Package 6821 The section in which packages should be categorized. Package
6822 management utilities can make use of this variable. 6822 management utilities can make use of this variable.
6823 6823
6824 SELECTED_OPTIMIZATION 6824 :term:`SELECTED_OPTIMIZATION`
6825 Specifies the optimization flags passed to the C compiler when 6825 Specifies the optimization flags passed to the C compiler when
6826 building for the target. The flags are passed through the default 6826 building for the target. The flags are passed through the default
6827 value of the :term:`TARGET_CFLAGS` variable. 6827 value of the :term:`TARGET_CFLAGS` variable.
@@ -6830,7 +6830,7 @@ system and gives an overview of their function and contents.
6830 ``FULL_OPTIMIZATION`` unless ``DEBUG_BUILD`` = "1". If that is the 6830 ``FULL_OPTIMIZATION`` unless ``DEBUG_BUILD`` = "1". If that is the
6831 case, the value of ``DEBUG_OPTIMIZATION`` is used. 6831 case, the value of ``DEBUG_OPTIMIZATION`` is used.
6832 6832
6833 SERIAL_CONSOLE 6833 :term:`SERIAL_CONSOLE`
6834 Defines a serial console (TTY) to enable using 6834 Defines a serial console (TTY) to enable using
6835 `getty <https://en.wikipedia.org/wiki/Getty_(Unix)>`__. Provide a 6835 `getty <https://en.wikipedia.org/wiki/Getty_(Unix)>`__. Provide a
6836 value that specifies the baud rate followed by the TTY device name 6836 value that specifies the baud rate followed by the TTY device name
@@ -6847,7 +6847,7 @@ system and gives an overview of their function and contents.
6847 SERIAL_CONSOLES 6847 SERIAL_CONSOLES
6848 variable. 6848 variable.
6849 6849
6850 SERIAL_CONSOLES 6850 :term:`SERIAL_CONSOLES`
6851 Defines a serial console (TTY) to enable using 6851 Defines a serial console (TTY) to enable using
6852 `getty <https://en.wikipedia.org/wiki/Getty_(Unix)>`__. Provide a 6852 `getty <https://en.wikipedia.org/wiki/Getty_(Unix)>`__. Provide a
6853 value that specifies the baud rate followed by the TTY device name 6853 value that specifies the baud rate followed by the TTY device name
@@ -6856,7 +6856,7 @@ system and gives an overview of their function and contents.
6856 6856
6857 SERIAL_CONSOLES = "115200;ttyS0 115200;ttyS1" 6857 SERIAL_CONSOLES = "115200;ttyS0 115200;ttyS1"
6858 6858
6859 SERIAL_CONSOLES_CHECK 6859 :term:`SERIAL_CONSOLES_CHECK`
6860 Specifies serial consoles, which must be listed in 6860 Specifies serial consoles, which must be listed in
6861 :term:`SERIAL_CONSOLES`, to check against 6861 :term:`SERIAL_CONSOLES`, to check against
6862 ``/proc/console`` before enabling them using getty. This variable 6862 ``/proc/console`` before enabling them using getty. This variable
@@ -6869,7 +6869,7 @@ system and gives an overview of their function and contents.
6869 This variable is currently only supported with SysVinit (i.e. not 6869 This variable is currently only supported with SysVinit (i.e. not
6870 with systemd). 6870 with systemd).
6871 6871
6872 SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS 6872 :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS`
6873 A list of recipe dependencies that should not be used to determine 6873 A list of recipe dependencies that should not be used to determine
6874 signatures of tasks from one recipe when they depend on tasks from 6874 signatures of tasks from one recipe when they depend on tasks from
6875 another recipe. For example: :: 6875 another recipe. For example: ::
@@ -6897,7 +6897,7 @@ system and gives an overview of their function and contents.
6897 the software might break during runtime if the interface of the 6897 the software might break during runtime if the interface of the
6898 second recipe was changed after the first recipe had been built. 6898 second recipe was changed after the first recipe had been built.
6899 6899
6900 SIGGEN_EXCLUDERECIPES_ABISAFE 6900 :term:`SIGGEN_EXCLUDERECIPES_ABISAFE`
6901 A list of recipes that are completely stable and will never change. 6901 A list of recipes that are completely stable and will never change.
6902 The ABI for the recipes in the list are presented by output from the 6902 The ABI for the recipes in the list are presented by output from the
6903 tasks run to build the recipe. Use of this variable is one way to 6903 tasks run to build the recipe. Use of this variable is one way to
@@ -6910,15 +6910,15 @@ system and gives an overview of their function and contents.
6910 might break at runtime if the interface of the recipe was changed 6910 might break at runtime if the interface of the recipe was changed
6911 after the other had been built. 6911 after the other had been built.
6912 6912
6913 SITEINFO_BITS 6913 :term:`SITEINFO_BITS`
6914 Specifies the number of bits for the target system CPU. The value 6914 Specifies the number of bits for the target system CPU. The value
6915 should be either "32" or "64". 6915 should be either "32" or "64".
6916 6916
6917 SITEINFO_ENDIANNESS 6917 :term:`SITEINFO_ENDIANNESS`
6918 Specifies the endian byte order of the target system. The value 6918 Specifies the endian byte order of the target system. The value
6919 should be either "le" for little-endian or "be" for big-endian. 6919 should be either "le" for little-endian or "be" for big-endian.
6920 6920
6921 SKIP_FILEDEPS 6921 :term:`SKIP_FILEDEPS`
6922 Enables removal of all files from the "Provides" section of an RPM 6922 Enables removal of all files from the "Provides" section of an RPM
6923 package. Removal of these files is required for packages containing 6923 package. Removal of these files is required for packages containing
6924 prebuilt binaries and libraries such as ``libstdc++`` and ``glibc``. 6924 prebuilt binaries and libraries such as ``libstdc++`` and ``glibc``.
@@ -6930,7 +6930,7 @@ system and gives an overview of their function and contents.
6930 6930
6931 SKIP_FILEDEPS = "1" 6931 SKIP_FILEDEPS = "1"
6932 6932
6933 SOC_FAMILY 6933 :term:`SOC_FAMILY`
6934 Groups together machines based upon the same family of SOC (System On 6934 Groups together machines based upon the same family of SOC (System On
6935 Chip). You typically set this variable in a common ``.inc`` file that 6935 Chip). You typically set this variable in a common ``.inc`` file that
6936 you include in the configuration files of all the machines. 6936 you include in the configuration files of all the machines.
@@ -6943,7 +6943,7 @@ system and gives an overview of their function and contents.
6943 MACHINEOVERRIDES 6943 MACHINEOVERRIDES
6944 . 6944 .
6945 6945
6946 SOLIBS 6946 :term:`SOLIBS`
6947 Defines the suffix for shared libraries used on the target platform. 6947 Defines the suffix for shared libraries used on the target platform.
6948 By default, this suffix is ".so.*" for all Linux-based systems and is 6948 By default, this suffix is ".so.*" for all Linux-based systems and is
6949 defined in the ``meta/conf/bitbake.conf`` configuration file. 6949 defined in the ``meta/conf/bitbake.conf`` configuration file.
@@ -6951,7 +6951,7 @@ system and gives an overview of their function and contents.
6951 You will see this variable referenced in the default values of 6951 You will see this variable referenced in the default values of
6952 ``FILES_${PN}``. 6952 ``FILES_${PN}``.
6953 6953
6954 SOLIBSDEV 6954 :term:`SOLIBSDEV`
6955 Defines the suffix for the development symbolic link (symlink) for 6955 Defines the suffix for the development symbolic link (symlink) for
6956 shared libraries on the target platform. By default, this suffix is 6956 shared libraries on the target platform. By default, this suffix is
6957 ".so" for Linux-based systems and is defined in the 6957 ".so" for Linux-based systems and is defined in the
@@ -6960,7 +6960,7 @@ system and gives an overview of their function and contents.
6960 You will see this variable referenced in the default values of 6960 You will see this variable referenced in the default values of
6961 ``FILES_${PN}-dev``. 6961 ``FILES_${PN}-dev``.
6962 6962
6963 SOURCE_MIRROR_FETCH 6963 :term:`SOURCE_MIRROR_FETCH`
6964 When you are fetching files to create a mirror of sources (i.e. 6964 When you are fetching files to create a mirror of sources (i.e.
6965 creating a source mirror), setting ``SOURCE_MIRROR_FETCH`` to "1" in 6965 creating a source mirror), setting ``SOURCE_MIRROR_FETCH`` to "1" in
6966 your ``local.conf`` configuration file ensures the source for all 6966 your ``local.conf`` configuration file ensures the source for all
@@ -6979,7 +6979,7 @@ system and gives an overview of their function and contents.
6979 variable unless you are creating a source mirror. In other words, 6979 variable unless you are creating a source mirror. In other words,
6980 do not set the variable during a normal build. 6980 do not set the variable during a normal build.
6981 6981
6982 SOURCE_MIRROR_URL 6982 :term:`SOURCE_MIRROR_URL`
6983 Defines your own :term:`PREMIRRORS` from which to 6983 Defines your own :term:`PREMIRRORS` from which to
6984 first fetch source before attempting to fetch from the upstream 6984 first fetch source before attempting to fetch from the upstream
6985 specified in :term:`SRC_URI`. 6985 specified in :term:`SRC_URI`.
@@ -6998,7 +6998,7 @@ system and gives an overview of their function and contents.
6998 SOURCE_MIRROR_URL 6998 SOURCE_MIRROR_URL
6999 . 6999 .
7000 7000
7001 SPDXLICENSEMAP 7001 :term:`SPDXLICENSEMAP`
7002 Maps commonly used license names to their SPDX counterparts found in 7002 Maps commonly used license names to their SPDX counterparts found in
7003 ``meta/files/common-licenses/``. For the default ``SPDXLICENSEMAP`` 7003 ``meta/files/common-licenses/``. For the default ``SPDXLICENSEMAP``
7004 mappings, see the ``meta/conf/licenses.conf`` file. 7004 mappings, see the ``meta/conf/licenses.conf`` file.
@@ -7006,13 +7006,13 @@ system and gives an overview of their function and contents.
7006 For additional information, see the :term:`LICENSE` 7006 For additional information, see the :term:`LICENSE`
7007 variable. 7007 variable.
7008 7008
7009 SPECIAL_PKGSUFFIX 7009 :term:`SPECIAL_PKGSUFFIX`
7010 A list of prefixes for :term:`PN` used by the OpenEmbedded 7010 A list of prefixes for :term:`PN` used by the OpenEmbedded
7011 build system to create variants of recipes or packages. The list 7011 build system to create variants of recipes or packages. The list
7012 specifies the prefixes to strip off during certain circumstances such 7012 specifies the prefixes to strip off during certain circumstances such
7013 as the generation of the :term:`BPN` variable. 7013 as the generation of the :term:`BPN` variable.
7014 7014
7015 SPL_BINARY 7015 :term:`SPL_BINARY`
7016 The file type for the Secondary Program Loader (SPL). Some devices 7016 The file type for the Secondary Program Loader (SPL). Some devices
7017 use an SPL from which to boot (e.g. the BeagleBone development 7017 use an SPL from which to boot (e.g. the BeagleBone development
7018 board). For such cases, you can declare the file type of the SPL 7018 board). For such cases, you can declare the file type of the SPL
@@ -7040,7 +7040,7 @@ system and gives an overview of their function and contents.
7040 section in the Yocto Project Board Support Package Developer's Guide 7040 section in the Yocto Project Board Support Package Developer's Guide
7041 for additional information. 7041 for additional information.
7042 7042
7043 SRC_URI 7043 :term:`SRC_URI`
7044 The list of source files - local or remote. This variable tells the 7044 The list of source files - local or remote. This variable tells the
7045 OpenEmbedded build system which bits to pull in for the build and how 7045 OpenEmbedded build system which bits to pull in for the build and how
7046 to pull them in. For example, if the recipe or append file only needs 7046 to pull them in. For example, if the recipe or append file only needs
@@ -7183,18 +7183,18 @@ system and gives an overview of their function and contents.
7183 - ``downloadfilename`` - Specifies the filename used when storing 7183 - ``downloadfilename`` - Specifies the filename used when storing
7184 the downloaded file. 7184 the downloaded file.
7185 7185
7186 SRC_URI_OVERRIDES_PACKAGE_ARCH 7186 :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH`
7187 By default, the OpenEmbedded build system automatically detects 7187 By default, the OpenEmbedded build system automatically detects
7188 whether ``SRC_URI`` contains files that are machine-specific. If so, 7188 whether ``SRC_URI`` contains files that are machine-specific. If so,
7189 the build system automatically changes ``PACKAGE_ARCH``. Setting this 7189 the build system automatically changes ``PACKAGE_ARCH``. Setting this
7190 variable to "0" disables this behavior. 7190 variable to "0" disables this behavior.
7191 7191
7192 SRCDATE 7192 :term:`SRCDATE`
7193 The date of the source code used to build the package. This variable 7193 The date of the source code used to build the package. This variable
7194 applies only if the source was fetched from a Source Code Manager 7194 applies only if the source was fetched from a Source Code Manager
7195 (SCM). 7195 (SCM).
7196 7196
7197 SRCPV 7197 :term:`SRCPV`
7198 Returns the version string of the current package. This string is 7198 Returns the version string of the current package. This string is
7199 used to help define the value of :term:`PV`. 7199 used to help define the value of :term:`PV`.
7200 7200
@@ -7213,7 +7213,7 @@ system and gives an overview of their function and contents.
7213 7213
7214 PV = "0.12-git${SRCPV}" 7214 PV = "0.12-git${SRCPV}"
7215 7215
7216 SRCREV 7216 :term:`SRCREV`
7217 The revision of the source code used to build the package. This 7217 The revision of the source code used to build the package. This
7218 variable applies to Subversion, Git, Mercurial, and Bazaar only. Note 7218 variable applies to Subversion, Git, Mercurial, and Bazaar only. Note
7219 that if you want to build a fixed revision and you want to avoid 7219 that if you want to build a fixed revision and you want to avoid
@@ -7232,10 +7232,10 @@ system and gives an overview of their function and contents.
7232 Automatically Incrementing a Binary Package Revision Number 7232 Automatically Incrementing a Binary Package Revision Number
7233 " section, which is in the Yocto Project Development Tasks Manual. 7233 " section, which is in the Yocto Project Development Tasks Manual.
7234 7234
7235 SSTATE_DIR 7235 :term:`SSTATE_DIR`
7236 The directory for the shared state cache. 7236 The directory for the shared state cache.
7237 7237
7238 SSTATE_MIRROR_ALLOW_NETWORK 7238 :term:`SSTATE_MIRROR_ALLOW_NETWORK`
7239 If set to "1", allows fetches from mirrors that are specified in 7239 If set to "1", allows fetches from mirrors that are specified in
7240 :term:`SSTATE_MIRRORS` to work even when 7240 :term:`SSTATE_MIRRORS` to work even when
7241 fetching from the network is disabled by setting ``BB_NO_NETWORK`` to 7241 fetching from the network is disabled by setting ``BB_NO_NETWORK`` to
@@ -7244,7 +7244,7 @@ system and gives an overview of their function and contents.
7244 your shared state cache, but you want to disable any other fetching 7244 your shared state cache, but you want to disable any other fetching
7245 from the network. 7245 from the network.
7246 7246
7247 SSTATE_MIRRORS 7247 :term:`SSTATE_MIRRORS`
7248 Configures the OpenEmbedded build system to search other mirror 7248 Configures the OpenEmbedded build system to search other mirror
7249 locations for prebuilt cache data objects before building out the 7249 locations for prebuilt cache data objects before building out the
7250 data. This variable works like fetcher :term:`MIRRORS` 7250 data. This variable works like fetcher :term:`MIRRORS`
@@ -7278,7 +7278,7 @@ system and gives an overview of their function and contents.
7278 file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \ 7278 file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \
7279 file://.* file:///some-local-dir/sstate/PATH" 7279 file://.* file:///some-local-dir/sstate/PATH"
7280 7280
7281 SSTATE_SCAN_FILES 7281 :term:`SSTATE_SCAN_FILES`
7282 Controls the list of files the OpenEmbedded build system scans for 7282 Controls the list of files the OpenEmbedded build system scans for
7283 hardcoded installation paths. The variable uses a space-separated 7283 hardcoded installation paths. The variable uses a space-separated
7284 list of filenames (not paths) with standard wildcard characters 7284 list of filenames (not paths) with standard wildcard characters
@@ -7297,21 +7297,21 @@ system and gives an overview of their function and contents.
7297 For details on the process, see the 7297 For details on the process, see the
7298 :ref:`staging <ref-classes-staging>` class. 7298 :ref:`staging <ref-classes-staging>` class.
7299 7299
7300 STAGING_BASE_LIBDIR_NATIVE 7300 :term:`STAGING_BASE_LIBDIR_NATIVE`
7301 Specifies the path to the ``/lib`` subdirectory of the sysroot 7301 Specifies the path to the ``/lib`` subdirectory of the sysroot
7302 directory for the build host. 7302 directory for the build host.
7303 7303
7304 STAGING_BASELIBDIR 7304 :term:`STAGING_BASELIBDIR`
7305 Specifies the path to the ``/lib`` subdirectory of the sysroot 7305 Specifies the path to the ``/lib`` subdirectory of the sysroot
7306 directory for the target for which the current recipe is being built 7306 directory for the target for which the current recipe is being built
7307 (:term:`STAGING_DIR_HOST`). 7307 (:term:`STAGING_DIR_HOST`).
7308 7308
7309 STAGING_BINDIR 7309 :term:`STAGING_BINDIR`
7310 Specifies the path to the ``/usr/bin`` subdirectory of the sysroot 7310 Specifies the path to the ``/usr/bin`` subdirectory of the sysroot
7311 directory for the target for which the current recipe is being built 7311 directory for the target for which the current recipe is being built
7312 (:term:`STAGING_DIR_HOST`). 7312 (:term:`STAGING_DIR_HOST`).
7313 7313
7314 STAGING_BINDIR_CROSS 7314 :term:`STAGING_BINDIR_CROSS`
7315 Specifies the path to the directory containing binary configuration 7315 Specifies the path to the directory containing binary configuration
7316 scripts. These scripts provide configuration information for other 7316 scripts. These scripts provide configuration information for other
7317 software that wants to make use of libraries or include files 7317 software that wants to make use of libraries or include files
@@ -7328,20 +7328,20 @@ system and gives an overview of their function and contents.
7328 pkg-config 7328 pkg-config
7329 instead of a provided configuration script. 7329 instead of a provided configuration script.
7330 7330
7331 STAGING_BINDIR_NATIVE 7331 :term:`STAGING_BINDIR_NATIVE`
7332 Specifies the path to the ``/usr/bin`` subdirectory of the sysroot 7332 Specifies the path to the ``/usr/bin`` subdirectory of the sysroot
7333 directory for the build host. 7333 directory for the build host.
7334 7334
7335 STAGING_DATADIR 7335 :term:`STAGING_DATADIR`
7336 Specifies the path to the ``/usr/share`` subdirectory of the sysroot 7336 Specifies the path to the ``/usr/share`` subdirectory of the sysroot
7337 directory for the target for which the current recipe is being built 7337 directory for the target for which the current recipe is being built
7338 (:term:`STAGING_DIR_HOST`). 7338 (:term:`STAGING_DIR_HOST`).
7339 7339
7340 STAGING_DATADIR_NATIVE 7340 :term:`STAGING_DATADIR_NATIVE`
7341 Specifies the path to the ``/usr/share`` subdirectory of the sysroot 7341 Specifies the path to the ``/usr/share`` subdirectory of the sysroot
7342 directory for the build host. 7342 directory for the build host.
7343 7343
7344 STAGING_DIR 7344 :term:`STAGING_DIR`
7345 Helps construct the ``recipe-sysroots`` directory, which is used 7345 Helps construct the ``recipe-sysroots`` directory, which is used
7346 during packaging. 7346 during packaging.
7347 7347
@@ -7367,7 +7367,7 @@ system and gives an overview of their function and contents.
7367 task and then the OpenEmbedded build system will stage a subset of 7367 task and then the OpenEmbedded build system will stage a subset of
7368 those files into the sysroot. 7368 those files into the sysroot.
7369 7369
7370 STAGING_DIR_HOST 7370 :term:`STAGING_DIR_HOST`
7371 Specifies the path to the sysroot directory for the system on which 7371 Specifies the path to the sysroot directory for the system on which
7372 the component is built to run (the system that hosts the component). 7372 the component is built to run (the system that hosts the component).
7373 For most recipes, this sysroot is the one in which that recipe's 7373 For most recipes, this sysroot is the one in which that recipe's
@@ -7405,11 +7405,11 @@ system and gives an overview of their function and contents.
7405 for ``-native`` recipes, as they make use of host headers and 7405 for ``-native`` recipes, as they make use of host headers and
7406 libraries. 7406 libraries.
7407 7407
7408 STAGING_DIR_NATIVE 7408 :term:`STAGING_DIR_NATIVE`
7409 Specifies the path to the sysroot directory used when building 7409 Specifies the path to the sysroot directory used when building
7410 components that run on the build host itself. 7410 components that run on the build host itself.
7411 7411
7412 STAGING_DIR_TARGET 7412 :term:`STAGING_DIR_TARGET`
7413 Specifies the path to the sysroot used for the system for which the 7413 Specifies the path to the sysroot used for the system for which the
7414 component generates code. For components that do not generate code, 7414 component generates code. For components that do not generate code,
7415 which is the majority, ``STAGING_DIR_TARGET`` is set to match 7415 which is the majority, ``STAGING_DIR_TARGET`` is set to match
@@ -7425,45 +7425,45 @@ system and gives an overview of their function and contents.
7425 for the "HOST" system, while ``STAGING_DIR_TARGET`` points to the 7425 for the "HOST" system, while ``STAGING_DIR_TARGET`` points to the
7426 sysroot used for the "TARGET" system. 7426 sysroot used for the "TARGET" system.
7427 7427
7428 STAGING_ETCDIR_NATIVE 7428 :term:`STAGING_ETCDIR_NATIVE`
7429 Specifies the path to the ``/etc`` subdirectory of the sysroot 7429 Specifies the path to the ``/etc`` subdirectory of the sysroot
7430 directory for the build host. 7430 directory for the build host.
7431 7431
7432 STAGING_EXECPREFIXDIR 7432 :term:`STAGING_EXECPREFIXDIR`
7433 Specifies the path to the ``/usr`` subdirectory of the sysroot 7433 Specifies the path to the ``/usr`` subdirectory of the sysroot
7434 directory for the target for which the current recipe is being built 7434 directory for the target for which the current recipe is being built
7435 (:term:`STAGING_DIR_HOST`). 7435 (:term:`STAGING_DIR_HOST`).
7436 7436
7437 STAGING_INCDIR 7437 :term:`STAGING_INCDIR`
7438 Specifies the path to the ``/usr/include`` subdirectory of the 7438 Specifies the path to the ``/usr/include`` subdirectory of the
7439 sysroot directory for the target for which the current recipe being 7439 sysroot directory for the target for which the current recipe being
7440 built (:term:`STAGING_DIR_HOST`). 7440 built (:term:`STAGING_DIR_HOST`).
7441 7441
7442 STAGING_INCDIR_NATIVE 7442 :term:`STAGING_INCDIR_NATIVE`
7443 Specifies the path to the ``/usr/include`` subdirectory of the 7443 Specifies the path to the ``/usr/include`` subdirectory of the
7444 sysroot directory for the build host. 7444 sysroot directory for the build host.
7445 7445
7446 STAGING_KERNEL_BUILDDIR 7446 :term:`STAGING_KERNEL_BUILDDIR`
7447 Points to the directory containing the kernel build artifacts. 7447 Points to the directory containing the kernel build artifacts.
7448 Recipes building software that needs to access kernel build artifacts 7448 Recipes building software that needs to access kernel build artifacts
7449 (e.g. ``systemtap-uprobes``) can look in the directory specified with 7449 (e.g. ``systemtap-uprobes``) can look in the directory specified with
7450 the ``STAGING_KERNEL_BUILDDIR`` variable to find these artifacts 7450 the ``STAGING_KERNEL_BUILDDIR`` variable to find these artifacts
7451 after the kernel has been built. 7451 after the kernel has been built.
7452 7452
7453 STAGING_KERNEL_DIR 7453 :term:`STAGING_KERNEL_DIR`
7454 The directory with kernel headers that are required to build 7454 The directory with kernel headers that are required to build
7455 out-of-tree modules. 7455 out-of-tree modules.
7456 7456
7457 STAGING_LIBDIR 7457 :term:`STAGING_LIBDIR`
7458 Specifies the path to the ``/usr/lib`` subdirectory of the sysroot 7458 Specifies the path to the ``/usr/lib`` subdirectory of the sysroot
7459 directory for the target for which the current recipe is being built 7459 directory for the target for which the current recipe is being built
7460 (:term:`STAGING_DIR_HOST`). 7460 (:term:`STAGING_DIR_HOST`).
7461 7461
7462 STAGING_LIBDIR_NATIVE 7462 :term:`STAGING_LIBDIR_NATIVE`
7463 Specifies the path to the ``/usr/lib`` subdirectory of the sysroot 7463 Specifies the path to the ``/usr/lib`` subdirectory of the sysroot
7464 directory for the build host. 7464 directory for the build host.
7465 7465
7466 STAMP 7466 :term:`STAMP`
7467 Specifies the base path used to create recipe stamp files. The path 7467 Specifies the base path used to create recipe stamp files. The path
7468 to an actual stamp file is constructed by evaluating this string and 7468 to an actual stamp file is constructed by evaluating this string and
7469 then appending additional information. Currently, the default 7469 then appending additional information. Currently, the default
@@ -7484,26 +7484,26 @@ system and gives an overview of their function and contents.
7484 :term:`PV`, and :term:`PR` for related variable 7484 :term:`PV`, and :term:`PR` for related variable
7485 information. 7485 information.
7486 7486
7487 STAMPS_DIR 7487 :term:`STAMPS_DIR`
7488 Specifies the base directory in which the OpenEmbedded build system 7488 Specifies the base directory in which the OpenEmbedded build system
7489 places stamps. The default directory is ``${TMPDIR}/stamps``. 7489 places stamps. The default directory is ``${TMPDIR}/stamps``.
7490 7490
7491 STRIP 7491 :term:`STRIP`
7492 The minimal command and arguments to run ``strip``, which is used to 7492 The minimal command and arguments to run ``strip``, which is used to
7493 strip symbols. 7493 strip symbols.
7494 7494
7495 SUMMARY 7495 :term:`SUMMARY`
7496 The short (72 characters or less) summary of the binary package for 7496 The short (72 characters or less) summary of the binary package for
7497 packaging systems such as ``opkg``, ``rpm``, or ``dpkg``. By default, 7497 packaging systems such as ``opkg``, ``rpm``, or ``dpkg``. By default,
7498 ``SUMMARY`` is used to define the 7498 ``SUMMARY`` is used to define the
7499 :term:`DESCRIPTION` variable if ``DESCRIPTION`` is 7499 :term:`DESCRIPTION` variable if ``DESCRIPTION`` is
7500 not set in the recipe. 7500 not set in the recipe.
7501 7501
7502 SVNDIR 7502 :term:`SVNDIR`
7503 The directory in which files checked out of a Subversion system are 7503 The directory in which files checked out of a Subversion system are
7504 stored. 7504 stored.
7505 7505
7506 SYSLINUX_DEFAULT_CONSOLE 7506 :term:`SYSLINUX_DEFAULT_CONSOLE`
7507 Specifies the kernel boot default console. If you want to use a 7507 Specifies the kernel boot default console. If you want to use a
7508 console other than the default, set this variable in your recipe as 7508 console other than the default, set this variable in your recipe as
7509 follows where "X" is the console number you want to use: 7509 follows where "X" is the console number you want to use:
@@ -7514,7 +7514,7 @@ system and gives an overview of their function and contents.
7514 The :ref:`syslinux <ref-classes-syslinux>` class initially sets 7514 The :ref:`syslinux <ref-classes-syslinux>` class initially sets
7515 this variable to null but then checks for a value later. 7515 this variable to null but then checks for a value later.
7516 7516
7517 SYSLINUX_OPTS 7517 :term:`SYSLINUX_OPTS`
7518 Lists additional options to add to the syslinux file. You need to set 7518 Lists additional options to add to the syslinux file. You need to set
7519 this variable in your recipe. If you want to list multiple options, 7519 this variable in your recipe. If you want to list multiple options,
7520 separate the options with a semicolon character (``;``). 7520 separate the options with a semicolon character (``;``).
@@ -7522,7 +7522,7 @@ system and gives an overview of their function and contents.
7522 The :ref:`syslinux <ref-classes-syslinux>` class uses this variable 7522 The :ref:`syslinux <ref-classes-syslinux>` class uses this variable
7523 to create a set of options. 7523 to create a set of options.
7524 7524
7525 SYSLINUX_SERIAL 7525 :term:`SYSLINUX_SERIAL`
7526 Specifies the alternate serial port or turns it off. To turn off 7526 Specifies the alternate serial port or turns it off. To turn off
7527 serial, set this variable to an empty string in your recipe. The 7527 serial, set this variable to an empty string in your recipe. The
7528 variable's default value is set in the 7528 variable's default value is set in the
@@ -7533,7 +7533,7 @@ system and gives an overview of their function and contents.
7533 7533
7534 The class checks for and uses the variable as needed. 7534 The class checks for and uses the variable as needed.
7535 7535
7536 SYSLINUX_SERIAL_TTY 7536 :term:`SYSLINUX_SERIAL_TTY`
7537 Specifies the alternate console=tty... kernel boot argument. The 7537 Specifies the alternate console=tty... kernel boot argument. The
7538 variable's default value is set in the 7538 variable's default value is set in the
7539 :ref:`syslinux <ref-classes-syslinux>` class as follows: 7539 :ref:`syslinux <ref-classes-syslinux>` class as follows:
@@ -7543,7 +7543,7 @@ system and gives an overview of their function and contents.
7543 7543
7544 The class checks for and uses the variable as needed. 7544 The class checks for and uses the variable as needed.
7545 7545
7546 SYSLINUX_SPLASH 7546 :term:`SYSLINUX_SPLASH`
7547 An ``.LSS`` file used as the background for the VGA boot menu when 7547 An ``.LSS`` file used as the background for the VGA boot menu when
7548 you use the boot menu. You need to set this variable in your recipe. 7548 you use the boot menu. You need to set this variable in your recipe.
7549 7549
@@ -7551,13 +7551,13 @@ system and gives an overview of their function and contents.
7551 variable and if found, the OpenEmbedded build system installs the 7551 variable and if found, the OpenEmbedded build system installs the
7552 splash screen. 7552 splash screen.
7553 7553
7554 SYSROOT_DESTDIR 7554 :term:`SYSROOT_DESTDIR`
7555 Points to the temporary directory under the work directory (default 7555 Points to the temporary directory under the work directory (default
7556 "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``") 7556 "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``")
7557 where the files populated into the sysroot are assembled during the 7557 where the files populated into the sysroot are assembled during the
7558 :ref:`ref-tasks-populate_sysroot` task. 7558 :ref:`ref-tasks-populate_sysroot` task.
7559 7559
7560 SYSROOT_DIRS 7560 :term:`SYSROOT_DIRS`
7561 Directories that are staged into the sysroot by the 7561 Directories that are staged into the sysroot by the
7562 :ref:`ref-tasks-populate_sysroot` task. By 7562 :ref:`ref-tasks-populate_sysroot` task. By
7563 default, the following directories are staged: 7563 default, the following directories are staged:
@@ -7571,7 +7571,7 @@ system and gives an overview of their function and contents.
7571 ${datadir} \ 7571 ${datadir} \
7572 " 7572 "
7573 7573
7574 SYSROOT_DIRS_BLACKLIST 7574 :term:`SYSROOT_DIRS_BLACKLIST`
7575 Directories that are not staged into the sysroot by the 7575 Directories that are not staged into the sysroot by the
7576 :ref:`ref-tasks-populate_sysroot` task. You 7576 :ref:`ref-tasks-populate_sysroot` task. You
7577 can use this variable to exclude certain subdirectories of 7577 can use this variable to exclude certain subdirectories of
@@ -7589,7 +7589,7 @@ system and gives an overview of their function and contents.
7589 ${datadir}/pixmaps \ 7589 ${datadir}/pixmaps \
7590 " 7590 "
7591 7591
7592 SYSROOT_DIRS_NATIVE 7592 :term:`SYSROOT_DIRS_NATIVE`
7593 Extra directories staged into the sysroot by the 7593 Extra directories staged into the sysroot by the
7594 :ref:`ref-tasks-populate_sysroot` task for 7594 :ref:`ref-tasks-populate_sysroot` task for
7595 ``-native`` recipes, in addition to those specified in 7595 ``-native`` recipes, in addition to those specified in
@@ -7616,12 +7616,12 @@ system and gives an overview of their function and contents.
7616 ), which is why additional directories containing program 7616 ), which is why additional directories containing program
7617 executables and supporting files need to be staged. 7617 executables and supporting files need to be staged.
7618 7618
7619 SYSROOT_PREPROCESS_FUNCS 7619 :term:`SYSROOT_PREPROCESS_FUNCS`
7620 A list of functions to execute after files are staged into the 7620 A list of functions to execute after files are staged into the
7621 sysroot. These functions are usually used to apply additional 7621 sysroot. These functions are usually used to apply additional
7622 processing on the staged files, or to stage additional files. 7622 processing on the staged files, or to stage additional files.
7623 7623
7624 SYSTEMD_AUTO_ENABLE 7624 :term:`SYSTEMD_AUTO_ENABLE`
7625 When inheriting the :ref:`systemd <ref-classes-systemd>` class, 7625 When inheriting the :ref:`systemd <ref-classes-systemd>` class,
7626 this variable specifies whether the specified service in 7626 this variable specifies whether the specified service in
7627 :term:`SYSTEMD_SERVICE` should start 7627 :term:`SYSTEMD_SERVICE` should start
@@ -7634,7 +7634,7 @@ system and gives an overview of their function and contents.
7634 7634
7635 You can disable the service by setting the variable to "disable". 7635 You can disable the service by setting the variable to "disable".
7636 7636
7637 SYSTEMD_BOOT_CFG 7637 :term:`SYSTEMD_BOOT_CFG`
7638 When :term:`EFI_PROVIDER` is set to 7638 When :term:`EFI_PROVIDER` is set to
7639 "systemd-boot", the ``SYSTEMD_BOOT_CFG`` variable specifies the 7639 "systemd-boot", the ``SYSTEMD_BOOT_CFG`` variable specifies the
7640 configuration file that should be used. By default, the 7640 configuration file that should be used. By default, the
@@ -7647,7 +7647,7 @@ system and gives an overview of their function and contents.
7647 For information on Systemd-boot, see the `Systemd-boot 7647 For information on Systemd-boot, see the `Systemd-boot
7648 documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. 7648 documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
7649 7649
7650 SYSTEMD_BOOT_ENTRIES 7650 :term:`SYSTEMD_BOOT_ENTRIES`
7651 When :term:`EFI_PROVIDER` is set to 7651 When :term:`EFI_PROVIDER` is set to
7652 "systemd-boot", the ``SYSTEMD_BOOT_ENTRIES`` variable specifies a 7652 "systemd-boot", the ``SYSTEMD_BOOT_ENTRIES`` variable specifies a
7653 list of entry files (``*.conf``) to install that contain one boot 7653 list of entry files (``*.conf``) to install that contain one boot
@@ -7661,7 +7661,7 @@ system and gives an overview of their function and contents.
7661 For information on Systemd-boot, see the `Systemd-boot 7661 For information on Systemd-boot, see the `Systemd-boot
7662 documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. 7662 documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
7663 7663
7664 SYSTEMD_BOOT_TIMEOUT 7664 :term:`SYSTEMD_BOOT_TIMEOUT`
7665 When :term:`EFI_PROVIDER` is set to 7665 When :term:`EFI_PROVIDER` is set to
7666 "systemd-boot", the ``SYSTEMD_BOOT_TIMEOUT`` variable specifies the 7666 "systemd-boot", the ``SYSTEMD_BOOT_TIMEOUT`` variable specifies the
7667 boot menu timeout in seconds. By default, the 7667 boot menu timeout in seconds. By default, the
@@ -7674,7 +7674,7 @@ system and gives an overview of their function and contents.
7674 For information on Systemd-boot, see the `Systemd-boot 7674 For information on Systemd-boot, see the `Systemd-boot
7675 documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. 7675 documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__.
7676 7676
7677 SYSTEMD_PACKAGES 7677 :term:`SYSTEMD_PACKAGES`
7678 When inheriting the :ref:`systemd <ref-classes-systemd>` class, 7678 When inheriting the :ref:`systemd <ref-classes-systemd>` class,
7679 this variable locates the systemd unit files when they are not found 7679 this variable locates the systemd unit files when they are not found
7680 in the main recipe's package. By default, the ``SYSTEMD_PACKAGES`` 7680 in the main recipe's package. By default, the ``SYSTEMD_PACKAGES``
@@ -7688,7 +7688,7 @@ system and gives an overview of their function and contents.
7688 to use ``SYSTEMD_PACKAGES`` to list the package or packages in which 7688 to use ``SYSTEMD_PACKAGES`` to list the package or packages in which
7689 the build system can find the systemd unit files. 7689 the build system can find the systemd unit files.
7690 7690
7691 SYSTEMD_SERVICE 7691 :term:`SYSTEMD_SERVICE`
7692 When inheriting the :ref:`systemd <ref-classes-systemd>` class, 7692 When inheriting the :ref:`systemd <ref-classes-systemd>` class,
7693 this variable specifies the systemd service name for a package. 7693 this variable specifies the systemd service name for a package.
7694 7694
@@ -7699,7 +7699,7 @@ system and gives an overview of their function and contents.
7699 7699
7700 SYSTEMD_SERVICE_${PN} = "connman.service" 7700 SYSTEMD_SERVICE_${PN} = "connman.service"
7701 7701
7702 SYSVINIT_ENABLED_GETTYS 7702 :term:`SYSVINIT_ENABLED_GETTYS`
7703 When using 7703 When using
7704 :ref:`SysVinit <dev-manual/dev-manual-common-tasks:enabling system services>`, 7704 :ref:`SysVinit <dev-manual/dev-manual-common-tasks:enabling system services>`,
7705 specifies a space-separated list of the virtual terminals that should 7705 specifies a space-separated list of the virtual terminals that should
@@ -7710,7 +7710,7 @@ system and gives an overview of their function and contents.
7710 The default value for ``SYSVINIT_ENABLED_GETTYS`` is "1" (i.e. only 7710 The default value for ``SYSVINIT_ENABLED_GETTYS`` is "1" (i.e. only
7711 run a getty on the first virtual terminal). 7711 run a getty on the first virtual terminal).
7712 7712
7713 T 7713 :term:`T`
7714 This variable points to a directory were BitBake places temporary 7714 This variable points to a directory were BitBake places temporary
7715 files, which consist mostly of task logs and scripts, when building a 7715 files, which consist mostly of task logs and scripts, when building a
7716 particular recipe. The variable is typically set as follows: 7716 particular recipe. The variable is typically set as follows:
@@ -7727,7 +7727,7 @@ system and gives an overview of their function and contents.
7727 the directory tree where BitBake places the output of an entire 7727 the directory tree where BitBake places the output of an entire
7728 build. 7728 build.
7729 7729
7730 TARGET_ARCH 7730 :term:`TARGET_ARCH`
7731 The target machine's architecture. The OpenEmbedded build system 7731 The target machine's architecture. The OpenEmbedded build system
7732 supports many architectures. Here is an example list of architectures 7732 supports many architectures. Here is an example list of architectures
7733 supported. This list is by no means complete as the architecture is 7733 supported. This list is by no means complete as the architecture is
@@ -7744,7 +7744,7 @@ system and gives an overview of their function and contents.
7744 For additional information on machine architectures, see the 7744 For additional information on machine architectures, see the
7745 :term:`TUNE_ARCH` variable. 7745 :term:`TUNE_ARCH` variable.
7746 7746
7747 TARGET_AS_ARCH 7747 :term:`TARGET_AS_ARCH`
7748 Specifies architecture-specific assembler flags for the target 7748 Specifies architecture-specific assembler flags for the target
7749 system. ``TARGET_AS_ARCH`` is initialized from 7749 system. ``TARGET_AS_ARCH`` is initialized from
7750 :term:`TUNE_ASARGS` by default in the BitBake 7750 :term:`TUNE_ASARGS` by default in the BitBake
@@ -7753,7 +7753,7 @@ system and gives an overview of their function and contents.
7753 7753
7754 TARGET_AS_ARCH = "${TUNE_ASARGS}" 7754 TARGET_AS_ARCH = "${TUNE_ASARGS}"
7755 7755
7756 TARGET_CC_ARCH 7756 :term:`TARGET_CC_ARCH`
7757 Specifies architecture-specific C compiler flags for the target 7757 Specifies architecture-specific C compiler flags for the target
7758 system. ``TARGET_CC_ARCH`` is initialized from 7758 system. ``TARGET_CC_ARCH`` is initialized from
7759 :term:`TUNE_CCARGS` by default. 7759 :term:`TUNE_CCARGS` by default.
@@ -7769,7 +7769,7 @@ system and gives an overview of their function and contents.
7769 LDFLAGS 7769 LDFLAGS
7770 variable. 7770 variable.
7771 7771
7772 TARGET_CC_KERNEL_ARCH 7772 :term:`TARGET_CC_KERNEL_ARCH`
7773 This is a specific kernel compiler flag for a CPU or Application 7773 This is a specific kernel compiler flag for a CPU or Application
7774 Binary Interface (ABI) tune. The flag is used rarely and only for 7774 Binary Interface (ABI) tune. The flag is used rarely and only for
7775 cases where a userspace :term:`TUNE_CCARGS` is not 7775 cases where a userspace :term:`TUNE_CCARGS` is not
@@ -7779,7 +7779,7 @@ system and gives an overview of their function and contents.
7779 ``meta/conf/machine/include/arm/feature-arm-thumb.inc`` file in the 7779 ``meta/conf/machine/include/arm/feature-arm-thumb.inc`` file in the
7780 :term:`Source Directory` for an example. 7780 :term:`Source Directory` for an example.
7781 7781
7782 TARGET_CFLAGS 7782 :term:`TARGET_CFLAGS`
7783 Specifies the flags to pass to the C compiler when building for the 7783 Specifies the flags to pass to the C compiler when building for the
7784 target. When building in the target context, 7784 target. When building in the target context,
7785 :term:`CFLAGS` is set to the value of this variable by 7785 :term:`CFLAGS` is set to the value of this variable by
@@ -7789,7 +7789,7 @@ system and gives an overview of their function and contents.
7789 variable in the environment to the ``TARGET_CFLAGS`` value so that 7789 variable in the environment to the ``TARGET_CFLAGS`` value so that
7790 executables built using the SDK also have the flags applied. 7790 executables built using the SDK also have the flags applied.
7791 7791
7792 TARGET_CPPFLAGS 7792 :term:`TARGET_CPPFLAGS`
7793 Specifies the flags to pass to the C pre-processor (i.e. to both the 7793 Specifies the flags to pass to the C pre-processor (i.e. to both the
7794 C and the C++ compilers) when building for the target. When building 7794 C and the C++ compilers) when building for the target. When building
7795 in the target context, :term:`CPPFLAGS` is set to the 7795 in the target context, :term:`CPPFLAGS` is set to the
@@ -7800,7 +7800,7 @@ system and gives an overview of their function and contents.
7800 value so that executables built using the SDK also have the flags 7800 value so that executables built using the SDK also have the flags
7801 applied. 7801 applied.
7802 7802
7803 TARGET_CXXFLAGS 7803 :term:`TARGET_CXXFLAGS`
7804 Specifies the flags to pass to the C++ compiler when building for the 7804 Specifies the flags to pass to the C++ compiler when building for the
7805 target. When building in the target context, 7805 target. When building in the target context,
7806 :term:`CXXFLAGS` is set to the value of this variable 7806 :term:`CXXFLAGS` is set to the value of this variable
@@ -7811,13 +7811,13 @@ system and gives an overview of their function and contents.
7811 value so that executables built using the SDK also have the flags 7811 value so that executables built using the SDK also have the flags
7812 applied. 7812 applied.
7813 7813
7814 TARGET_FPU 7814 :term:`TARGET_FPU`
7815 Specifies the method for handling FPU code. For FPU-less targets, 7815 Specifies the method for handling FPU code. For FPU-less targets,
7816 which include most ARM CPUs, the variable must be set to "soft". If 7816 which include most ARM CPUs, the variable must be set to "soft". If
7817 not, the kernel emulation gets used, which results in a performance 7817 not, the kernel emulation gets used, which results in a performance
7818 penalty. 7818 penalty.
7819 7819
7820 TARGET_LD_ARCH 7820 :term:`TARGET_LD_ARCH`
7821 Specifies architecture-specific linker flags for the target system. 7821 Specifies architecture-specific linker flags for the target system.
7822 ``TARGET_LD_ARCH`` is initialized from 7822 ``TARGET_LD_ARCH`` is initialized from
7823 :term:`TUNE_LDARGS` by default in the BitBake 7823 :term:`TUNE_LDARGS` by default in the BitBake
@@ -7826,7 +7826,7 @@ system and gives an overview of their function and contents.
7826 7826
7827 TARGET_LD_ARCH = "${TUNE_LDARGS}" 7827 TARGET_LD_ARCH = "${TUNE_LDARGS}"
7828 7828
7829 TARGET_LDFLAGS 7829 :term:`TARGET_LDFLAGS`
7830 Specifies the flags to pass to the linker when building for the 7830 Specifies the flags to pass to the linker when building for the
7831 target. When building in the target context, 7831 target. When building in the target context,
7832 :term:`LDFLAGS` is set to the value of this variable 7832 :term:`LDFLAGS` is set to the value of this variable
@@ -7837,13 +7837,13 @@ system and gives an overview of their function and contents.
7837 ``TARGET_LDFLAGS`` value so that executables built using the SDK also 7837 ``TARGET_LDFLAGS`` value so that executables built using the SDK also
7838 have the flags applied. 7838 have the flags applied.
7839 7839
7840 TARGET_OS 7840 :term:`TARGET_OS`
7841 Specifies the target's operating system. The variable can be set to 7841 Specifies the target's operating system. The variable can be set to
7842 "linux" for glibc-based systems (GNU C Library) and to "linux-musl" 7842 "linux" for glibc-based systems (GNU C Library) and to "linux-musl"
7843 for musl libc. For ARM/EABI targets, "linux-gnueabi" and 7843 for musl libc. For ARM/EABI targets, "linux-gnueabi" and
7844 "linux-musleabi" possible values exist. 7844 "linux-musleabi" possible values exist.
7845 7845
7846 TARGET_PREFIX 7846 :term:`TARGET_PREFIX`
7847 Specifies the prefix used for the toolchain binary target tools. 7847 Specifies the prefix used for the toolchain binary target tools.
7848 7848
7849 Depending on the type of recipe and the build target, 7849 Depending on the type of recipe and the build target,
@@ -7858,7 +7858,7 @@ system and gives an overview of their function and contents.
7858 - For native SDK recipes (``nativesdk``), the build system sets the 7858 - For native SDK recipes (``nativesdk``), the build system sets the
7859 variable to the value of ``SDK_PREFIX``. 7859 variable to the value of ``SDK_PREFIX``.
7860 7860
7861 TARGET_SYS 7861 :term:`TARGET_SYS`
7862 Specifies the system, including the architecture and the operating 7862 Specifies the system, including the architecture and the operating
7863 system, for which the build is occurring in the context of the 7863 system, for which the build is occurring in the context of the
7864 current recipe. 7864 current recipe.
@@ -7880,17 +7880,17 @@ system and gives an overview of their function and contents.
7880 - Given a recipe being built for a little-endian, MIPS target 7880 - Given a recipe being built for a little-endian, MIPS target
7881 running Linux, the value might be "mipsel-linux". 7881 running Linux, the value might be "mipsel-linux".
7882 7882
7883 TARGET_VENDOR 7883 :term:`TARGET_VENDOR`
7884 Specifies the name of the target vendor. 7884 Specifies the name of the target vendor.
7885 7885
7886 TCLIBC 7886 :term:`TCLIBC`
7887 Specifies the GNU standard C library (``libc``) variant to use during 7887 Specifies the GNU standard C library (``libc``) variant to use during
7888 the build process. This variable replaces ``POKYLIBC``, which is no 7888 the build process. This variable replaces ``POKYLIBC``, which is no
7889 longer supported. 7889 longer supported.
7890 7890
7891 You can select "glibc", "musl", "newlib", or "baremetal" 7891 You can select "glibc", "musl", "newlib", or "baremetal"
7892 7892
7893 TCLIBCAPPEND 7893 :term:`TCLIBCAPPEND`
7894 Specifies a suffix to be appended onto the 7894 Specifies a suffix to be appended onto the
7895 :term:`TMPDIR` value. The suffix identifies the 7895 :term:`TMPDIR` value. The suffix identifies the
7896 ``libc`` variant for building. When you are building for multiple 7896 ``libc`` variant for building. When you are building for multiple
@@ -7904,7 +7904,7 @@ system and gives an overview of their function and contents.
7904 ``TCLIBCAPPEND`` to "" in their distro configuration file resulting 7904 ``TCLIBCAPPEND`` to "" in their distro configuration file resulting
7905 in no suffix being applied. 7905 in no suffix being applied.
7906 7906
7907 TCMODE 7907 :term:`TCMODE`
7908 Specifies the toolchain selector. ``TCMODE`` controls the 7908 Specifies the toolchain selector. ``TCMODE`` controls the
7909 characteristics of the generated packages and images by telling the 7909 characteristics of the generated packages and images by telling the
7910 OpenEmbedded build system which toolchain profile to use. By default, 7910 OpenEmbedded build system which toolchain profile to use. By default,
@@ -7948,7 +7948,7 @@ system and gives an overview of their function and contents.
7948 toolchain. You can use ``meta-sourcery`` as a template for adding 7948 toolchain. You can use ``meta-sourcery`` as a template for adding
7949 support for other external toolchains. 7949 support for other external toolchains.
7950 7950
7951 TEST_EXPORT_DIR 7951 :term:`TEST_EXPORT_DIR`
7952 The location the OpenEmbedded build system uses to export tests when 7952 The location the OpenEmbedded build system uses to export tests when
7953 the :term:`TEST_EXPORT_ONLY` variable is set 7953 the :term:`TEST_EXPORT_ONLY` variable is set
7954 to "1". 7954 to "1".
@@ -7956,12 +7956,12 @@ system and gives an overview of their function and contents.
7956 The ``TEST_EXPORT_DIR`` variable defaults to 7956 The ``TEST_EXPORT_DIR`` variable defaults to
7957 ``"${TMPDIR}/testimage/${PN}"``. 7957 ``"${TMPDIR}/testimage/${PN}"``.
7958 7958
7959 TEST_EXPORT_ONLY 7959 :term:`TEST_EXPORT_ONLY`
7960 Specifies to export the tests only. Set this variable to "1" if you 7960 Specifies to export the tests only. Set this variable to "1" if you
7961 do not want to run the tests but you want them to be exported in a 7961 do not want to run the tests but you want them to be exported in a
7962 manner that you to run them outside of the build system. 7962 manner that you to run them outside of the build system.
7963 7963
7964 TEST_LOG_DIR 7964 :term:`TEST_LOG_DIR`
7965 Holds the SSH log and the boot log for QEMU machines. The 7965 Holds the SSH log and the boot log for QEMU machines. The
7966 ``TEST_LOG_DIR`` variable defaults to ``"${WORKDIR}/testimage"``. 7966 ``TEST_LOG_DIR`` variable defaults to ``"${WORKDIR}/testimage"``.
7967 7967
@@ -7973,7 +7973,7 @@ system and gives an overview of their function and contents.
7973 ${WORKDIR}/temp/ 7973 ${WORKDIR}/temp/
7974 directory. 7974 directory.
7975 7975
7976 TEST_POWERCONTROL_CMD 7976 :term:`TEST_POWERCONTROL_CMD`
7977 For automated hardware testing, specifies the command to use to 7977 For automated hardware testing, specifies the command to use to
7978 control the power of the target machine under test. Typically, this 7978 control the power of the target machine under test. Typically, this
7979 command would point to a script that performs the appropriate action 7979 command would point to a script that performs the appropriate action
@@ -7982,7 +7982,7 @@ system and gives an overview of their function and contents.
7982 "cycle" specifying to power off, on, or cycle (power off and then 7982 "cycle" specifying to power off, on, or cycle (power off and then
7983 power on) the device, respectively. 7983 power on) the device, respectively.
7984 7984
7985 TEST_POWERCONTROL_EXTRA_ARGS 7985 :term:`TEST_POWERCONTROL_EXTRA_ARGS`
7986 For automated hardware testing, specifies additional arguments to 7986 For automated hardware testing, specifies additional arguments to
7987 pass through to the command specified in 7987 pass through to the command specified in
7988 :term:`TEST_POWERCONTROL_CMD`. Setting 7988 :term:`TEST_POWERCONTROL_CMD`. Setting
@@ -7990,7 +7990,7 @@ system and gives an overview of their function and contents.
7990 wish, for example, to separate the machine-specific and 7990 wish, for example, to separate the machine-specific and
7991 non-machine-specific parts of the arguments. 7991 non-machine-specific parts of the arguments.
7992 7992
7993 TEST_QEMUBOOT_TIMEOUT 7993 :term:`TEST_QEMUBOOT_TIMEOUT`
7994 The time in seconds allowed for an image to boot before automated 7994 The time in seconds allowed for an image to boot before automated
7995 runtime tests begin to run against an image. The default timeout 7995 runtime tests begin to run against an image. The default timeout
7996 period to allow the boot process to reach the login prompt is 500 7996 period to allow the boot process to reach the login prompt is 500
@@ -8001,7 +8001,7 @@ system and gives an overview of their function and contents.
8001 ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" 8001 ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`"
8002 section in the Yocto Project Development Tasks Manual. 8002 section in the Yocto Project Development Tasks Manual.
8003 8003
8004 TEST_SERIALCONTROL_CMD 8004 :term:`TEST_SERIALCONTROL_CMD`
8005 For automated hardware testing, specifies the command to use to 8005 For automated hardware testing, specifies the command to use to
8006 connect to the serial console of the target machine under test. This 8006 connect to the serial console of the target machine under test. This
8007 command simply needs to connect to the serial console and forward 8007 command simply needs to connect to the serial console and forward
@@ -8014,7 +8014,7 @@ system and gives an overview of their function and contents.
8014 8014
8015 TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200" 8015 TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200"
8016 8016
8017 TEST_SERIALCONTROL_EXTRA_ARGS 8017 :term:`TEST_SERIALCONTROL_EXTRA_ARGS`
8018 For automated hardware testing, specifies additional arguments to 8018 For automated hardware testing, specifies additional arguments to
8019 pass through to the command specified in 8019 pass through to the command specified in
8020 :term:`TEST_SERIALCONTROL_CMD`. Setting 8020 :term:`TEST_SERIALCONTROL_CMD`. Setting
@@ -8022,7 +8022,7 @@ system and gives an overview of their function and contents.
8022 wish, for example, to separate the machine-specific and 8022 wish, for example, to separate the machine-specific and
8023 non-machine-specific parts of the command. 8023 non-machine-specific parts of the command.
8024 8024
8025 TEST_SERVER_IP 8025 :term:`TEST_SERVER_IP`
8026 The IP address of the build machine (host machine). This IP address 8026 The IP address of the build machine (host machine). This IP address
8027 is usually automatically detected. However, if detection fails, this 8027 is usually automatically detected. However, if detection fails, this
8028 variable needs to be set to the IP address of the build machine (i.e. 8028 variable needs to be set to the IP address of the build machine (i.e.
@@ -8037,7 +8037,7 @@ system and gives an overview of their function and contents.
8037 WORKDIR/oe-rootfs-repo 8037 WORKDIR/oe-rootfs-repo
8038 . 8038 .
8039 8039
8040 TEST_SUITES 8040 :term:`TEST_SUITES`
8041 An ordered list of tests (modules) to run against an image when 8041 An ordered list of tests (modules) to run against an image when
8042 performing automated runtime testing. 8042 performing automated runtime testing.
8043 8043
@@ -8080,7 +8080,7 @@ system and gives an overview of their function and contents.
8080 ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" 8080 ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`"
8081 section in the Yocto Project Development Tasks Manual. 8081 section in the Yocto Project Development Tasks Manual.
8082 8082
8083 TEST_TARGET 8083 :term:`TEST_TARGET`
8084 Specifies the target controller to use when running tests against a 8084 Specifies the target controller to use when running tests against a
8085 test image. The default controller to use is "qemu": 8085 test image. The default controller to use is "qemu":
8086 :: 8086 ::
@@ -8117,7 +8117,7 @@ system and gives an overview of their function and contents.
8117 ":ref:`hardware-image-enabling-tests`" 8117 ":ref:`hardware-image-enabling-tests`"
8118 section in the Yocto Project Development Tasks Manual. 8118 section in the Yocto Project Development Tasks Manual.
8119 8119
8120 TEST_TARGET_IP 8120 :term:`TEST_TARGET_IP`
8121 The IP address of your hardware under test. The ``TEST_TARGET_IP`` 8121 The IP address of your hardware under test. The ``TEST_TARGET_IP``
8122 variable has no effect when :term:`TEST_TARGET` is 8122 variable has no effect when :term:`TEST_TARGET` is
8123 set to "qemu". 8123 set to "qemu".
@@ -8134,7 +8134,7 @@ system and gives an overview of their function and contents.
8134 directly accessible from your host and you need to do port address 8134 directly accessible from your host and you need to do port address
8135 translation. 8135 translation.
8136 8136
8137 TESTIMAGE_AUTO 8137 :term:`TESTIMAGE_AUTO`
8138 Automatically runs the series of automated tests for images when an 8138 Automatically runs the series of automated tests for images when an
8139 image is successfully built. Setting ``TESTIMAGE_AUTO`` to "1" causes 8139 image is successfully built. Setting ``TESTIMAGE_AUTO`` to "1" causes
8140 any image that successfully builds to automatically boot under QEMU. 8140 any image that successfully builds to automatically boot under QEMU.
@@ -8156,16 +8156,16 @@ system and gives an overview of their function and contents.
8156 section in the Yocto Project Development Tasks Manual and the 8156 section in the Yocto Project Development Tasks Manual and the
8157 ":ref:`testimage*.bbclass <ref-classes-testimage*>`" section. 8157 ":ref:`testimage*.bbclass <ref-classes-testimage*>`" section.
8158 8158
8159 THISDIR 8159 :term:`THISDIR`
8160 The directory in which the file BitBake is currently parsing is 8160 The directory in which the file BitBake is currently parsing is
8161 located. Do not manually set this variable. 8161 located. Do not manually set this variable.
8162 8162
8163 TIME 8163 :term:`TIME`
8164 The time the build was started. Times appear using the hour, minute, 8164 The time the build was started. Times appear using the hour, minute,
8165 and second (HMS) format (e.g. "140159" for one minute and fifty-nine 8165 and second (HMS) format (e.g. "140159" for one minute and fifty-nine
8166 seconds past 1400 hours). 8166 seconds past 1400 hours).
8167 8167
8168 TMPDIR 8168 :term:`TMPDIR`
8169 This variable is the base directory the OpenEmbedded build system 8169 This variable is the base directory the OpenEmbedded build system
8170 uses for all build output and intermediate files (other than the 8170 uses for all build output and intermediate files (other than the
8171 shared state cache). By default, the ``TMPDIR`` variable points to 8171 shared state cache). By default, the ``TMPDIR`` variable points to
@@ -8187,7 +8187,7 @@ system and gives an overview of their function and contents.
8187 implementations, NFS does not meet this minimum requirement. 8187 implementations, NFS does not meet this minimum requirement.
8188 Consequently, ``TMPDIR`` cannot be on NFS. 8188 Consequently, ``TMPDIR`` cannot be on NFS.
8189 8189
8190 TOOLCHAIN_HOST_TASK 8190 :term:`TOOLCHAIN_HOST_TASK`
8191 This variable lists packages the OpenEmbedded build system uses when 8191 This variable lists packages the OpenEmbedded build system uses when
8192 building an SDK, which contains a cross-development environment. The 8192 building an SDK, which contains a cross-development environment. The
8193 packages specified by this variable are part of the toolchain set 8193 packages specified by this variable are part of the toolchain set
@@ -8212,7 +8212,7 @@ system and gives an overview of their function and contents.
8212 information on setting up a cross-development environment, see the 8212 information on setting up a cross-development environment, see the
8213 :doc:`../sdk-manual/sdk-manual` manual. 8213 :doc:`../sdk-manual/sdk-manual` manual.
8214 8214
8215 TOOLCHAIN_OUTPUTNAME 8215 :term:`TOOLCHAIN_OUTPUTNAME`
8216 This variable defines the name used for the toolchain output. The 8216 This variable defines the name used for the toolchain output. The
8217 :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class sets 8217 :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class sets
8218 the ``TOOLCHAIN_OUTPUTNAME`` variable as follows: 8218 the ``TOOLCHAIN_OUTPUTNAME`` variable as follows:
@@ -8225,7 +8225,7 @@ system and gives an overview of their function and contents.
8225 :term:`SDK_VERSION` variables for additional 8225 :term:`SDK_VERSION` variables for additional
8226 information. 8226 information.
8227 8227
8228 TOOLCHAIN_TARGET_TASK 8228 :term:`TOOLCHAIN_TARGET_TASK`
8229 This variable lists packages the OpenEmbedded build system uses when 8229 This variable lists packages the OpenEmbedded build system uses when
8230 it creates the target part of an SDK (i.e. the part built for the 8230 it creates the target part of an SDK (i.e. the part built for the
8231 target hardware), which includes libraries and headers. Use this 8231 target hardware), which includes libraries and headers. Use this
@@ -8242,12 +8242,12 @@ system and gives an overview of their function and contents.
8242 information on setting up a cross-development environment, see the 8242 information on setting up a cross-development environment, see the
8243 :doc:`../sdk-manual/sdk-manual` manual. 8243 :doc:`../sdk-manual/sdk-manual` manual.
8244 8244
8245 TOPDIR 8245 :term:`TOPDIR`
8246 The top-level :term:`Build Directory`. BitBake 8246 The top-level :term:`Build Directory`. BitBake
8247 automatically sets this variable when you initialize your build 8247 automatically sets this variable when you initialize your build
8248 environment using ````` <#structure-core-script>`__. 8248 environment using ````` <#structure-core-script>`__.
8249 8249
8250 TRANSLATED_TARGET_ARCH 8250 :term:`TRANSLATED_TARGET_ARCH`
8251 A sanitized version of :term:`TARGET_ARCH`. This 8251 A sanitized version of :term:`TARGET_ARCH`. This
8252 variable is used where the architecture is needed in a value where 8252 variable is used where the architecture is needed in a value where
8253 underscores are not allowed, for example within package filenames. In 8253 underscores are not allowed, for example within package filenames. In
@@ -8256,7 +8256,7 @@ system and gives an overview of their function and contents.
8256 8256
8257 Do not edit this variable. 8257 Do not edit this variable.
8258 8258
8259 TUNE_ARCH 8259 :term:`TUNE_ARCH`
8260 The GNU canonical architecture for a specific architecture (i.e. 8260 The GNU canonical architecture for a specific architecture (i.e.
8261 ``arm``, ``armeb``, ``mips``, ``mips64``, and so forth). BitBake uses 8261 ``arm``, ``armeb``, ``mips``, ``mips64``, and so forth). BitBake uses
8262 this value to setup configuration. 8262 this value to setup configuration.
@@ -8288,7 +8288,7 @@ system and gives an overview of their function and contents.
8288 - mips 8288 - mips
8289 - mipsel 8289 - mipsel
8290 8290
8291 TUNE_ASARGS 8291 :term:`TUNE_ASARGS`
8292 Specifies architecture-specific assembler flags for the target 8292 Specifies architecture-specific assembler flags for the target
8293 system. The set of flags is based on the selected tune features. 8293 system. The set of flags is based on the selected tune features.
8294 ``TUNE_ASARGS`` is set using the tune include files, which are 8294 ``TUNE_ASARGS`` is set using the tune include files, which are
@@ -8306,7 +8306,7 @@ system and gives an overview of their function and contents.
8306 in turn, affects the tune variables themselves (i.e. the tune can 8306 in turn, affects the tune variables themselves (i.e. the tune can
8307 supply its own set of flags). 8307 supply its own set of flags).
8308 8308
8309 TUNE_CCARGS 8309 :term:`TUNE_CCARGS`
8310 Specifies architecture-specific C compiler flags for the target 8310 Specifies architecture-specific C compiler flags for the target
8311 system. The set of flags is based on the selected tune features. 8311 system. The set of flags is based on the selected tune features.
8312 ``TUNE_CCARGS`` is set using the tune include files, which are 8312 ``TUNE_CCARGS`` is set using the tune include files, which are
@@ -8319,7 +8319,7 @@ system and gives an overview of their function and contents.
8319 in turn, affects the tune variables themselves (i.e. the tune can 8319 in turn, affects the tune variables themselves (i.e. the tune can
8320 supply its own set of flags). 8320 supply its own set of flags).
8321 8321
8322 TUNE_FEATURES 8322 :term:`TUNE_FEATURES`
8323 Features used to "tune" a compiler for optimal use given a specific 8323 Features used to "tune" a compiler for optimal use given a specific
8324 processor. The features are defined within the tune files and allow 8324 processor. The features are defined within the tune files and allow
8325 arguments (i.e. ``TUNE_*ARGS``) to be dynamically generated based on 8325 arguments (i.e. ``TUNE_*ARGS``) to be dynamically generated based on
@@ -8336,7 +8336,7 @@ system and gives an overview of their function and contents.
8336 8336
8337 See the :term:`DEFAULTTUNE` variable for more information. 8337 See the :term:`DEFAULTTUNE` variable for more information.
8338 8338
8339 TUNE_LDARGS 8339 :term:`TUNE_LDARGS`
8340 Specifies architecture-specific linker flags for the target system. 8340 Specifies architecture-specific linker flags for the target system.
8341 The set of flags is based on the selected tune features. 8341 The set of flags is based on the selected tune features.
8342 ``TUNE_LDARGS`` is set using the tune include files, which are 8342 ``TUNE_LDARGS`` is set using the tune include files, which are
@@ -8354,7 +8354,7 @@ system and gives an overview of their function and contents.
8354 in turn, affects the tune variables themselves (i.e. the tune can 8354 in turn, affects the tune variables themselves (i.e. the tune can
8355 supply its own set of flags). 8355 supply its own set of flags).
8356 8356
8357 TUNE_PKGARCH 8357 :term:`TUNE_PKGARCH`
8358 The package architecture understood by the packaging system to define 8358 The package architecture understood by the packaging system to define
8359 the architecture, ABI, and tuning of output packages. The specific 8359 the architecture, ABI, and tuning of output packages. The specific
8360 tune is defined using the "_tune" override as follows: 8360 tune is defined using the "_tune" override as follows:
@@ -8369,7 +8369,7 @@ system and gives an overview of their function and contents.
8369 8369
8370 TUNE_PKGARCH_tune-core2-32 = "core2-32" 8370 TUNE_PKGARCH_tune-core2-32 = "core2-32"
8371 8371
8372 TUNEABI 8372 :term:`TUNEABI`
8373 An underlying Application Binary Interface (ABI) used by a particular 8373 An underlying Application Binary Interface (ABI) used by a particular
8374 tuning in a given toolchain layer. Providers that use prebuilt 8374 tuning in a given toolchain layer. Providers that use prebuilt
8375 libraries can use the ``TUNEABI``, 8375 libraries can use the ``TUNEABI``,
@@ -8381,7 +8381,7 @@ system and gives an overview of their function and contents.
8381 :ref:`sanity <ref-classes-sanity>` class to see how the variable is 8381 :ref:`sanity <ref-classes-sanity>` class to see how the variable is
8382 used. 8382 used.
8383 8383
8384 TUNEABI_OVERRIDE 8384 :term:`TUNEABI_OVERRIDE`
8385 If set, the OpenEmbedded system ignores the 8385 If set, the OpenEmbedded system ignores the
8386 :term:`TUNEABI_WHITELIST` variable. 8386 :term:`TUNEABI_WHITELIST` variable.
8387 Providers that use prebuilt libraries can use the 8387 Providers that use prebuilt libraries can use the
@@ -8392,7 +8392,7 @@ system and gives an overview of their function and contents.
8392 See the :ref:`sanity <ref-classes-sanity>` class to see how the 8392 See the :ref:`sanity <ref-classes-sanity>` class to see how the
8393 variable is used. 8393 variable is used.
8394 8394
8395 TUNEABI_WHITELIST 8395 :term:`TUNEABI_WHITELIST`
8396 A whitelist of permissible :term:`TUNEABI` values. If 8396 A whitelist of permissible :term:`TUNEABI` values. If
8397 ``TUNEABI_WHITELIST`` is not set, all tunes are allowed. Providers 8397 ``TUNEABI_WHITELIST`` is not set, all tunes are allowed. Providers
8398 that use prebuilt libraries can use the ``TUNEABI_WHITELIST``, 8398 that use prebuilt libraries can use the ``TUNEABI_WHITELIST``,
@@ -8403,7 +8403,7 @@ system and gives an overview of their function and contents.
8403 See the :ref:`sanity <ref-classes-sanity>` class to see how the 8403 See the :ref:`sanity <ref-classes-sanity>` class to see how the
8404 variable is used. 8404 variable is used.
8405 8405
8406 TUNECONFLICTS[feature] 8406 :term:`TUNECONFLICTS[feature]`
8407 Specifies CPU or Application Binary Interface (ABI) tuning features 8407 Specifies CPU or Application Binary Interface (ABI) tuning features
8408 that conflict with feature. 8408 that conflict with feature.
8409 8409
@@ -8416,7 +8416,7 @@ system and gives an overview of their function and contents.
8416 8416
8417 TUNECONFLICTS[n32] = "o32 n64" 8417 TUNECONFLICTS[n32] = "o32 n64"
8418 8418
8419 TUNEVALID[feature] 8419 :term:`TUNEVALID[feature]`
8420 Specifies a valid CPU or Application Binary Interface (ABI) tuning 8420 Specifies a valid CPU or Application Binary Interface (ABI) tuning
8421 feature. The specified feature is stored as a flag. Valid features 8421 feature. The specified feature is stored as a flag. Valid features
8422 are specified in the machine include files (e.g. 8422 are specified in the machine include files (e.g.
@@ -8429,7 +8429,7 @@ system and gives an overview of their function and contents.
8429 See the machine include files in the :term:`Source Directory` 8429 See the machine include files in the :term:`Source Directory`
8430 for these features. 8430 for these features.
8431 8431
8432 UBOOT_CONFIG 8432 :term:`UBOOT_CONFIG`
8433 Configures the :term:`UBOOT_MACHINE` and can 8433 Configures the :term:`UBOOT_MACHINE` and can
8434 also define :term:`IMAGE_FSTYPES` for individual 8434 also define :term:`IMAGE_FSTYPES` for individual
8435 cases. 8435 cases.
@@ -8451,30 +8451,30 @@ system and gives an overview of their function and contents.
8451 :ref:`uboot-config <ref-classes-uboot-config>` 8451 :ref:`uboot-config <ref-classes-uboot-config>`
8452 class. 8452 class.
8453 8453
8454 UBOOT_DTB_LOADADDRESS 8454 :term:`UBOOT_DTB_LOADADDRESS`
8455 Specifies the load address for the dtb image used by U-boot. During FIT 8455 Specifies the load address for the dtb image used by U-boot. During FIT
8456 image creation, the ``UBOOT_DTB_LOADADDRESS`` variable is used in 8456 image creation, the ``UBOOT_DTB_LOADADDRESS`` variable is used in
8457 :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify 8457 :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify
8458 the load address to be used in 8458 the load address to be used in
8459 creating the dtb sections of Image Tree Source for the FIT image. 8459 creating the dtb sections of Image Tree Source for the FIT image.
8460 8460
8461 UBOOT_DTBO_LOADADDRESS 8461 :term:`UBOOT_DTBO_LOADADDRESS`
8462 Specifies the load address for the dtbo image used by U-boot. During FIT 8462 Specifies the load address for the dtbo image used by U-boot. During FIT
8463 image creation, the ``UBOOT_DTBO_LOADADDRESS`` variable is used in 8463 image creation, the ``UBOOT_DTBO_LOADADDRESS`` variable is used in
8464 :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the load address to be used in 8464 :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the load address to be used in
8465 creating the dtbo sections of Image Tree Source for the FIT image. 8465 creating the dtbo sections of Image Tree Source for the FIT image.
8466 8466
8467 UBOOT_ENTRYPOINT 8467 :term:`UBOOT_ENTRYPOINT`
8468 Specifies the entry point for the U-Boot image. During U-Boot image 8468 Specifies the entry point for the U-Boot image. During U-Boot image
8469 creation, the ``UBOOT_ENTRYPOINT`` variable is passed as a 8469 creation, the ``UBOOT_ENTRYPOINT`` variable is passed as a
8470 command-line parameter to the ``uboot-mkimage`` utility. 8470 command-line parameter to the ``uboot-mkimage`` utility.
8471 8471
8472 UBOOT_LOADADDRESS 8472 :term:`UBOOT_LOADADDRESS`
8473 Specifies the load address for the U-Boot image. During U-Boot image 8473 Specifies the load address for the U-Boot image. During U-Boot image
8474 creation, the ``UBOOT_LOADADDRESS`` variable is passed as a 8474 creation, the ``UBOOT_LOADADDRESS`` variable is passed as a
8475 command-line parameter to the ``uboot-mkimage`` utility. 8475 command-line parameter to the ``uboot-mkimage`` utility.
8476 8476
8477 UBOOT_LOCALVERSION 8477 :term:`UBOOT_LOCALVERSION`
8478 Appends a string to the name of the local version of the U-Boot 8478 Appends a string to the name of the local version of the U-Boot
8479 image. For example, assuming the version of the U-Boot image built 8479 image. For example, assuming the version of the U-Boot image built
8480 was "2013.10", the full version string reported by U-Boot would be 8480 was "2013.10", the full version string reported by U-Boot would be
@@ -8483,7 +8483,7 @@ system and gives an overview of their function and contents.
8483 8483
8484 UBOOT_LOCALVERSION = "-yocto" 8484 UBOOT_LOCALVERSION = "-yocto"
8485 8485
8486 UBOOT_MACHINE 8486 :term:`UBOOT_MACHINE`
8487 Specifies the value passed on the ``make`` command line when building 8487 Specifies the value passed on the ``make`` command line when building
8488 a U-Boot image. The value indicates the target platform 8488 a U-Boot image. The value indicates the target platform
8489 configuration. You typically set this variable from the machine 8489 configuration. You typically set this variable from the machine
@@ -8492,15 +8492,15 @@ system and gives an overview of their function and contents.
8492 Please see the "Selection of Processor Architecture and Board Type" 8492 Please see the "Selection of Processor Architecture and Board Type"
8493 section in the U-Boot README for valid values for this variable. 8493 section in the U-Boot README for valid values for this variable.
8494 8494
8495 UBOOT_MAKE_TARGET 8495 :term:`UBOOT_MAKE_TARGET`
8496 Specifies the target called in the ``Makefile``. The default target 8496 Specifies the target called in the ``Makefile``. The default target
8497 is "all". 8497 is "all".
8498 8498
8499 UBOOT_MKIMAGE_DTCOPTS 8499 :term:`UBOOT_MKIMAGE_DTCOPTS`
8500 Options for the device tree compiler passed to mkimage '-D' 8500 Options for the device tree compiler passed to mkimage '-D'
8501 feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. 8501 feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class.
8502 8502
8503 UBOOT_RD_ENTRYPOINT 8503 :term:`UBOOT_RD_ENTRYPOINT`
8504 Specifies the entrypoint for the RAM disk image. 8504 Specifies the entrypoint for the RAM disk image.
8505 During FIT image creation, the 8505 During FIT image creation, the
8506 ``UBOOT_RD_ENTRYPOINT`` variable is used 8506 ``UBOOT_RD_ENTRYPOINT`` variable is used
@@ -8508,7 +8508,7 @@ system and gives an overview of their function and contents.
8508 entrypoint to be used in creating the Image Tree Source for 8508 entrypoint to be used in creating the Image Tree Source for
8509 the FIT image. 8509 the FIT image.
8510 8510
8511 UBOOT_RD_LOADADDRESS 8511 :term:`UBOOT_RD_LOADADDRESS`
8512 Specifies the load address for the RAM disk image. 8512 Specifies the load address for the RAM disk image.
8513 During FIT image creation, the 8513 During FIT image creation, the
8514 ``UBOOT_RD_LOADADDRESS`` variable is used 8514 ``UBOOT_RD_LOADADDRESS`` variable is used
@@ -8516,33 +8516,33 @@ system and gives an overview of their function and contents.
8516 load address to be used in creating the Image Tree Source for 8516 load address to be used in creating the Image Tree Source for
8517 the FIT image. 8517 the FIT image.
8518 8518
8519 UBOOT_SIGN_ENABLE 8519 :term:`UBOOT_SIGN_ENABLE`
8520 Enable signing of FIT image. The default value is "0". 8520 Enable signing of FIT image. The default value is "0".
8521 8521
8522 UBOOT_SIGN_KEYDIR 8522 :term:`UBOOT_SIGN_KEYDIR`
8523 Location of the directory containing the RSA key and 8523 Location of the directory containing the RSA key and
8524 certificate used for signing FIT image. 8524 certificate used for signing FIT image.
8525 8525
8526 UBOOT_SIGN_KEYNAME 8526 :term:`UBOOT_SIGN_KEYNAME`
8527 The name of keys used for signing U-boot FIT image stored in 8527 The name of keys used for signing U-boot FIT image stored in
8528 :term:`UBOOT_SIGN_KEYDIR` directory. For e.g. dev.key key and dev.crt 8528 :term:`UBOOT_SIGN_KEYDIR` directory. For e.g. dev.key key and dev.crt
8529 certificate stored in :term:`UBOOT_SIGN_KEYDIR` directory will have 8529 certificate stored in :term:`UBOOT_SIGN_KEYDIR` directory will have
8530 :term:`UBOOT_SIGN_KEYNAME` set to "dev". 8530 :term:`UBOOT_SIGN_KEYNAME` set to "dev".
8531 8531
8532 UBOOT_SUFFIX 8532 :term:`UBOOT_SUFFIX`
8533 Points to the generated U-Boot extension. For example, ``u-boot.sb`` 8533 Points to the generated U-Boot extension. For example, ``u-boot.sb``
8534 has a ``.sb`` extension. 8534 has a ``.sb`` extension.
8535 8535
8536 The default U-Boot extension is ``.bin`` 8536 The default U-Boot extension is ``.bin``
8537 8537
8538 UBOOT_TARGET 8538 :term:`UBOOT_TARGET`
8539 Specifies the target used for building U-Boot. The target is passed 8539 Specifies the target used for building U-Boot. The target is passed
8540 directly as part of the "make" command (e.g. SPL and AIS). If you do 8540 directly as part of the "make" command (e.g. SPL and AIS). If you do
8541 not specifically set this variable, the OpenEmbedded build process 8541 not specifically set this variable, the OpenEmbedded build process
8542 passes and uses "all" for the target during the U-Boot building 8542 passes and uses "all" for the target during the U-Boot building
8543 process. 8543 process.
8544 8544
8545 UNKNOWN_CONFIGURE_WHITELIST 8545 :term:`UNKNOWN_CONFIGURE_WHITELIST`
8546 Specifies a list of options that, if reported by the configure script 8546 Specifies a list of options that, if reported by the configure script
8547 as being invalid, should not generate a warning during the 8547 as being invalid, should not generate a warning during the
8548 :ref:`ref-tasks-configure` task. Normally, invalid 8548 :ref:`ref-tasks-configure` task. Normally, invalid
@@ -8560,7 +8560,7 @@ system and gives an overview of their function and contents.
8560 :ref:`insane <ref-classes-insane>` class and is only enabled if the 8560 :ref:`insane <ref-classes-insane>` class and is only enabled if the
8561 recipe inherits the :ref:`autotools <ref-classes-autotools>` class. 8561 recipe inherits the :ref:`autotools <ref-classes-autotools>` class.
8562 8562
8563 UPDATERCPN 8563 :term:`UPDATERCPN`
8564 For recipes inheriting the 8564 For recipes inheriting the
8565 :ref:`update-rc.d <ref-classes-update-rc.d>` class, ``UPDATERCPN`` 8565 :ref:`update-rc.d <ref-classes-update-rc.d>` class, ``UPDATERCPN``
8566 specifies the package that contains the initscript that is enabled. 8566 specifies the package that contains the initscript that is enabled.
@@ -8569,7 +8569,7 @@ system and gives an overview of their function and contents.
8569 install initscripts package them in the main package for the recipe, 8569 install initscripts package them in the main package for the recipe,
8570 you rarely need to set this variable in individual recipes. 8570 you rarely need to set this variable in individual recipes.
8571 8571
8572 UPSTREAM_CHECK_GITTAGREGEX 8572 :term:`UPSTREAM_CHECK_GITTAGREGEX`
8573 You can perform a per-recipe check for what the latest upstream 8573 You can perform a per-recipe check for what the latest upstream
8574 source code version is by calling ``bitbake -c checkpkg`` recipe. If 8574 source code version is by calling ``bitbake -c checkpkg`` recipe. If
8575 the recipe source code is provided from Git repositories, the 8575 the recipe source code is provided from Git repositories, the
@@ -8583,7 +8583,7 @@ system and gives an overview of their function and contents.
8583 8583
8584 UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex" 8584 UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex"
8585 8585
8586 UPSTREAM_CHECK_REGEX 8586 :term:`UPSTREAM_CHECK_REGEX`
8587 Use the ``UPSTREAM_CHECK_REGEX`` variable to specify a different 8587 Use the ``UPSTREAM_CHECK_REGEX`` variable to specify a different
8588 regular expression instead of the default one when the package 8588 regular expression instead of the default one when the package
8589 checking system is parsing the page found using 8589 checking system is parsing the page found using
@@ -8592,7 +8592,7 @@ system and gives an overview of their function and contents.
8592 8592
8593 UPSTREAM_CHECK_REGEX = "package_regex" 8593 UPSTREAM_CHECK_REGEX = "package_regex"
8594 8594
8595 UPSTREAM_CHECK_URI 8595 :term:`UPSTREAM_CHECK_URI`
8596 You can perform a per-recipe check for what the latest upstream 8596 You can perform a per-recipe check for what the latest upstream
8597 source code version is by calling ``bitbake -c checkpkg`` recipe. If 8597 source code version is by calling ``bitbake -c checkpkg`` recipe. If
8598 the source code is provided from tarballs, the latest version is 8598 the source code is provided from tarballs, the latest version is
@@ -8604,7 +8604,7 @@ system and gives an overview of their function and contents.
8604 8604
8605 UPSTREAM_CHECK_URI = "recipe_url" 8605 UPSTREAM_CHECK_URI = "recipe_url"
8606 8606
8607 USE_DEVFS 8607 :term:`USE_DEVFS`
8608 Determines if ``devtmpfs`` is used for ``/dev`` population. The 8608 Determines if ``devtmpfs`` is used for ``/dev`` population. The
8609 default value used for ``USE_DEVFS`` is "1" when no value is 8609 default value used for ``USE_DEVFS`` is "1" when no value is
8610 specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a 8610 specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a
@@ -8614,7 +8614,7 @@ system and gives an overview of their function and contents.
8614 the Yocto Project Development Tasks Manual for information on how to 8614 the Yocto Project Development Tasks Manual for information on how to
8615 use this variable. 8615 use this variable.
8616 8616
8617 USE_VT 8617 :term:`USE_VT`
8618 When using 8618 When using
8619 :ref:`SysVinit <new-recipe-enabling-system-services>`, 8619 :ref:`SysVinit <new-recipe-enabling-system-services>`,
8620 determines whether or not to run a 8620 determines whether or not to run a
@@ -8628,7 +8628,7 @@ system and gives an overview of their function and contents.
8628 display attached and therefore do not need virtual terminal 8628 display attached and therefore do not need virtual terminal
8629 functionality. 8629 functionality.
8630 8630
8631 USER_CLASSES 8631 :term:`USER_CLASSES`
8632 A list of classes to globally inherit. These classes are used by the 8632 A list of classes to globally inherit. These classes are used by the
8633 OpenEmbedded build system to enable extra features (e.g. 8633 OpenEmbedded build system to enable extra features (e.g.
8634 ``buildstats``, ``image-mklibs``, and so forth). 8634 ``buildstats``, ``image-mklibs``, and so forth).
@@ -8641,7 +8641,7 @@ system and gives an overview of their function and contents.
8641 For more information, see 8641 For more information, see
8642 ``meta-poky/conf/local.conf.sample`` in the :term:`Source Directory`. 8642 ``meta-poky/conf/local.conf.sample`` in the :term:`Source Directory`.
8643 8643
8644 USERADD_ERROR_DYNAMIC 8644 :term:`USERADD_ERROR_DYNAMIC`
8645 If set to ``error``, forces the OpenEmbedded build system to produce 8645 If set to ``error``, forces the OpenEmbedded build system to produce
8646 an error if the user identification (``uid``) and group 8646 an error if the user identification (``uid``) and group
8647 identification (``gid``) values are not defined in any of the files 8647 identification (``gid``) values are not defined in any of the files
@@ -8686,7 +8686,7 @@ system and gives an overview of their function and contents.
8686 This saves you from having to add static IDs for recipes that you 8686 This saves you from having to add static IDs for recipes that you
8687 know will never be built. 8687 know will never be built.
8688 8688
8689 USERADD_GID_TABLES 8689 :term:`USERADD_GID_TABLES`
8690 Specifies a password file to use for obtaining static group 8690 Specifies a password file to use for obtaining static group
8691 identification (``gid``) values when the OpenEmbedded build system 8691 identification (``gid``) values when the OpenEmbedded build system
8692 adds a group to the system during package installation. 8692 adds a group to the system during package installation.
@@ -8709,7 +8709,7 @@ system and gives an overview of their function and contents.
8709 gid 8709 gid
8710 values. 8710 values.
8711 8711
8712 USERADD_PACKAGES 8712 :term:`USERADD_PACKAGES`
8713 When inheriting the :ref:`useradd <ref-classes-useradd>` class, 8713 When inheriting the :ref:`useradd <ref-classes-useradd>` class,
8714 this variable specifies the individual packages within the recipe 8714 this variable specifies the individual packages within the recipe
8715 that require users and/or groups to be added. 8715 that require users and/or groups to be added.
@@ -8733,7 +8733,7 @@ system and gives an overview of their function and contents.
8733 GROUPMEMS_PARAM 8733 GROUPMEMS_PARAM
8734 variables. 8734 variables.
8735 8735
8736 USERADD_PARAM 8736 :term:`USERADD_PARAM`
8737 When inheriting the :ref:`useradd <ref-classes-useradd>` class, 8737 When inheriting the :ref:`useradd <ref-classes-useradd>` class,
8738 this variable specifies for a package what parameters should pass to 8738 this variable specifies for a package what parameters should pass to
8739 the ``useradd`` command if you add a user to the system when the 8739 the ``useradd`` command if you add a user to the system when the
@@ -8750,7 +8750,7 @@ system and gives an overview of their function and contents.
8750 standard Linux shell command ``useradd``, see 8750 standard Linux shell command ``useradd``, see
8751 http://linux.die.net/man/8/useradd. 8751 http://linux.die.net/man/8/useradd.
8752 8752
8753 USERADD_UID_TABLES 8753 :term:`USERADD_UID_TABLES`
8754 Specifies a password file to use for obtaining static user 8754 Specifies a password file to use for obtaining static user
8755 identification (``uid``) values when the OpenEmbedded build system 8755 identification (``uid``) values when the OpenEmbedded build system
8756 adds a user to the system during package installation. 8756 adds a user to the system during package installation.
@@ -8772,7 +8772,7 @@ system and gives an overview of their function and contents.
8772 uid 8772 uid
8773 values. 8773 values.
8774 8774
8775 USERADDEXTENSION 8775 :term:`USERADDEXTENSION`
8776 When set to "useradd-staticids", causes the OpenEmbedded build system 8776 When set to "useradd-staticids", causes the OpenEmbedded build system
8777 to base all user and group additions on a static ``passwd`` and 8777 to base all user and group additions on a static ``passwd`` and
8778 ``group`` files found in :term:`BBPATH`. 8778 ``group`` files found in :term:`BBPATH`.
@@ -8798,7 +8798,7 @@ system and gives an overview of their function and contents.
8798 Additionally, you should also set the 8798 Additionally, you should also set the
8799 :term:`USERADD_ERROR_DYNAMIC` variable. 8799 :term:`USERADD_ERROR_DYNAMIC` variable.
8800 8800
8801 VOLATILE_LOG_DIR 8801 :term:`VOLATILE_LOG_DIR`
8802 Specifies the persistence of the target's ``/var/log`` directory, 8802 Specifies the persistence of the target's ``/var/log`` directory,
8803 which is used to house postinstall target log files. 8803 which is used to house postinstall target log files.
8804 8804
@@ -8806,14 +8806,14 @@ system and gives an overview of their function and contents.
8806 file is not persistent. You can override this setting by setting the 8806 file is not persistent. You can override this setting by setting the
8807 variable to "no" to make the log directory persistent. 8807 variable to "no" to make the log directory persistent.
8808 8808
8809 WARN_QA 8809 :term:`WARN_QA`
8810 Specifies the quality assurance checks whose failures are reported as 8810 Specifies the quality assurance checks whose failures are reported as
8811 warnings by the OpenEmbedded build system. You set this variable in 8811 warnings by the OpenEmbedded build system. You set this variable in
8812 your distribution configuration file. For a list of the checks you 8812 your distribution configuration file. For a list of the checks you
8813 can control with this variable, see the 8813 can control with this variable, see the
8814 ":ref:`insane.bbclass <ref-classes-insane>`" section. 8814 ":ref:`insane.bbclass <ref-classes-insane>`" section.
8815 8815
8816 WKS_FILE 8816 :term:`WKS_FILE`
8817 Specifies the location of the Wic kickstart file that is used by the 8817 Specifies the location of the Wic kickstart file that is used by the
8818 OpenEmbedded build system to create a partitioned image 8818 OpenEmbedded build system to create a partitioned image
8819 (image\ ``.wic``). For information on how to create a partitioned 8819 (image\ ``.wic``). For information on how to create a partitioned
@@ -8822,7 +8822,7 @@ system and gives an overview of their function and contents.
8822 section in the Yocto Project Development Tasks Manual. For details on 8822 section in the Yocto Project Development Tasks Manual. For details on
8823 the kickstart file format, see the ":doc:`../ref-manual/ref-kickstart`" Chapter. 8823 the kickstart file format, see the ":doc:`../ref-manual/ref-kickstart`" Chapter.
8824 8824
8825 WKS_FILE_DEPENDS 8825 :term:`WKS_FILE_DEPENDS`
8826 When placed in the recipe that builds your image, this variable lists 8826 When placed in the recipe that builds your image, this variable lists
8827 build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only 8827 build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only
8828 applicable when Wic images are active (i.e. when 8828 applicable when Wic images are active (i.e. when
@@ -8847,7 +8847,7 @@ system and gives an overview of their function and contents.
8847 previous example, some-native-tool would be replaced with an actual 8847 previous example, some-native-tool would be replaced with an actual
8848 native tool on which the build would depend. 8848 native tool on which the build would depend.
8849 8849
8850 WORKDIR 8850 :term:`WORKDIR`
8851 The pathname of the work directory in which the OpenEmbedded build 8851 The pathname of the work directory in which the OpenEmbedded build
8852 system builds a recipe. This directory is located within the 8852 system builds a recipe. This directory is located within the
8853 :term:`TMPDIR` directory structure and is specific to 8853 :term:`TMPDIR` directory structure and is specific to
@@ -8887,7 +8887,7 @@ system and gives an overview of their function and contents.
8887 8887
8888 poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 8888 poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0
8889 8889
8890 XSERVER 8890 :term:`XSERVER`
8891 Specifies the packages that should be installed to provide an X 8891 Specifies the packages that should be installed to provide an X
8892 server and drivers for the current machine, assuming your image 8892 server and drivers for the current machine, assuming your image
8893 directly includes ``packagegroup-core-x11-xserver`` or, perhaps 8893 directly includes ``packagegroup-core-x11-xserver`` or, perhaps