diff options
| author | Quentin Schulz <foss@0leil.net> | 2020-10-03 10:23:36 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-10-03 12:17:14 +0100 |
| commit | 520e95902f12feac2850e0c24167002eb2cc7c42 (patch) | |
| tree | 9c2705604879efa7b874572a311f8234a80b2b37 | |
| parent | 46504ab21a552227dcf9696caa305b05c3511875 (diff) | |
| download | poky-520e95902f12feac2850e0c24167002eb2cc7c42.tar.gz | |
docs: ref-manual: ref-variables: add links to terms in glossary
Before the move to Sphinx, it used to be possible to get a direct link to a
variable from the term glossary. It is very useful when pointing people to
a specific variable when manually looking for it in the glossary.
Let's add this "feature" back.
(From yocto-docs rev: 9e468274eaad270efd5f50e58a523798fcb8097e)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
| -rw-r--r-- | documentation/ref-manual/ref-variables.rst | 1174 |
1 files changed, 587 insertions, 587 deletions
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index 3a4a5551e1..35baf9b818 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,42 +2585,42 @@ 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_GENERATE_KEYS | 2588 | :term:`FIT_GENERATE_KEYS` |
| 2589 | Decides whether to generate the keys for signing fitImage if they | 2589 | Decides whether to generate the keys for signing fitImage if they |
| 2590 | don't already exist. The keys are created in ``UBOOT_SIGN_KEYDIR``. | 2590 | don't already exist. The keys are created in ``UBOOT_SIGN_KEYDIR``. |
| 2591 | The default value is 0. | 2591 | The default value is 0. |
| 2592 | 2592 | ||
| 2593 | FIT_HASH_ALG | 2593 | :term:`FIT_HASH_ALG` |
| 2594 | Specifies the hash algorithm used in creating the FIT Image. For e.g. sha256. | 2594 | Specifies the hash algorithm used in creating the FIT Image. For e.g. sha256. |
| 2595 | 2595 | ||
| 2596 | FIT_KEY_GENRSA_ARGS | 2596 | :term:`FIT_KEY_GENRSA_ARGS` |
| 2597 | Arguments to openssl genrsa for generating RSA private key for signing | 2597 | Arguments to openssl genrsa for generating RSA private key for signing |
| 2598 | fitImage. The default value is "-F4". i.e. the public exponent 65537 to | 2598 | fitImage. The default value is "-F4". i.e. the public exponent 65537 to |
| 2599 | use. | 2599 | use. |
| 2600 | 2600 | ||
| 2601 | FIT_KEY_REQ_ARGS | 2601 | :term:`FIT_KEY_REQ_ARGS` |
| 2602 | Arguments to openssl req for generating certificate for signing fitImage. | 2602 | Arguments to openssl req for generating certificate for signing fitImage. |
| 2603 | The default value is "-batch -new". batch for non interactive mode | 2603 | The default value is "-batch -new". batch for non interactive mode |
| 2604 | and new for generating new keys. | 2604 | and new for generating new keys. |
| 2605 | 2605 | ||
| 2606 | FIT_KEY_SIGN_PKCS | 2606 | :term:`FIT_KEY_SIGN_PKCS` |
| 2607 | Format for public key ceritifcate used in signing fitImage. | 2607 | Format for public key ceritifcate used in signing fitImage. |
| 2608 | The default value is "x509". | 2608 | The default value is "x509". |
| 2609 | 2609 | ||
| 2610 | FIT_SIGN_ALG | 2610 | :term:`FIT_SIGN_ALG` |
| 2611 | Specifies the signature algorithm used in creating the FIT Image. | 2611 | Specifies the signature algorithm used in creating the FIT Image. |
| 2612 | For e.g. rsa2048. | 2612 | For e.g. rsa2048. |
| 2613 | 2613 | ||
| 2614 | FIT_SIGN_NUMBITS | 2614 | :term:`FIT_SIGN_NUMBITS` |
| 2615 | Size of private key in number of bits used in fitImage. The default | 2615 | Size of private key in number of bits used in fitImage. The default |
| 2616 | value is "2048". | 2616 | value is "2048". |
| 2617 | 2617 | ||
| 2618 | FONT_EXTRA_RDEPENDS | 2618 | :term:`FONT_EXTRA_RDEPENDS` |
| 2619 | When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, | 2619 | When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, |
| 2620 | this variable specifies the runtime dependencies for font packages. | 2620 | this variable specifies the runtime dependencies for font packages. |
| 2621 | By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils". | 2621 | By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils". |
| 2622 | 2622 | ||
| 2623 | FONT_PACKAGES | 2623 | :term:`FONT_PACKAGES` |
| 2624 | When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, | 2624 | When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, |
| 2625 | this variable identifies packages containing font files that need to | 2625 | this variable identifies packages containing font files that need to |
| 2626 | be cached by Fontconfig. By default, the ``fontcache`` class assumes | 2626 | be cached by Fontconfig. By default, the ``fontcache`` class assumes |
| @@ -2628,18 +2628,18 @@ system and gives an overview of their function and contents. | |||
| 2628 | ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you | 2628 | ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you |
| 2629 | need are in a package other than that main package. | 2629 | need are in a package other than that main package. |
| 2630 | 2630 | ||
| 2631 | FORCE_RO_REMOVE | 2631 | :term:`FORCE_RO_REMOVE` |
| 2632 | Forces the removal of the packages listed in ``ROOTFS_RO_UNNEEDED`` | 2632 | Forces the removal of the packages listed in ``ROOTFS_RO_UNNEEDED`` |
| 2633 | during the generation of the root filesystem. | 2633 | during the generation of the root filesystem. |
| 2634 | 2634 | ||
| 2635 | Set the variable to "1" to force the removal of these packages. | 2635 | Set the variable to "1" to force the removal of these packages. |
| 2636 | 2636 | ||
| 2637 | FULL_OPTIMIZATION | 2637 | :term:`FULL_OPTIMIZATION` |
| 2638 | The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when | 2638 | The options to pass in ``TARGET_CFLAGS`` and ``CFLAGS`` when |
| 2639 | compiling an optimized system. This variable defaults to "-O2 -pipe | 2639 | compiling an optimized system. This variable defaults to "-O2 -pipe |
| 2640 | ${DEBUG_FLAGS}". | 2640 | ${DEBUG_FLAGS}". |
| 2641 | 2641 | ||
| 2642 | GCCPIE | 2642 | :term:`GCCPIE` |
| 2643 | Enables Position Independent Executables (PIE) within the GNU C | 2643 | Enables Position Independent Executables (PIE) within the GNU C |
| 2644 | Compiler (GCC). Enabling PIE in the GCC makes Return Oriented | 2644 | Compiler (GCC). Enabling PIE in the GCC makes Return Oriented |
| 2645 | Programming (ROP) attacks much more difficult to execute. | 2645 | Programming (ROP) attacks much more difficult to execute. |
| @@ -2650,7 +2650,7 @@ system and gives an overview of their function and contents. | |||
| 2650 | 2650 | ||
| 2651 | GCCPIE ?= "--enable-default-pie" | 2651 | GCCPIE ?= "--enable-default-pie" |
| 2652 | 2652 | ||
| 2653 | GCCVERSION | 2653 | :term:`GCCVERSION` |
| 2654 | Specifies the default version of the GNU C Compiler (GCC) used for | 2654 | Specifies the default version of the GNU C Compiler (GCC) used for |
| 2655 | compilation. By default, ``GCCVERSION`` is set to "8.x" in the | 2655 | compilation. By default, ``GCCVERSION`` is set to "8.x" in the |
| 2656 | ``meta/conf/distro/include/tcmode-default.inc`` include file: | 2656 | ``meta/conf/distro/include/tcmode-default.inc`` include file: |
| @@ -2661,14 +2661,14 @@ system and gives an overview of their function and contents. | |||
| 2661 | You can override this value by setting it in a | 2661 | You can override this value by setting it in a |
| 2662 | configuration file such as the ``local.conf``. | 2662 | configuration file such as the ``local.conf``. |
| 2663 | 2663 | ||
| 2664 | GDB | 2664 | :term:`GDB` |
| 2665 | The minimal command and arguments to run the GNU Debugger. | 2665 | The minimal command and arguments to run the GNU Debugger. |
| 2666 | 2666 | ||
| 2667 | GITDIR | 2667 | :term:`GITDIR` |
| 2668 | The directory in which a local copy of a Git repository is stored | 2668 | The directory in which a local copy of a Git repository is stored |
| 2669 | when it is cloned. | 2669 | when it is cloned. |
| 2670 | 2670 | ||
| 2671 | GLIBC_GENERATE_LOCALES | 2671 | :term:`GLIBC_GENERATE_LOCALES` |
| 2672 | Specifies the list of GLIBC locales to generate should you not wish | 2672 | Specifies the list of GLIBC locales to generate should you not wish |
| 2673 | to generate all LIBC locals, which can be time consuming. | 2673 | to generate all LIBC locals, which can be time consuming. |
| 2674 | 2674 | ||
| @@ -2686,7 +2686,7 @@ system and gives an overview of their function and contents. | |||
| 2686 | 2686 | ||
| 2687 | GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8" | 2687 | GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8" |
| 2688 | 2688 | ||
| 2689 | GROUPADD_PARAM | 2689 | :term:`GROUPADD_PARAM` |
| 2690 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, | 2690 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, |
| 2691 | this variable specifies for a package what parameters should be | 2691 | this variable specifies for a package what parameters should be |
| 2692 | passed to the ``groupadd`` command if you wish to add a group to the | 2692 | passed to the ``groupadd`` command if you wish to add a group to the |
| @@ -2700,7 +2700,7 @@ system and gives an overview of their function and contents. | |||
| 2700 | For information on the standard Linux shell command | 2700 | For information on the standard Linux shell command |
| 2701 | ``groupadd``, see http://linux.die.net/man/8/groupadd. | 2701 | ``groupadd``, see http://linux.die.net/man/8/groupadd. |
| 2702 | 2702 | ||
| 2703 | GROUPMEMS_PARAM | 2703 | :term:`GROUPMEMS_PARAM` |
| 2704 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, | 2704 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, |
| 2705 | this variable specifies for a package what parameters should be | 2705 | this variable specifies for a package what parameters should be |
| 2706 | passed to the ``groupmems`` command if you wish to modify the members | 2706 | passed to the ``groupmems`` command if you wish to modify the members |
| @@ -2709,7 +2709,7 @@ system and gives an overview of their function and contents. | |||
| 2709 | For information on the standard Linux shell command ``groupmems``, | 2709 | For information on the standard Linux shell command ``groupmems``, |
| 2710 | see http://linux.die.net/man/8/groupmems. | 2710 | see http://linux.die.net/man/8/groupmems. |
| 2711 | 2711 | ||
| 2712 | GRUB_GFXSERIAL | 2712 | :term:`GRUB_GFXSERIAL` |
| 2713 | Configures the GNU GRand Unified Bootloader (GRUB) to have graphics | 2713 | Configures the GNU GRand Unified Bootloader (GRUB) to have graphics |
| 2714 | and serial in the boot menu. Set this variable to "1" in your | 2714 | and serial in the boot menu. Set this variable to "1" in your |
| 2715 | ``local.conf`` or distribution configuration file to enable graphics | 2715 | ``local.conf`` or distribution configuration file to enable graphics |
| @@ -2718,7 +2718,7 @@ system and gives an overview of their function and contents. | |||
| 2718 | See the :ref:`grub-efi <ref-classes-grub-efi>` class for more | 2718 | See the :ref:`grub-efi <ref-classes-grub-efi>` class for more |
| 2719 | information on how this variable is used. | 2719 | information on how this variable is used. |
| 2720 | 2720 | ||
| 2721 | GRUB_OPTS | 2721 | :term:`GRUB_OPTS` |
| 2722 | Additional options to add to the GNU GRand Unified Bootloader (GRUB) | 2722 | Additional options to add to the GNU GRand Unified Bootloader (GRUB) |
| 2723 | configuration. Use a semi-colon character (``;``) to separate | 2723 | configuration. Use a semi-colon character (``;``) to separate |
| 2724 | multiple options. | 2724 | multiple options. |
| @@ -2727,7 +2727,7 @@ system and gives an overview of their function and contents. | |||
| 2727 | :ref:`grub-efi <ref-classes-grub-efi>` class for more information | 2727 | :ref:`grub-efi <ref-classes-grub-efi>` class for more information |
| 2728 | on how this variable is used. | 2728 | on how this variable is used. |
| 2729 | 2729 | ||
| 2730 | GRUB_TIMEOUT | 2730 | :term:`GRUB_TIMEOUT` |
| 2731 | Specifies the timeout before executing the default ``LABEL`` in the | 2731 | Specifies the timeout before executing the default ``LABEL`` in the |
| 2732 | GNU GRand Unified Bootloader (GRUB). | 2732 | GNU GRand Unified Bootloader (GRUB). |
| 2733 | 2733 | ||
| @@ -2735,18 +2735,18 @@ system and gives an overview of their function and contents. | |||
| 2735 | :ref:`grub-efi <ref-classes-grub-efi>` class for more information | 2735 | :ref:`grub-efi <ref-classes-grub-efi>` class for more information |
| 2736 | on how this variable is used. | 2736 | on how this variable is used. |
| 2737 | 2737 | ||
| 2738 | GTKIMMODULES_PACKAGES | 2738 | :term:`GTKIMMODULES_PACKAGES` |
| 2739 | When inheriting the | 2739 | When inheriting the |
| 2740 | :ref:`gtk-immodules-cache <ref-classes-gtk-immodules-cache>` class, | 2740 | :ref:`gtk-immodules-cache <ref-classes-gtk-immodules-cache>` class, |
| 2741 | this variable specifies the packages that contain the GTK+ input | 2741 | this variable specifies the packages that contain the GTK+ input |
| 2742 | method modules being installed when the modules are in packages other | 2742 | method modules being installed when the modules are in packages other |
| 2743 | than the main package. | 2743 | than the main package. |
| 2744 | 2744 | ||
| 2745 | HOMEPAGE | 2745 | :term:`HOMEPAGE` |
| 2746 | Website where more information about the software the recipe is | 2746 | Website where more information about the software the recipe is |
| 2747 | building can be found. | 2747 | building can be found. |
| 2748 | 2748 | ||
| 2749 | HOST_ARCH | 2749 | :term:`HOST_ARCH` |
| 2750 | The name of the target architecture, which is normally the same as | 2750 | The name of the target architecture, which is normally the same as |
| 2751 | :term:`TARGET_ARCH`. The OpenEmbedded build system | 2751 | :term:`TARGET_ARCH`. The OpenEmbedded build system |
| 2752 | supports many architectures. Here is an example list of architectures | 2752 | supports many architectures. Here is an example list of architectures |
| @@ -2761,7 +2761,7 @@ system and gives an overview of their function and contents. | |||
| 2761 | - mips | 2761 | - mips |
| 2762 | - mipsel | 2762 | - mipsel |
| 2763 | 2763 | ||
| 2764 | HOST_CC_ARCH | 2764 | :term:`HOST_CC_ARCH` |
| 2765 | Specifies architecture-specific compiler flags that are passed to the | 2765 | Specifies architecture-specific compiler flags that are passed to the |
| 2766 | C compiler. | 2766 | C compiler. |
| 2767 | 2767 | ||
| @@ -2777,18 +2777,18 @@ system and gives an overview of their function and contents. | |||
| 2777 | - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e. | 2777 | - ``BUILDSDK_CC_ARCH`` when building for an SDK (i.e. |
| 2778 | ``nativesdk-``) | 2778 | ``nativesdk-``) |
| 2779 | 2779 | ||
| 2780 | HOST_OS | 2780 | :term:`HOST_OS` |
| 2781 | Specifies the name of the target operating system, which is normally | 2781 | Specifies the name of the target operating system, which is normally |
| 2782 | the same as the :term:`TARGET_OS`. The variable can | 2782 | the same as the :term:`TARGET_OS`. The variable can |
| 2783 | be set to "linux" for ``glibc``-based systems and to "linux-musl" for | 2783 | be set to "linux" for ``glibc``-based systems and to "linux-musl" for |
| 2784 | ``musl``. For ARM/EABI targets, there are also "linux-gnueabi" and | 2784 | ``musl``. For ARM/EABI targets, there are also "linux-gnueabi" and |
| 2785 | "linux-musleabi" values possible. | 2785 | "linux-musleabi" values possible. |
| 2786 | 2786 | ||
| 2787 | HOST_PREFIX | 2787 | :term:`HOST_PREFIX` |
| 2788 | Specifies the prefix for the cross-compile toolchain. ``HOST_PREFIX`` | 2788 | Specifies the prefix for the cross-compile toolchain. ``HOST_PREFIX`` |
| 2789 | is normally the same as :term:`TARGET_PREFIX`. | 2789 | is normally the same as :term:`TARGET_PREFIX`. |
| 2790 | 2790 | ||
| 2791 | HOST_SYS | 2791 | :term:`HOST_SYS` |
| 2792 | Specifies the system, including the architecture and the operating | 2792 | Specifies the system, including the architecture and the operating |
| 2793 | system, for which the build is occurring in the context of the | 2793 | system, for which the build is occurring in the context of the |
| 2794 | current recipe. | 2794 | current recipe. |
| @@ -2810,7 +2810,7 @@ system and gives an overview of their function and contents. | |||
| 2810 | - Given a recipe being built for a little-endian MIPS target running | 2810 | - Given a recipe being built for a little-endian MIPS target running |
| 2811 | Linux, the value might be "mipsel-linux". | 2811 | Linux, the value might be "mipsel-linux". |
| 2812 | 2812 | ||
| 2813 | HOSTTOOLS | 2813 | :term:`HOSTTOOLS` |
| 2814 | A space-separated list (filter) of tools on the build host that | 2814 | A space-separated list (filter) of tools on the build host that |
| 2815 | should be allowed to be called from within build tasks. Using this | 2815 | should be allowed to be called from within build tasks. Using this |
| 2816 | filter helps reduce the possibility of host contamination. If a tool | 2816 | filter helps reduce the possibility of host contamination. If a tool |
| @@ -2821,7 +2821,7 @@ system and gives an overview of their function and contents. | |||
| 2821 | For additional information, see | 2821 | For additional information, see |
| 2822 | :term:`HOSTTOOLS_NONFATAL`. | 2822 | :term:`HOSTTOOLS_NONFATAL`. |
| 2823 | 2823 | ||
| 2824 | HOSTTOOLS_NONFATAL | 2824 | :term:`HOSTTOOLS_NONFATAL` |
| 2825 | A space-separated list (filter) of tools on the build host that | 2825 | A space-separated list (filter) of tools on the build host that |
| 2826 | should be allowed to be called from within build tasks. Using this | 2826 | should be allowed to be called from within build tasks. Using this |
| 2827 | filter helps reduce the possibility of host contamination. Unlike | 2827 | filter helps reduce the possibility of host contamination. Unlike |
| @@ -2830,11 +2830,11 @@ system and gives an overview of their function and contents. | |||
| 2830 | ``HOSTTOOLS_NONFATAL`` is not found on the build host. Thus, you can | 2830 | ``HOSTTOOLS_NONFATAL`` is not found on the build host. Thus, you can |
| 2831 | use ``HOSTTOOLS_NONFATAL`` to filter optional host tools. | 2831 | use ``HOSTTOOLS_NONFATAL`` to filter optional host tools. |
| 2832 | 2832 | ||
| 2833 | HOST_VENDOR | 2833 | :term:`HOST_VENDOR` |
| 2834 | Specifies the name of the vendor. ``HOST_VENDOR`` is normally the | 2834 | Specifies the name of the vendor. ``HOST_VENDOR`` is normally the |
| 2835 | same as :term:`TARGET_VENDOR`. | 2835 | same as :term:`TARGET_VENDOR`. |
| 2836 | 2836 | ||
| 2837 | ICECC_DISABLED | 2837 | :term:`ICECC_DISABLED` |
| 2838 | Disables or enables the ``icecc`` (Icecream) function. For more | 2838 | Disables or enables the ``icecc`` (Icecream) function. For more |
| 2839 | information on this function and best practices for using this | 2839 | information on this function and best practices for using this |
| 2840 | variable, see the ":ref:`icecc.bbclass <ref-classes-icecc>`" | 2840 | variable, see the ":ref:`icecc.bbclass <ref-classes-icecc>`" |
| @@ -2851,7 +2851,7 @@ system and gives an overview of their function and contents. | |||
| 2851 | 2851 | ||
| 2852 | ICECC_DISABLED = "" | 2852 | ICECC_DISABLED = "" |
| 2853 | 2853 | ||
| 2854 | ICECC_ENV_EXEC | 2854 | :term:`ICECC_ENV_EXEC` |
| 2855 | Points to the ``icecc-create-env`` script that you provide. This | 2855 | Points to the ``icecc-create-env`` script that you provide. This |
| 2856 | variable is used by the :ref:`icecc <ref-classes-icecc>` class. You | 2856 | variable is used by the :ref:`icecc <ref-classes-icecc>` class. You |
| 2857 | set this variable in your ``local.conf`` file. | 2857 | set this variable in your ``local.conf`` file. |
| @@ -2861,7 +2861,7 @@ system and gives an overview of their function and contents. | |||
| 2861 | ``icecc-create-env.bb`` recipe, which is a modified version and not | 2861 | ``icecc-create-env.bb`` recipe, which is a modified version and not |
| 2862 | the one that comes with ``icecc``. | 2862 | the one that comes with ``icecc``. |
| 2863 | 2863 | ||
| 2864 | ICECC_PARALLEL_MAKE | 2864 | :term:`ICECC_PARALLEL_MAKE` |
| 2865 | Extra options passed to the ``make`` command during the | 2865 | Extra options passed to the ``make`` command during the |
| 2866 | :ref:`ref-tasks-compile` task that specify parallel | 2866 | :ref:`ref-tasks-compile` task that specify parallel |
| 2867 | compilation. This variable usually takes the form of "-j x", where x | 2867 | compilation. This variable usually takes the form of "-j x", where x |
| @@ -2887,13 +2887,13 @@ system and gives an overview of their function and contents. | |||
| 2887 | use it (i.e. the system does not detect and assign the number of | 2887 | use it (i.e. the system does not detect and assign the number of |
| 2888 | cores as is done with ``PARALLEL_MAKE``). | 2888 | cores as is done with ``PARALLEL_MAKE``). |
| 2889 | 2889 | ||
| 2890 | ICECC_PATH | 2890 | :term:`ICECC_PATH` |
| 2891 | The location of the ``icecc`` binary. You can set this variable in | 2891 | The location of the ``icecc`` binary. You can set this variable in |
| 2892 | your ``local.conf`` file. If your ``local.conf`` file does not define | 2892 | your ``local.conf`` file. If your ``local.conf`` file does not define |
| 2893 | this variable, the :ref:`icecc <ref-classes-icecc>` class attempts | 2893 | this variable, the :ref:`icecc <ref-classes-icecc>` class attempts |
| 2894 | to define it by locating ``icecc`` using ``which``. | 2894 | to define it by locating ``icecc`` using ``which``. |
| 2895 | 2895 | ||
| 2896 | ICECC_USER_CLASS_BL | 2896 | :term:`ICECC_USER_CLASS_BL` |
| 2897 | Identifies user classes that you do not want the Icecream distributed | 2897 | Identifies user classes that you do not want the Icecream distributed |
| 2898 | compile support to consider. This variable is used by the | 2898 | compile support to consider. This variable is used by the |
| 2899 | :ref:`icecc <ref-classes-icecc>` class. You set this variable in | 2899 | :ref:`icecc <ref-classes-icecc>` class. You set this variable in |
| @@ -2903,7 +2903,7 @@ system and gives an overview of their function and contents. | |||
| 2903 | them from distributed compilation across remote hosts. Any classes | 2903 | them from distributed compilation across remote hosts. Any classes |
| 2904 | you list will be distributed and compiled locally. | 2904 | you list will be distributed and compiled locally. |
| 2905 | 2905 | ||
| 2906 | ICECC_USER_PACKAGE_BL | 2906 | :term:`ICECC_USER_PACKAGE_BL` |
| 2907 | Identifies user recipes that you do not want the Icecream distributed | 2907 | Identifies user recipes that you do not want the Icecream distributed |
| 2908 | compile support to consider. This variable is used by the | 2908 | compile support to consider. This variable is used by the |
| 2909 | :ref:`icecc <ref-classes-icecc>` class. You set this variable in | 2909 | :ref:`icecc <ref-classes-icecc>` class. You set this variable in |
| @@ -2913,7 +2913,7 @@ system and gives an overview of their function and contents. | |||
| 2913 | them from distributed compilation across remote hosts. Any packages | 2913 | them from distributed compilation across remote hosts. Any packages |
| 2914 | you list will be distributed and compiled locally. | 2914 | you list will be distributed and compiled locally. |
| 2915 | 2915 | ||
| 2916 | ICECC_USER_PACKAGE_WL | 2916 | :term:`ICECC_USER_PACKAGE_WL` |
| 2917 | Identifies user recipes that use an empty | 2917 | Identifies user recipes that use an empty |
| 2918 | :term:`PARALLEL_MAKE` variable that you want to | 2918 | :term:`PARALLEL_MAKE` variable that you want to |
| 2919 | force remote distributed compilation on using the Icecream | 2919 | force remote distributed compilation on using the Icecream |
| @@ -2921,11 +2921,11 @@ system and gives an overview of their function and contents. | |||
| 2921 | :ref:`icecc <ref-classes-icecc>` class. You set this variable in | 2921 | :ref:`icecc <ref-classes-icecc>` class. You set this variable in |
| 2922 | your ``local.conf`` file. | 2922 | your ``local.conf`` file. |
| 2923 | 2923 | ||
| 2924 | IMAGE_BASENAME | 2924 | :term:`IMAGE_BASENAME` |
| 2925 | The base name of image output files. This variable defaults to the | 2925 | The base name of image output files. This variable defaults to the |
| 2926 | recipe name (``${``\ :term:`PN`\ ``}``). | 2926 | recipe name (``${``\ :term:`PN`\ ``}``). |
| 2927 | 2927 | ||
| 2928 | IMAGE_EFI_BOOT_FILES | 2928 | :term:`IMAGE_EFI_BOOT_FILES` |
| 2929 | A space-separated list of files installed into the boot partition | 2929 | A space-separated list of files installed into the boot partition |
| 2930 | when preparing an image using the Wic tool with the | 2930 | when preparing an image using the Wic tool with the |
| 2931 | ``bootimg-efi`` source plugin. By default, | 2931 | ``bootimg-efi`` source plugin. By default, |
| @@ -2961,7 +2961,7 @@ system and gives an overview of their function and contents. | |||
| 2961 | material for Wic is located in the | 2961 | material for Wic is located in the |
| 2962 | ":doc:`../ref-manual/ref-kickstart`" chapter. | 2962 | ":doc:`../ref-manual/ref-kickstart`" chapter. |
| 2963 | 2963 | ||
| 2964 | IMAGE_BOOT_FILES | 2964 | :term:`IMAGE_BOOT_FILES` |
| 2965 | A space-separated list of files installed into the boot partition | 2965 | A space-separated list of files installed into the boot partition |
| 2966 | when preparing an image using the Wic tool with the | 2966 | when preparing an image using the Wic tool with the |
| 2967 | ``bootimg-partition`` source plugin. By default, | 2967 | ``bootimg-partition`` source plugin. By default, |
| @@ -2997,7 +2997,7 @@ system and gives an overview of their function and contents. | |||
| 2997 | material for Wic is located in the | 2997 | material for Wic is located in the |
| 2998 | ":doc:`../ref-manual/ref-kickstart`" chapter. | 2998 | ":doc:`../ref-manual/ref-kickstart`" chapter. |
| 2999 | 2999 | ||
| 3000 | IMAGE_CLASSES | 3000 | :term:`IMAGE_CLASSES` |
| 3001 | A list of classes that all images should inherit. You typically use | 3001 | A list of classes that all images should inherit. You typically use |
| 3002 | this variable to specify the list of classes that register the | 3002 | this variable to specify the list of classes that register the |
| 3003 | different types of images the OpenEmbedded build system creates. | 3003 | different types of images the OpenEmbedded build system creates. |
| @@ -3009,7 +3009,7 @@ system and gives an overview of their function and contents. | |||
| 3009 | For more information, see ``meta/classes/image_types.bbclass`` in the | 3009 | For more information, see ``meta/classes/image_types.bbclass`` in the |
| 3010 | :term:`Source Directory`. | 3010 | :term:`Source Directory`. |
| 3011 | 3011 | ||
| 3012 | IMAGE_CMD | 3012 | :term:`IMAGE_CMD` |
| 3013 | Specifies the command to create the image file for a specific image | 3013 | Specifies the command to create the image file for a specific image |
| 3014 | type, which corresponds to the value set set in | 3014 | type, which corresponds to the value set set in |
| 3015 | :term:`IMAGE_FSTYPES`, (e.g. ``ext3``, | 3015 | :term:`IMAGE_FSTYPES`, (e.g. ``ext3``, |
| @@ -3026,7 +3026,7 @@ system and gives an overview of their function and contents. | |||
| 3026 | variable, see the :ref:`image_types <ref-classes-image_types>` | 3026 | variable, see the :ref:`image_types <ref-classes-image_types>` |
| 3027 | class file, which is ``meta/classes/image_types.bbclass``. | 3027 | class file, which is ``meta/classes/image_types.bbclass``. |
| 3028 | 3028 | ||
| 3029 | IMAGE_DEVICE_TABLES | 3029 | :term:`IMAGE_DEVICE_TABLES` |
| 3030 | Specifies one or more files that contain custom device tables that | 3030 | Specifies one or more files that contain custom device tables that |
| 3031 | are passed to the ``makedevs`` command as part of creating an image. | 3031 | are passed to the ``makedevs`` command as part of creating an image. |
| 3032 | These files list basic device nodes that should be created under | 3032 | These files list basic device nodes that should be created under |
| @@ -3036,7 +3036,7 @@ system and gives an overview of their function and contents. | |||
| 3036 | device table files, see ``meta/files/device_table-minimal.txt`` as an | 3036 | device table files, see ``meta/files/device_table-minimal.txt`` as an |
| 3037 | example. | 3037 | example. |
| 3038 | 3038 | ||
| 3039 | IMAGE_FEATURES | 3039 | :term:`IMAGE_FEATURES` |
| 3040 | The primary list of features to include in an image. Typically, you | 3040 | The primary list of features to include in an image. Typically, you |
| 3041 | configure this variable in an image recipe. Although you can use this | 3041 | configure this variable in an image recipe. Although you can use this |
| 3042 | variable from your ``local.conf`` file, which is found in the | 3042 | variable from your ``local.conf`` file, which is found in the |
| @@ -3056,7 +3056,7 @@ system and gives an overview of their function and contents. | |||
| 3056 | variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" | 3056 | variable, see the ":ref:`usingpoky-extend-customimage-imagefeatures`" |
| 3057 | section in the Yocto Project Development Tasks Manual. | 3057 | section in the Yocto Project Development Tasks Manual. |
| 3058 | 3058 | ||
| 3059 | IMAGE_FSTYPES | 3059 | :term:`IMAGE_FSTYPES` |
| 3060 | Specifies the formats the OpenEmbedded build system uses during the | 3060 | Specifies the formats the OpenEmbedded build system uses during the |
| 3061 | build when creating the root filesystem. For example, setting | 3061 | build when creating the root filesystem. For example, setting |
| 3062 | ``IMAGE_FSTYPES`` as follows causes the build system to create root | 3062 | ``IMAGE_FSTYPES`` as follows causes the build system to create root |
| @@ -3079,7 +3079,7 @@ system and gives an overview of their function and contents. | |||
| 3079 | or ``_prepend``. You must use the ``+=`` operator to add one or | 3079 | or ``_prepend``. You must use the ``+=`` operator to add one or |
| 3080 | more options to the ``IMAGE_FSTYPES`` variable. | 3080 | more options to the ``IMAGE_FSTYPES`` variable. |
| 3081 | 3081 | ||
| 3082 | IMAGE_INSTALL | 3082 | :term:`IMAGE_INSTALL` |
| 3083 | Used by recipes to specify the packages to install into an image | 3083 | Used by recipes to specify the packages to install into an image |
| 3084 | through the :ref:`image <ref-classes-image>` class. Use the | 3084 | through the :ref:`image <ref-classes-image>` class. Use the |
| 3085 | ``IMAGE_INSTALL`` variable with care to avoid ordering issues. | 3085 | ``IMAGE_INSTALL`` variable with care to avoid ordering issues. |
| @@ -3129,7 +3129,7 @@ system and gives an overview of their function and contents. | |||
| 3129 | specific situation. In both these cases, the behavior is | 3129 | specific situation. In both these cases, the behavior is |
| 3130 | contrary to how most users expect the ``+=`` operator to work. | 3130 | contrary to how most users expect the ``+=`` operator to work. |
| 3131 | 3131 | ||
| 3132 | IMAGE_LINGUAS | 3132 | :term:`IMAGE_LINGUAS` |
| 3133 | Specifies the list of locales to install into the image during the | 3133 | Specifies the list of locales to install into the image during the |
| 3134 | root filesystem construction process. The OpenEmbedded build system | 3134 | root filesystem construction process. The OpenEmbedded build system |
| 3135 | automatically splits locale files, which are used for localization, | 3135 | automatically splits locale files, which are used for localization, |
| @@ -3151,7 +3151,7 @@ system and gives an overview of their function and contents. | |||
| 3151 | See the :term:`GLIBC_GENERATE_LOCALES` | 3151 | See the :term:`GLIBC_GENERATE_LOCALES` |
| 3152 | variable for information on generating GLIBC locales. | 3152 | variable for information on generating GLIBC locales. |
| 3153 | 3153 | ||
| 3154 | IMAGE_MANIFEST | 3154 | :term:`IMAGE_MANIFEST` |
| 3155 | The manifest file for the image. This file lists all the installed | 3155 | The manifest file for the image. This file lists all the installed |
| 3156 | packages that make up the image. The file contains package | 3156 | packages that make up the image. The file contains package |
| 3157 | information on a line-per-package basis as follows: | 3157 | information on a line-per-package basis as follows: |
| @@ -3171,7 +3171,7 @@ system and gives an overview of their function and contents. | |||
| 3171 | information on how the image is created in the ":ref:`image-generation-dev-environment`" | 3171 | information on how the image is created in the ":ref:`image-generation-dev-environment`" |
| 3172 | section in the Yocto Project Overview and Concepts Manual. | 3172 | section in the Yocto Project Overview and Concepts Manual. |
| 3173 | 3173 | ||
| 3174 | IMAGE_NAME | 3174 | :term:`IMAGE_NAME` |
| 3175 | The name of the output image files minus the extension. This variable | 3175 | The name of the output image files minus the extension. This variable |
| 3176 | is derived using the :term:`IMAGE_BASENAME`, | 3176 | is derived using the :term:`IMAGE_BASENAME`, |
| 3177 | :term:`MACHINE`, and :term:`DATETIME` | 3177 | :term:`MACHINE`, and :term:`DATETIME` |
| @@ -3180,7 +3180,7 @@ system and gives an overview of their function and contents. | |||
| 3180 | 3180 | ||
| 3181 | IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}" | 3181 | IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}" |
| 3182 | 3182 | ||
| 3183 | IMAGE_OVERHEAD_FACTOR | 3183 | :term:`IMAGE_OVERHEAD_FACTOR` |
| 3184 | Defines a multiplier that the build system applies to the initial | 3184 | Defines a multiplier that the build system applies to the initial |
| 3185 | image size for cases when the multiplier times the returned disk | 3185 | image size for cases when the multiplier times the returned disk |
| 3186 | usage value for the image is greater than the sum of | 3186 | usage value for the image is greater than the sum of |
| @@ -3209,7 +3209,7 @@ system and gives an overview of their function and contents. | |||
| 3209 | added to the image by using the ``IMAGE_ROOTFS_EXTRA_SPACE`` | 3209 | added to the image by using the ``IMAGE_ROOTFS_EXTRA_SPACE`` |
| 3210 | variable. | 3210 | variable. |
| 3211 | 3211 | ||
| 3212 | IMAGE_PKGTYPE | 3212 | :term:`IMAGE_PKGTYPE` |
| 3213 | Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the | 3213 | Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the |
| 3214 | OpenEmbedded build system. The variable is defined appropriately by | 3214 | OpenEmbedded build system. The variable is defined appropriately by |
| 3215 | the :ref:`package_deb <ref-classes-package_deb>`, | 3215 | the :ref:`package_deb <ref-classes-package_deb>`, |
| @@ -3242,7 +3242,7 @@ system and gives an overview of their function and contents. | |||
| 3242 | format are never used as a substitute packaging format for DEB, | 3242 | format are never used as a substitute packaging format for DEB, |
| 3243 | RPM, and IPK formatted files for your image or SDK. | 3243 | RPM, and IPK formatted files for your image or SDK. |
| 3244 | 3244 | ||
| 3245 | IMAGE_POSTPROCESS_COMMAND | 3245 | :term:`IMAGE_POSTPROCESS_COMMAND` |
| 3246 | Specifies a list of functions to call once the OpenEmbedded build | 3246 | Specifies a list of functions to call once the OpenEmbedded build |
| 3247 | system creates the final image output files. You can specify | 3247 | system creates the final image output files. You can specify |
| 3248 | functions separated by semicolons: | 3248 | functions separated by semicolons: |
| @@ -3256,7 +3256,7 @@ system and gives an overview of their function and contents. | |||
| 3256 | :term:`IMAGE_ROOTFS` variable for more | 3256 | :term:`IMAGE_ROOTFS` variable for more |
| 3257 | information. | 3257 | information. |
| 3258 | 3258 | ||
| 3259 | IMAGE_PREPROCESS_COMMAND | 3259 | :term:`IMAGE_PREPROCESS_COMMAND` |
| 3260 | Specifies a list of functions to call before the OpenEmbedded build | 3260 | Specifies a list of functions to call before the OpenEmbedded build |
| 3261 | system creates the final image output files. You can specify | 3261 | system creates the final image output files. You can specify |
| 3262 | functions separated by semicolons: | 3262 | functions separated by semicolons: |
| @@ -3270,19 +3270,19 @@ system and gives an overview of their function and contents. | |||
| 3270 | :term:`IMAGE_ROOTFS` variable for more | 3270 | :term:`IMAGE_ROOTFS` variable for more |
| 3271 | information. | 3271 | information. |
| 3272 | 3272 | ||
| 3273 | IMAGE_ROOTFS | 3273 | :term:`IMAGE_ROOTFS` |
| 3274 | The location of the root filesystem while it is under construction | 3274 | The location of the root filesystem while it is under construction |
| 3275 | (i.e. during the :ref:`ref-tasks-rootfs` task). This | 3275 | (i.e. during the :ref:`ref-tasks-rootfs` task). This |
| 3276 | variable is not configurable. Do not change it. | 3276 | variable is not configurable. Do not change it. |
| 3277 | 3277 | ||
| 3278 | IMAGE_ROOTFS_ALIGNMENT | 3278 | :term:`IMAGE_ROOTFS_ALIGNMENT` |
| 3279 | Specifies the alignment for the output image file in Kbytes. If the | 3279 | Specifies the alignment for the output image file in Kbytes. If the |
| 3280 | size of the image is not a multiple of this value, then the size is | 3280 | size of the image is not a multiple of this value, then the size is |
| 3281 | rounded up to the nearest multiple of the value. The default value is | 3281 | rounded up to the nearest multiple of the value. The default value is |
| 3282 | "1". See :term:`IMAGE_ROOTFS_SIZE` for | 3282 | "1". See :term:`IMAGE_ROOTFS_SIZE` for |
| 3283 | additional information. | 3283 | additional information. |
| 3284 | 3284 | ||
| 3285 | IMAGE_ROOTFS_EXTRA_SPACE | 3285 | :term:`IMAGE_ROOTFS_EXTRA_SPACE` |
| 3286 | Defines additional free disk space created in the image in Kbytes. By | 3286 | Defines additional free disk space created in the image in Kbytes. By |
| 3287 | default, this variable is set to "0". This free disk space is added | 3287 | default, this variable is set to "0". This free disk space is added |
| 3288 | to the image after the build system determines the image size as | 3288 | to the image after the build system determines the image size as |
| @@ -3302,7 +3302,7 @@ system and gives an overview of their function and contents. | |||
| 3302 | 3302 | ||
| 3303 | IMAGE_ROOTFS_EXTRA_SPACE = "41943040" | 3303 | IMAGE_ROOTFS_EXTRA_SPACE = "41943040" |
| 3304 | 3304 | ||
| 3305 | IMAGE_ROOTFS_SIZE | 3305 | :term:`IMAGE_ROOTFS_SIZE` |
| 3306 | Defines the size in Kbytes for the generated image. The OpenEmbedded | 3306 | Defines the size in Kbytes for the generated image. The OpenEmbedded |
| 3307 | build system determines the final size for the generated image using | 3307 | build system determines the final size for the generated image using |
| 3308 | an algorithm that takes into account the initial disk space used for | 3308 | an algorithm that takes into account the initial disk space used for |
| @@ -3327,7 +3327,7 @@ system and gives an overview of their function and contents. | |||
| 3327 | and :term:`IMAGE_ROOTFS_EXTRA_SPACE` | 3327 | and :term:`IMAGE_ROOTFS_EXTRA_SPACE` |
| 3328 | variables for related information. | 3328 | variables for related information. |
| 3329 | 3329 | ||
| 3330 | IMAGE_TYPEDEP | 3330 | :term:`IMAGE_TYPEDEP` |
| 3331 | Specifies a dependency from one image type on another. Here is an | 3331 | Specifies a dependency from one image type on another. Here is an |
| 3332 | example from the :ref:`image-live <ref-classes-image-live>` class: | 3332 | example from the :ref:`image-live <ref-classes-image-live>` class: |
| 3333 | :: | 3333 | :: |
| @@ -3340,7 +3340,7 @@ system and gives an overview of their function and contents. | |||
| 3340 | one of the components of the live image is an ``ext3`` formatted | 3340 | one of the components of the live image is an ``ext3`` formatted |
| 3341 | partition containing the root filesystem. | 3341 | partition containing the root filesystem. |
| 3342 | 3342 | ||
| 3343 | IMAGE_TYPES | 3343 | :term:`IMAGE_TYPES` |
| 3344 | Specifies the complete list of supported image types by default: | 3344 | Specifies the complete list of supported image types by default: |
| 3345 | 3345 | ||
| 3346 | - btrfs | 3346 | - btrfs |
| @@ -3385,7 +3385,7 @@ system and gives an overview of their function and contents. | |||
| 3385 | For more information about these types of images, see | 3385 | For more information about these types of images, see |
| 3386 | ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`. | 3386 | ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`. |
| 3387 | 3387 | ||
| 3388 | INC_PR | 3388 | :term:`INC_PR` |
| 3389 | Helps define the recipe revision for recipes that share a common | 3389 | Helps define the recipe revision for recipes that share a common |
| 3390 | ``include`` file. You can think of this variable as part of the | 3390 | ``include`` file. You can think of this variable as part of the |
| 3391 | recipe revision as set from within an include file. | 3391 | recipe revision as set from within an include file. |
| @@ -3423,7 +3423,7 @@ system and gives an overview of their function and contents. | |||
| 3423 | lines in the example are from individual recipes and show how the | 3423 | lines in the example are from individual recipes and show how the |
| 3424 | ``PR`` value is set. | 3424 | ``PR`` value is set. |
| 3425 | 3425 | ||
| 3426 | INCOMPATIBLE_LICENSE | 3426 | :term:`INCOMPATIBLE_LICENSE` |
| 3427 | Specifies a space-separated list of license names (as they would | 3427 | Specifies a space-separated list of license names (as they would |
| 3428 | appear in :term:`LICENSE`) that should be excluded | 3428 | appear in :term:`LICENSE`) that should be excluded |
| 3429 | from the build. Recipes that provide no alternatives to listed | 3429 | from the build. Recipes that provide no alternatives to listed |
| @@ -3465,7 +3465,7 @@ system and gives an overview of their function and contents. | |||
| 3465 | COMPATIBLE_LICENSES | 3465 | COMPATIBLE_LICENSES |
| 3466 | , thus only allowing the latter licences to be used. | 3466 | , thus only allowing the latter licences to be used. |
| 3467 | 3467 | ||
| 3468 | INHERIT | 3468 | :term:`INHERIT` |
| 3469 | Causes the named class or classes to be inherited globally. Anonymous | 3469 | Causes the named class or classes to be inherited globally. Anonymous |
| 3470 | functions in the class or classes are not executed for the base | 3470 | functions in the class or classes are not executed for the base |
| 3471 | configuration and in each individual recipe. The OpenEmbedded build | 3471 | configuration and in each individual recipe. The OpenEmbedded build |
| @@ -3475,7 +3475,7 @@ system and gives an overview of their function and contents. | |||
| 3475 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" | 3475 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" |
| 3476 | section in the Bitbake User Manual. | 3476 | section in the Bitbake User Manual. |
| 3477 | 3477 | ||
| 3478 | INHERIT_DISTRO | 3478 | :term:`INHERIT_DISTRO` |
| 3479 | Lists classes that will be inherited at the distribution level. It is | 3479 | Lists classes that will be inherited at the distribution level. It is |
| 3480 | unlikely that you want to edit this variable. | 3480 | unlikely that you want to edit this variable. |
| 3481 | 3481 | ||
| @@ -3485,7 +3485,7 @@ system and gives an overview of their function and contents. | |||
| 3485 | 3485 | ||
| 3486 | INHERIT_DISTRO ?= "debian devshell sstate license" | 3486 | INHERIT_DISTRO ?= "debian devshell sstate license" |
| 3487 | 3487 | ||
| 3488 | INHIBIT_DEFAULT_DEPS | 3488 | :term:`INHIBIT_DEFAULT_DEPS` |
| 3489 | Prevents the default dependencies, namely the C compiler and standard | 3489 | Prevents the default dependencies, namely the C compiler and standard |
| 3490 | C library (libc), from being added to :term:`DEPENDS`. | 3490 | C library (libc), from being added to :term:`DEPENDS`. |
| 3491 | This variable is usually used within recipes that do not require any | 3491 | This variable is usually used within recipes that do not require any |
| @@ -3494,7 +3494,7 @@ system and gives an overview of their function and contents. | |||
| 3494 | Set the variable to "1" to prevent the default dependencies from | 3494 | Set the variable to "1" to prevent the default dependencies from |
| 3495 | being added. | 3495 | being added. |
| 3496 | 3496 | ||
| 3497 | INHIBIT_PACKAGE_DEBUG_SPLIT | 3497 | :term:`INHIBIT_PACKAGE_DEBUG_SPLIT` |
| 3498 | Prevents the OpenEmbedded build system from splitting out debug | 3498 | Prevents the OpenEmbedded build system from splitting out debug |
| 3499 | information during packaging. By default, the build system splits out | 3499 | information during packaging. By default, the build system splits out |
| 3500 | debugging information during the | 3500 | debugging information during the |
| @@ -3510,7 +3510,7 @@ system and gives an overview of their function and contents. | |||
| 3510 | 3510 | ||
| 3511 | INHIBIT_PACKAGE_DEBUG_SPLIT = "1" | 3511 | INHIBIT_PACKAGE_DEBUG_SPLIT = "1" |
| 3512 | 3512 | ||
| 3513 | INHIBIT_PACKAGE_STRIP | 3513 | :term:`INHIBIT_PACKAGE_STRIP` |
| 3514 | If set to "1", causes the build to not strip binaries in resulting | 3514 | If set to "1", causes the build to not strip binaries in resulting |
| 3515 | packages and prevents the ``-dbg`` package from containing the source | 3515 | packages and prevents the ``-dbg`` package from containing the source |
| 3516 | files. | 3516 | files. |
| @@ -3520,7 +3520,7 @@ system and gives an overview of their function and contents. | |||
| 3520 | Consequently, you should not set ``INHIBIT_PACKAGE_STRIP`` when you | 3520 | Consequently, you should not set ``INHIBIT_PACKAGE_STRIP`` when you |
| 3521 | plan to debug in general. | 3521 | plan to debug in general. |
| 3522 | 3522 | ||
| 3523 | INHIBIT_SYSROOT_STRIP | 3523 | :term:`INHIBIT_SYSROOT_STRIP` |
| 3524 | If set to "1", causes the build to not strip binaries in the | 3524 | If set to "1", causes the build to not strip binaries in the |
| 3525 | resulting sysroot. | 3525 | resulting sysroot. |
| 3526 | 3526 | ||
| @@ -3544,7 +3544,7 @@ system and gives an overview of their function and contents. | |||
| 3544 | strippable, other files exist that are needed for the build that | 3544 | strippable, other files exist that are needed for the build that |
| 3545 | are not strippable. | 3545 | are not strippable. |
| 3546 | 3546 | ||
| 3547 | INITRAMFS_FSTYPES | 3547 | :term:`INITRAMFS_FSTYPES` |
| 3548 | Defines the format for the output image of an initial RAM filesystem | 3548 | Defines the format for the output image of an initial RAM filesystem |
| 3549 | (initramfs), which is used during boot. Supported formats are the | 3549 | (initramfs), which is used during boot. Supported formats are the |
| 3550 | same as those supported by the | 3550 | same as those supported by the |
| @@ -3557,7 +3557,7 @@ system and gives an overview of their function and contents. | |||
| 3557 | `initrd <https://en.wikipedia.org/wiki/Initrd>`__ mechanism, expects | 3557 | `initrd <https://en.wikipedia.org/wiki/Initrd>`__ mechanism, expects |
| 3558 | an optionally compressed cpio archive. | 3558 | an optionally compressed cpio archive. |
| 3559 | 3559 | ||
| 3560 | INITRAMFS_IMAGE | 3560 | :term:`INITRAMFS_IMAGE` |
| 3561 | Specifies the :term:`PROVIDES` name of an image | 3561 | Specifies the :term:`PROVIDES` name of an image |
| 3562 | recipe that is used to build an initial RAM filesystem (initramfs) | 3562 | recipe that is used to build an initial RAM filesystem (initramfs) |
| 3563 | image. In other words, the ``INITRAMFS_IMAGE`` variable causes an | 3563 | image. In other words, the ``INITRAMFS_IMAGE`` variable causes an |
| @@ -3598,7 +3598,7 @@ system and gives an overview of their function and contents. | |||
| 3598 | image, see the ":ref:`building-an-initramfs-image`" section | 3598 | image, see the ":ref:`building-an-initramfs-image`" section |
| 3599 | in the Yocto Project Development Tasks Manual. | 3599 | in the Yocto Project Development Tasks Manual. |
| 3600 | 3600 | ||
| 3601 | INITRAMFS_IMAGE_BUNDLE | 3601 | :term:`INITRAMFS_IMAGE_BUNDLE` |
| 3602 | Controls whether or not the image recipe specified by | 3602 | Controls whether or not the image recipe specified by |
| 3603 | :term:`INITRAMFS_IMAGE` is run through an | 3603 | :term:`INITRAMFS_IMAGE` is run through an |
| 3604 | extra pass | 3604 | extra pass |
| @@ -3648,7 +3648,7 @@ system and gives an overview of their function and contents. | |||
| 3648 | initramfs, see the ":ref:`building-an-initramfs-image`" section | 3648 | initramfs, see the ":ref:`building-an-initramfs-image`" section |
| 3649 | in the Yocto Project Development Tasks Manual. | 3649 | in the Yocto Project Development Tasks Manual. |
| 3650 | 3650 | ||
| 3651 | INITRAMFS_LINK_NAME | 3651 | :term:`INITRAMFS_LINK_NAME` |
| 3652 | The link name of the initial RAM filesystem image. This variable is | 3652 | The link name of the initial RAM filesystem image. This variable is |
| 3653 | set in the ``meta/classes/kernel-artifact-names.bbclass`` file as | 3653 | set in the ``meta/classes/kernel-artifact-names.bbclass`` file as |
| 3654 | follows: | 3654 | follows: |
| @@ -3666,7 +3666,7 @@ system and gives an overview of their function and contents. | |||
| 3666 | See the :term:`MACHINE` variable for additional | 3666 | See the :term:`MACHINE` variable for additional |
| 3667 | information. | 3667 | information. |
| 3668 | 3668 | ||
| 3669 | INITRAMFS_NAME | 3669 | :term:`INITRAMFS_NAME` |
| 3670 | The base name of the initial RAM filesystem image. This variable is | 3670 | The base name of the initial RAM filesystem image. This variable is |
| 3671 | set in the ``meta/classes/kernel-artifact-names.bbclass`` file as | 3671 | set in the ``meta/classes/kernel-artifact-names.bbclass`` file as |
| 3672 | follows: | 3672 | follows: |
| @@ -3680,14 +3680,14 @@ system and gives an overview of their function and contents. | |||
| 3680 | 3680 | ||
| 3681 | KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 3681 | KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
| 3682 | 3682 | ||
| 3683 | INITRD | 3683 | :term:`INITRD` |
| 3684 | Indicates list of filesystem images to concatenate and use as an | 3684 | Indicates list of filesystem images to concatenate and use as an |
| 3685 | initial RAM disk (``initrd``). | 3685 | initial RAM disk (``initrd``). |
| 3686 | 3686 | ||
| 3687 | The ``INITRD`` variable is an optional variable used with the | 3687 | The ``INITRD`` variable is an optional variable used with the |
| 3688 | :ref:`image-live <ref-classes-image-live>` class. | 3688 | :ref:`image-live <ref-classes-image-live>` class. |
| 3689 | 3689 | ||
| 3690 | INITRD_IMAGE | 3690 | :term:`INITRD_IMAGE` |
| 3691 | When building a "live" bootable image (i.e. when | 3691 | When building a "live" bootable image (i.e. when |
| 3692 | :term:`IMAGE_FSTYPES` contains "live"), | 3692 | :term:`IMAGE_FSTYPES` contains "live"), |
| 3693 | ``INITRD_IMAGE`` specifies the image recipe that should be built to | 3693 | ``INITRD_IMAGE`` specifies the image recipe that should be built to |
| @@ -3697,14 +3697,14 @@ system and gives an overview of their function and contents. | |||
| 3697 | See the :ref:`image-live <ref-classes-image-live>` class for more | 3697 | See the :ref:`image-live <ref-classes-image-live>` class for more |
| 3698 | information. | 3698 | information. |
| 3699 | 3699 | ||
| 3700 | INITSCRIPT_NAME | 3700 | :term:`INITSCRIPT_NAME` |
| 3701 | The filename of the initialization script as installed to | 3701 | The filename of the initialization script as installed to |
| 3702 | ``${sysconfdir}/init.d``. | 3702 | ``${sysconfdir}/init.d``. |
| 3703 | 3703 | ||
| 3704 | This variable is used in recipes when using ``update-rc.d.bbclass``. | 3704 | This variable is used in recipes when using ``update-rc.d.bbclass``. |
| 3705 | The variable is mandatory. | 3705 | The variable is mandatory. |
| 3706 | 3706 | ||
| 3707 | INITSCRIPT_PACKAGES | 3707 | :term:`INITSCRIPT_PACKAGES` |
| 3708 | A list of the packages that contain initscripts. If multiple packages | 3708 | A list of the packages that contain initscripts. If multiple packages |
| 3709 | are specified, you need to append the package name to the other | 3709 | are specified, you need to append the package name to the other |
| 3710 | ``INITSCRIPT_*`` as an override. | 3710 | ``INITSCRIPT_*`` as an override. |
| @@ -3713,7 +3713,7 @@ system and gives an overview of their function and contents. | |||
| 3713 | The variable is optional and defaults to the :term:`PN` | 3713 | The variable is optional and defaults to the :term:`PN` |
| 3714 | variable. | 3714 | variable. |
| 3715 | 3715 | ||
| 3716 | INITSCRIPT_PARAMS | 3716 | :term:`INITSCRIPT_PARAMS` |
| 3717 | Specifies the options to pass to ``update-rc.d``. Here is an example: | 3717 | Specifies the options to pass to ``update-rc.d``. Here is an example: |
| 3718 | :: | 3718 | :: |
| 3719 | 3719 | ||
| @@ -3730,7 +3730,7 @@ system and gives an overview of their function and contents. | |||
| 3730 | please see the ``update-rc.d`` manual page at | 3730 | please see the ``update-rc.d`` manual page at |
| 3731 | https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html | 3731 | https://manpages.debian.org/buster/init-system-helpers/update-rc.d.8.en.html |
| 3732 | 3732 | ||
| 3733 | INSANE_SKIP | 3733 | :term:`INSANE_SKIP` |
| 3734 | Specifies the QA checks to skip for a specific package within a | 3734 | Specifies the QA checks to skip for a specific package within a |
| 3735 | recipe. For example, to skip the check for symbolic link ``.so`` | 3735 | recipe. For example, to skip the check for symbolic link ``.so`` |
| 3736 | files in the main package of a recipe, add the following to the | 3736 | files in the main package of a recipe, add the following to the |
| @@ -3743,19 +3743,19 @@ system and gives an overview of their function and contents. | |||
| 3743 | See the ":ref:`insane.bbclass <ref-classes-insane>`" section for a | 3743 | See the ":ref:`insane.bbclass <ref-classes-insane>`" section for a |
| 3744 | list of the valid QA checks you can specify using this variable. | 3744 | list of the valid QA checks you can specify using this variable. |
| 3745 | 3745 | ||
| 3746 | INSTALL_TIMEZONE_FILE | 3746 | :term:`INSTALL_TIMEZONE_FILE` |
| 3747 | By default, the ``tzdata`` recipe packages an ``/etc/timezone`` file. | 3747 | By default, the ``tzdata`` recipe packages an ``/etc/timezone`` file. |
| 3748 | Set the ``INSTALL_TIMEZONE_FILE`` variable to "0" at the | 3748 | Set the ``INSTALL_TIMEZONE_FILE`` variable to "0" at the |
| 3749 | configuration level to disable this behavior. | 3749 | configuration level to disable this behavior. |
| 3750 | 3750 | ||
| 3751 | IPK_FEED_URIS | 3751 | :term:`IPK_FEED_URIS` |
| 3752 | When the IPK backend is in use and package management is enabled on | 3752 | When the IPK backend is in use and package management is enabled on |
| 3753 | the target, you can use this variable to set up ``opkg`` in the | 3753 | the target, you can use this variable to set up ``opkg`` in the |
| 3754 | target image to point to package feeds on a nominated server. Once | 3754 | target image to point to package feeds on a nominated server. Once |
| 3755 | the feed is established, you can perform installations or upgrades | 3755 | the feed is established, you can perform installations or upgrades |
| 3756 | using the package manager at runtime. | 3756 | using the package manager at runtime. |
| 3757 | 3757 | ||
| 3758 | KARCH | 3758 | :term:`KARCH` |
| 3759 | Defines the kernel architecture used when assembling the | 3759 | Defines the kernel architecture used when assembling the |
| 3760 | configuration. Architectures supported for this release are: | 3760 | configuration. Architectures supported for this release are: |
| 3761 | 3761 | ||
| @@ -3768,7 +3768,7 @@ system and gives an overview of their function and contents. | |||
| 3768 | 3768 | ||
| 3769 | You define the ``KARCH`` variable in the :ref:`kernel-dev/kernel-dev-advanced:bsp descriptions`. | 3769 | You define the ``KARCH`` variable in the :ref:`kernel-dev/kernel-dev-advanced:bsp descriptions`. |
| 3770 | 3770 | ||
| 3771 | KBRANCH | 3771 | :term:`KBRANCH` |
| 3772 | A regular expression used by the build process to explicitly identify | 3772 | A regular expression used by the build process to explicitly identify |
| 3773 | the kernel branch that is validated, patched, and configured during a | 3773 | the kernel branch that is validated, patched, and configured during a |
| 3774 | build. You must set this variable to ensure the exact kernel branch | 3774 | build. You must set this variable to ensure the exact kernel branch |
| @@ -3803,7 +3803,7 @@ system and gives an overview of their function and contents. | |||
| 3803 | identify the kernel branch to use when building for each supported | 3803 | identify the kernel branch to use when building for each supported |
| 3804 | BSP. | 3804 | BSP. |
| 3805 | 3805 | ||
| 3806 | KBUILD_DEFCONFIG | 3806 | :term:`KBUILD_DEFCONFIG` |
| 3807 | When used with the :ref:`kernel-yocto <ref-classes-kernel-yocto>` | 3807 | When used with the :ref:`kernel-yocto <ref-classes-kernel-yocto>` |
| 3808 | class, specifies an "in-tree" kernel configuration file for use | 3808 | class, specifies an "in-tree" kernel configuration file for use |
| 3809 | during a kernel build. | 3809 | during a kernel build. |
| @@ -3839,12 +3839,12 @@ system and gives an overview of their function and contents. | |||
| 3839 | ":ref:`kernel-dev/kernel-dev-common:using an "in-tree" \`\`defconfig\`\` file`" | 3839 | ":ref:`kernel-dev/kernel-dev-common:using an "in-tree" \`\`defconfig\`\` file`" |
| 3840 | section in the Yocto Project Linux Kernel Development Manual. | 3840 | section in the Yocto Project Linux Kernel Development Manual. |
| 3841 | 3841 | ||
| 3842 | KERNEL_ALT_IMAGETYPE | 3842 | :term:`KERNEL_ALT_IMAGETYPE` |
| 3843 | Specifies an alternate kernel image type for creation in addition to | 3843 | Specifies an alternate kernel image type for creation in addition to |
| 3844 | the kernel image type specified using the | 3844 | the kernel image type specified using the |
| 3845 | :term:`KERNEL_IMAGETYPE` variable. | 3845 | :term:`KERNEL_IMAGETYPE` variable. |
| 3846 | 3846 | ||
| 3847 | KERNEL_ARTIFACT_NAME | 3847 | :term:`KERNEL_ARTIFACT_NAME` |
| 3848 | Specifies the name of all of the build artifacts. You can change the | 3848 | Specifies the name of all of the build artifacts. You can change the |
| 3849 | name of the artifacts by changing the ``KERNEL_ARTIFACT_NAME`` | 3849 | name of the artifacts by changing the ``KERNEL_ARTIFACT_NAME`` |
| 3850 | variable. | 3850 | variable. |
| @@ -3863,7 +3863,7 @@ system and gives an overview of their function and contents. | |||
| 3863 | 3863 | ||
| 3864 | The IMAGE_VERSION_SUFFIX variable is set to DATETIME. | 3864 | The IMAGE_VERSION_SUFFIX variable is set to DATETIME. |
| 3865 | 3865 | ||
| 3866 | KERNEL_CLASSES | 3866 | :term:`KERNEL_CLASSES` |
| 3867 | A list of classes defining kernel image types that the | 3867 | A list of classes defining kernel image types that the |
| 3868 | :ref:`kernel <ref-classes-kernel>` class should inherit. You | 3868 | :ref:`kernel <ref-classes-kernel>` class should inherit. You |
| 3869 | typically append this variable to enable extended image types. An | 3869 | typically append this variable to enable extended image types. An |
| @@ -3872,7 +3872,7 @@ system and gives an overview of their function and contents. | |||
| 3872 | custom kernel image types with the ``kernel`` class using this | 3872 | custom kernel image types with the ``kernel`` class using this |
| 3873 | variable. | 3873 | variable. |
| 3874 | 3874 | ||
| 3875 | KERNEL_DEVICETREE | 3875 | :term:`KERNEL_DEVICETREE` |
| 3876 | Specifies the name of the generated Linux kernel device tree (i.e. | 3876 | Specifies the name of the generated Linux kernel device tree (i.e. |
| 3877 | the ``.dtb``) file. | 3877 | the ``.dtb``) file. |
| 3878 | 3878 | ||
| @@ -3885,7 +3885,7 @@ system and gives an overview of their function and contents. | |||
| 3885 | :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must | 3885 | :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must |
| 3886 | be inherited. | 3886 | be inherited. |
| 3887 | 3887 | ||
| 3888 | KERNEL_DTB_LINK_NAME | 3888 | :term:`KERNEL_DTB_LINK_NAME` |
| 3889 | The link name of the kernel device tree binary (DTB). This variable | 3889 | The link name of the kernel device tree binary (DTB). This variable |
| 3890 | is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as | 3890 | is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as |
| 3891 | follows: | 3891 | follows: |
| @@ -3903,7 +3903,7 @@ system and gives an overview of their function and contents. | |||
| 3903 | See the :term:`MACHINE` variable for additional | 3903 | See the :term:`MACHINE` variable for additional |
| 3904 | information. | 3904 | information. |
| 3905 | 3905 | ||
| 3906 | KERNEL_DTB_NAME | 3906 | :term:`KERNEL_DTB_NAME` |
| 3907 | The base name of the kernel device tree binary (DTB). This variable | 3907 | The base name of the kernel device tree binary (DTB). This variable |
| 3908 | is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as | 3908 | is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as |
| 3909 | follows: | 3909 | follows: |
| @@ -3917,11 +3917,11 @@ system and gives an overview of their function and contents. | |||
| 3917 | 3917 | ||
| 3918 | KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 3918 | KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
| 3919 | 3919 | ||
| 3920 | KERNEL_EXTRA_ARGS | 3920 | :term:`KERNEL_EXTRA_ARGS` |
| 3921 | Specifies additional ``make`` command-line arguments the OpenEmbedded | 3921 | Specifies additional ``make`` command-line arguments the OpenEmbedded |
| 3922 | build system passes on when compiling the kernel. | 3922 | build system passes on when compiling the kernel. |
| 3923 | 3923 | ||
| 3924 | KERNEL_FEATURES | 3924 | :term:`KERNEL_FEATURES` |
| 3925 | Includes additional kernel metadata. In the OpenEmbedded build | 3925 | Includes additional kernel metadata. In the OpenEmbedded build |
| 3926 | system, the default Board Support Packages (BSPs) | 3926 | system, the default Board Support Packages (BSPs) |
| 3927 | :term:`Metadata` is provided through the | 3927 | :term:`Metadata` is provided through the |
| @@ -3948,7 +3948,7 @@ system and gives an overview of their function and contents. | |||
| 3948 | KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc" | 3948 | KERNEL_FEATURES_append_qemux86 = " cfg/sound.scc cfg/paravirt_kvm.scc" |
| 3949 | KERNEL_FEATURES_append_qemux86-64 = "cfg/sound.scc" | 3949 | KERNEL_FEATURES_append_qemux86-64 = "cfg/sound.scc" |
| 3950 | 3950 | ||
| 3951 | KERNEL_FIT_LINK_NAME | 3951 | :term:`KERNEL_FIT_LINK_NAME` |
| 3952 | The link name of the kernel flattened image tree (FIT) image. This | 3952 | The link name of the kernel flattened image tree (FIT) image. This |
| 3953 | variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` | 3953 | variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` |
| 3954 | file as follows: | 3954 | file as follows: |
| @@ -3966,7 +3966,7 @@ system and gives an overview of their function and contents. | |||
| 3966 | See the :term:`MACHINE` variable for additional | 3966 | See the :term:`MACHINE` variable for additional |
| 3967 | information. | 3967 | information. |
| 3968 | 3968 | ||
| 3969 | KERNEL_FIT_NAME | 3969 | :term:`KERNEL_FIT_NAME` |
| 3970 | The base name of the kernel flattened image tree (FIT) image. This | 3970 | The base name of the kernel flattened image tree (FIT) image. This |
| 3971 | variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` | 3971 | variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` |
| 3972 | file as follows: | 3972 | file as follows: |
| @@ -3980,7 +3980,7 @@ system and gives an overview of their function and contents. | |||
| 3980 | 3980 | ||
| 3981 | KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 3981 | KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
| 3982 | 3982 | ||
| 3983 | KERNEL_IMAGE_LINK_NAME | 3983 | :term:`KERNEL_IMAGE_LINK_NAME` |
| 3984 | The link name for the kernel image. This variable is set in the | 3984 | The link name for the kernel image. This variable is set in the |
| 3985 | ``meta/classes/kernel-artifact-names.bbclass`` file as follows: | 3985 | ``meta/classes/kernel-artifact-names.bbclass`` file as follows: |
| 3986 | :: | 3986 | :: |
| @@ -3997,7 +3997,7 @@ system and gives an overview of their function and contents. | |||
| 3997 | See the :term:`MACHINE` variable for additional | 3997 | See the :term:`MACHINE` variable for additional |
| 3998 | information. | 3998 | information. |
| 3999 | 3999 | ||
| 4000 | KERNEL_IMAGE_MAXSIZE | 4000 | :term:`KERNEL_IMAGE_MAXSIZE` |
| 4001 | Specifies the maximum size of the kernel image file in kilobytes. If | 4001 | Specifies the maximum size of the kernel image file in kilobytes. If |
| 4002 | ``KERNEL_IMAGE_MAXSIZE`` is set, the size of the kernel image file is | 4002 | ``KERNEL_IMAGE_MAXSIZE`` is set, the size of the kernel image file is |
| 4003 | checked against the set value during the | 4003 | checked against the set value during the |
| @@ -4010,7 +4010,7 @@ system and gives an overview of their function and contents. | |||
| 4010 | By default, this variable is not set, which means the size of the | 4010 | By default, this variable is not set, which means the size of the |
| 4011 | kernel image is not checked. | 4011 | kernel image is not checked. |
| 4012 | 4012 | ||
| 4013 | KERNEL_IMAGE_NAME | 4013 | :term:`KERNEL_IMAGE_NAME` |
| 4014 | The base name of the kernel image. This variable is set in the | 4014 | The base name of the kernel image. This variable is set in the |
| 4015 | ``meta/classes/kernel-artifact-names.bbclass`` file as follows: | 4015 | ``meta/classes/kernel-artifact-names.bbclass`` file as follows: |
| 4016 | :: | 4016 | :: |
| @@ -4024,7 +4024,7 @@ system and gives an overview of their function and contents. | |||
| 4024 | 4024 | ||
| 4025 | KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 4025 | KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
| 4026 | 4026 | ||
| 4027 | KERNEL_IMAGETYPE | 4027 | :term:`KERNEL_IMAGETYPE` |
| 4028 | The type of kernel to build for a device, usually set by the machine | 4028 | The type of kernel to build for a device, usually set by the machine |
| 4029 | configuration files and defaults to "zImage". This variable is used | 4029 | configuration files and defaults to "zImage". This variable is used |
| 4030 | when building the kernel and is passed to ``make`` as the target to | 4030 | when building the kernel and is passed to ``make`` as the target to |
| @@ -4033,7 +4033,7 @@ system and gives an overview of their function and contents. | |||
| 4033 | If you want to build an alternate kernel image type, use the | 4033 | If you want to build an alternate kernel image type, use the |
| 4034 | :term:`KERNEL_ALT_IMAGETYPE` variable. | 4034 | :term:`KERNEL_ALT_IMAGETYPE` variable. |
| 4035 | 4035 | ||
| 4036 | KERNEL_MODULE_AUTOLOAD | 4036 | :term:`KERNEL_MODULE_AUTOLOAD` |
| 4037 | Lists kernel modules that need to be auto-loaded during boot. | 4037 | Lists kernel modules that need to be auto-loaded during boot. |
| 4038 | 4038 | ||
| 4039 | .. note:: | 4039 | .. note:: |
| @@ -4065,14 +4065,14 @@ system and gives an overview of their function and contents. | |||
| 4065 | For information on how to populate the ``modname.conf`` file with | 4065 | For information on how to populate the ``modname.conf`` file with |
| 4066 | ``modprobe.d`` syntax lines, see the :term:`KERNEL_MODULE_PROBECONF` variable. | 4066 | ``modprobe.d`` syntax lines, see the :term:`KERNEL_MODULE_PROBECONF` variable. |
| 4067 | 4067 | ||
| 4068 | KERNEL_MODULE_PROBECONF | 4068 | :term:`KERNEL_MODULE_PROBECONF` |
| 4069 | Provides a list of modules for which the OpenEmbedded build system | 4069 | Provides a list of modules for which the OpenEmbedded build system |
| 4070 | expects to find ``module_conf_``\ modname values that specify | 4070 | expects to find ``module_conf_``\ modname values that specify |
| 4071 | configuration for each of the modules. For information on how to | 4071 | configuration for each of the modules. For information on how to |
| 4072 | provide those module configurations, see the | 4072 | provide those module configurations, see the |
| 4073 | :term:`module_conf_* <module_conf>` variable. | 4073 | :term:`module_conf_* <module_conf>` variable. |
| 4074 | 4074 | ||
| 4075 | KERNEL_PATH | 4075 | :term:`KERNEL_PATH` |
| 4076 | The location of the kernel sources. This variable is set to the value | 4076 | The location of the kernel sources. This variable is set to the value |
| 4077 | of the :term:`STAGING_KERNEL_DIR` within | 4077 | of the :term:`STAGING_KERNEL_DIR` within |
| 4078 | the :ref:`module <ref-classes-module>` class. For information on | 4078 | the :ref:`module <ref-classes-module>` class. For information on |
| @@ -4086,7 +4086,7 @@ system and gives an overview of their function and contents. | |||
| 4086 | the ``KERNEL_PATH`` variable. Both variables are common variables | 4086 | the ``KERNEL_PATH`` variable. Both variables are common variables |
| 4087 | used by external Makefiles to point to the kernel source directory. | 4087 | used by external Makefiles to point to the kernel source directory. |
| 4088 | 4088 | ||
| 4089 | KERNEL_SRC | 4089 | :term:`KERNEL_SRC` |
| 4090 | The location of the kernel sources. This variable is set to the value | 4090 | The location of the kernel sources. This variable is set to the value |
| 4091 | of the :term:`STAGING_KERNEL_DIR` within | 4091 | of the :term:`STAGING_KERNEL_DIR` within |
| 4092 | the :ref:`module <ref-classes-module>` class. For information on | 4092 | the :ref:`module <ref-classes-module>` class. For information on |
| @@ -4100,14 +4100,14 @@ system and gives an overview of their function and contents. | |||
| 4100 | to the ``KERNEL_SRC`` variable. Both variables are common variables | 4100 | to the ``KERNEL_SRC`` variable. Both variables are common variables |
| 4101 | used by external Makefiles to point to the kernel source directory. | 4101 | used by external Makefiles to point to the kernel source directory. |
| 4102 | 4102 | ||
| 4103 | KERNEL_VERSION | 4103 | :term:`KERNEL_VERSION` |
| 4104 | Specifies the version of the kernel as extracted from ``version.h`` | 4104 | Specifies the version of the kernel as extracted from ``version.h`` |
| 4105 | or ``utsrelease.h`` within the kernel sources. Effects of setting | 4105 | or ``utsrelease.h`` within the kernel sources. Effects of setting |
| 4106 | this variable do not take affect until the kernel has been | 4106 | this variable do not take affect until the kernel has been |
| 4107 | configured. Consequently, attempting to refer to this variable in | 4107 | configured. Consequently, attempting to refer to this variable in |
| 4108 | contexts prior to configuration will not work. | 4108 | contexts prior to configuration will not work. |
| 4109 | 4109 | ||
| 4110 | KERNELDEPMODDEPEND | 4110 | :term:`KERNELDEPMODDEPEND` |
| 4111 | Specifies whether the data referenced through | 4111 | Specifies whether the data referenced through |
| 4112 | :term:`PKGDATA_DIR` is needed or not. The | 4112 | :term:`PKGDATA_DIR` is needed or not. The |
| 4113 | ``KERNELDEPMODDEPEND`` does not control whether or not that data | 4113 | ``KERNELDEPMODDEPEND`` does not control whether or not that data |
| @@ -4116,7 +4116,7 @@ system and gives an overview of their function and contents. | |||
| 4116 | ``initramfs`` recipe. Setting the variable there when the data is not | 4116 | ``initramfs`` recipe. Setting the variable there when the data is not |
| 4117 | needed avoids a potential dependency loop. | 4117 | needed avoids a potential dependency loop. |
| 4118 | 4118 | ||
| 4119 | KFEATURE_DESCRIPTION | 4119 | :term:`KFEATURE_DESCRIPTION` |
| 4120 | Provides a short description of a configuration fragment. You use | 4120 | Provides a short description of a configuration fragment. You use |
| 4121 | this variable in the ``.scc`` file that describes a configuration | 4121 | this variable in the ``.scc`` file that describes a configuration |
| 4122 | fragment file. Here is the variable used in a file named ``smp.scc`` | 4122 | fragment file. Here is the variable used in a file named ``smp.scc`` |
| @@ -4125,7 +4125,7 @@ system and gives an overview of their function and contents. | |||
| 4125 | 4125 | ||
| 4126 | define KFEATURE_DESCRIPTION "Enable SMP" | 4126 | define KFEATURE_DESCRIPTION "Enable SMP" |
| 4127 | 4127 | ||
| 4128 | KMACHINE | 4128 | :term:`KMACHINE` |
| 4129 | The machine as known by the kernel. Sometimes the machine name used | 4129 | The machine as known by the kernel. Sometimes the machine name used |
| 4130 | by the kernel does not match the machine name used by the | 4130 | by the kernel does not match the machine name used by the |
| 4131 | OpenEmbedded build system. For example, the machine name that the | 4131 | OpenEmbedded build system. For example, the machine name that the |
| @@ -4153,7 +4153,7 @@ system and gives an overview of their function and contents. | |||
| 4153 | However, the OpenEmbedded build system understands the machine as | 4153 | However, the OpenEmbedded build system understands the machine as |
| 4154 | "core2-32-intel-common". | 4154 | "core2-32-intel-common". |
| 4155 | 4155 | ||
| 4156 | KTYPE | 4156 | :term:`KTYPE` |
| 4157 | Defines the kernel type to be used in assembling the configuration. | 4157 | Defines the kernel type to be used in assembling the configuration. |
| 4158 | The linux-yocto recipes define "standard", "tiny", and "preempt-rt" | 4158 | The linux-yocto recipes define "standard", "tiny", and "preempt-rt" |
| 4159 | kernel types. See the ":ref:`kernel-dev/kernel-dev-advanced:kernel types`" | 4159 | kernel types. See the ":ref:`kernel-dev/kernel-dev-advanced:kernel types`" |
| @@ -4167,13 +4167,13 @@ system and gives an overview of their function and contents. | |||
| 4167 | :term:`LINUX_KERNEL_TYPE` value used by the | 4167 | :term:`LINUX_KERNEL_TYPE` value used by the |
| 4168 | kernel recipe. | 4168 | kernel recipe. |
| 4169 | 4169 | ||
| 4170 | LABELS | 4170 | :term:`LABELS` |
| 4171 | Provides a list of targets for automatic configuration. | 4171 | Provides a list of targets for automatic configuration. |
| 4172 | 4172 | ||
| 4173 | See the :ref:`grub-efi <ref-classes-grub-efi>` class for more | 4173 | See the :ref:`grub-efi <ref-classes-grub-efi>` class for more |
| 4174 | information on how this variable is used. | 4174 | information on how this variable is used. |
| 4175 | 4175 | ||
| 4176 | LAYERDEPENDS | 4176 | :term:`LAYERDEPENDS` |
| 4177 | Lists the layers, separated by spaces, on which this recipe depends. | 4177 | Lists the layers, separated by spaces, on which this recipe depends. |
| 4178 | Optionally, you can specify a specific layer version for a dependency | 4178 | Optionally, you can specify a specific layer version for a dependency |
| 4179 | by adding it to the end of the layer name. Here is an example: | 4179 | by adding it to the end of the layer name. Here is an example: |
| @@ -4190,13 +4190,13 @@ system and gives an overview of their function and contents. | |||
| 4190 | the ``conf/layer.conf`` file and must be suffixed with the name of | 4190 | the ``conf/layer.conf`` file and must be suffixed with the name of |
| 4191 | the specific layer (e.g. ``LAYERDEPENDS_mylayer``). | 4191 | the specific layer (e.g. ``LAYERDEPENDS_mylayer``). |
| 4192 | 4192 | ||
| 4193 | LAYERDIR | 4193 | :term:`LAYERDIR` |
| 4194 | When used inside the ``layer.conf`` configuration file, this variable | 4194 | When used inside the ``layer.conf`` configuration file, this variable |
| 4195 | provides the path of the current layer. This variable is not | 4195 | provides the path of the current layer. This variable is not |
| 4196 | available outside of ``layer.conf`` and references are expanded | 4196 | available outside of ``layer.conf`` and references are expanded |
| 4197 | immediately when parsing of the file completes. | 4197 | immediately when parsing of the file completes. |
| 4198 | 4198 | ||
| 4199 | LAYERRECOMMENDS | 4199 | :term:`LAYERRECOMMENDS` |
| 4200 | Lists the layers, separated by spaces, recommended for use with this | 4200 | Lists the layers, separated by spaces, recommended for use with this |
| 4201 | layer. | 4201 | layer. |
| 4202 | 4202 | ||
| @@ -4214,7 +4214,7 @@ system and gives an overview of their function and contents. | |||
| 4214 | suffixed with the name of the specific layer (e.g. | 4214 | suffixed with the name of the specific layer (e.g. |
| 4215 | ``LAYERRECOMMENDS_mylayer``). | 4215 | ``LAYERRECOMMENDS_mylayer``). |
| 4216 | 4216 | ||
| 4217 | LAYERSERIES_COMPAT | 4217 | :term:`LAYERSERIES_COMPAT` |
| 4218 | Lists the versions of the :term:`OpenEmbedded-Core (OE-Core)` for which | 4218 | Lists the versions of the :term:`OpenEmbedded-Core (OE-Core)` for which |
| 4219 | a layer is compatible. Using the ``LAYERSERIES_COMPAT`` variable | 4219 | a layer is compatible. Using the ``LAYERSERIES_COMPAT`` variable |
| 4220 | allows the layer maintainer to indicate which combinations of the | 4220 | allows the layer maintainer to indicate which combinations of the |
| @@ -4243,7 +4243,7 @@ system and gives an overview of their function and contents. | |||
| 4243 | See the ":ref:`dev-manual/dev-manual-common-tasks:creating your own layer`" | 4243 | See the ":ref:`dev-manual/dev-manual-common-tasks:creating your own layer`" |
| 4244 | section in the Yocto Project Development Tasks Manual. | 4244 | section in the Yocto Project Development Tasks Manual. |
| 4245 | 4245 | ||
| 4246 | LAYERVERSION | 4246 | :term:`LAYERVERSION` |
| 4247 | Optionally specifies the version of a layer as a single number. You | 4247 | Optionally specifies the version of a layer as a single number. You |
| 4248 | can use this within :term:`LAYERDEPENDS` for | 4248 | can use this within :term:`LAYERDEPENDS` for |
| 4249 | another layer in order to depend on a specific version of the layer. | 4249 | another layer in order to depend on a specific version of the layer. |
| @@ -4251,10 +4251,10 @@ system and gives an overview of their function and contents. | |||
| 4251 | suffixed with the name of the specific layer (e.g. | 4251 | suffixed with the name of the specific layer (e.g. |
| 4252 | ``LAYERVERSION_mylayer``). | 4252 | ``LAYERVERSION_mylayer``). |
| 4253 | 4253 | ||
| 4254 | LD | 4254 | :term:`LD` |
| 4255 | The minimal command and arguments used to run the linker. | 4255 | The minimal command and arguments used to run the linker. |
| 4256 | 4256 | ||
| 4257 | LDFLAGS | 4257 | :term:`LDFLAGS` |
| 4258 | Specifies the flags to pass to the linker. This variable is exported | 4258 | Specifies the flags to pass to the linker. This variable is exported |
| 4259 | to an environment variable and thus made visible to the software | 4259 | to an environment variable and thus made visible to the software |
| 4260 | being built during the compilation step. | 4260 | being built during the compilation step. |
| @@ -4271,14 +4271,14 @@ system and gives an overview of their function and contents. | |||
| 4271 | - :term:`BUILDSDK_LDFLAGS` when building for | 4271 | - :term:`BUILDSDK_LDFLAGS` when building for |
| 4272 | an SDK (i.e. ``nativesdk-``) | 4272 | an SDK (i.e. ``nativesdk-``) |
| 4273 | 4273 | ||
| 4274 | LEAD_SONAME | 4274 | :term:`LEAD_SONAME` |
| 4275 | Specifies the lead (or primary) compiled library file (i.e. ``.so``) | 4275 | Specifies the lead (or primary) compiled library file (i.e. ``.so``) |
| 4276 | that the :ref:`debian <ref-classes-debian>` class applies its | 4276 | that the :ref:`debian <ref-classes-debian>` class applies its |
| 4277 | naming policy to given a recipe that packages multiple libraries. | 4277 | naming policy to given a recipe that packages multiple libraries. |
| 4278 | 4278 | ||
| 4279 | This variable works in conjunction with the ``debian`` class. | 4279 | This variable works in conjunction with the ``debian`` class. |
| 4280 | 4280 | ||
| 4281 | LIC_FILES_CHKSUM | 4281 | :term:`LIC_FILES_CHKSUM` |
| 4282 | Checksums of the license text in the recipe source code. | 4282 | Checksums of the license text in the recipe source code. |
| 4283 | 4283 | ||
| 4284 | This variable tracks changes in license text of the source code | 4284 | This variable tracks changes in license text of the source code |
| @@ -4292,7 +4292,7 @@ system and gives an overview of their function and contents. | |||
| 4292 | For more information, see the ":ref:`usingpoky-configuring-lic_files_chksum`" | 4292 | For more information, see the ":ref:`usingpoky-configuring-lic_files_chksum`" |
| 4293 | section in the Yocto Project Development Tasks Manual. | 4293 | section in the Yocto Project Development Tasks Manual. |
| 4294 | 4294 | ||
| 4295 | LICENSE | 4295 | :term:`LICENSE` |
| 4296 | The list of source licenses for the recipe. Follow these rules: | 4296 | The list of source licenses for the recipe. Follow these rules: |
| 4297 | 4297 | ||
| 4298 | - Do not use spaces within individual license names. | 4298 | - Do not use spaces within individual license names. |
| @@ -4335,7 +4335,7 @@ system and gives an overview of their function and contents. | |||
| 4335 | LICENSE_${PN} = "GPLv2" | 4335 | LICENSE_${PN} = "GPLv2" |
| 4336 | LICENSE_${PN}-doc = "GFDL-1.2" | 4336 | LICENSE_${PN}-doc = "GFDL-1.2" |
| 4337 | 4337 | ||
| 4338 | LICENSE_CREATE_PACKAGE | 4338 | :term:`LICENSE_CREATE_PACKAGE` |
| 4339 | Setting ``LICENSE_CREATE_PACKAGE`` to "1" causes the OpenEmbedded | 4339 | Setting ``LICENSE_CREATE_PACKAGE`` to "1" causes the OpenEmbedded |
| 4340 | build system to create an extra package (i.e. | 4340 | build system to create an extra package (i.e. |
| 4341 | ``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add | 4341 | ``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add |
| @@ -4358,7 +4358,7 @@ system and gives an overview of their function and contents. | |||
| 4358 | ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" | 4358 | ":ref:`dev-manual/dev-manual-common-tasks:providing license text`" |
| 4359 | section in the Yocto Project Development Tasks Manual. | 4359 | section in the Yocto Project Development Tasks Manual. |
| 4360 | 4360 | ||
| 4361 | LICENSE_FLAGS | 4361 | :term:`LICENSE_FLAGS` |
| 4362 | Specifies additional flags for a recipe you must whitelist through | 4362 | Specifies additional flags for a recipe you must whitelist through |
| 4363 | :term:`LICENSE_FLAGS_WHITELIST` in | 4363 | :term:`LICENSE_FLAGS_WHITELIST` in |
| 4364 | order to allow the recipe to be built. When providing multiple flags, | 4364 | order to allow the recipe to be built. When providing multiple flags, |
| @@ -4371,7 +4371,7 @@ system and gives an overview of their function and contents. | |||
| 4371 | ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" | 4371 | ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" |
| 4372 | section in the Yocto Project Development Tasks Manual. | 4372 | section in the Yocto Project Development Tasks Manual. |
| 4373 | 4373 | ||
| 4374 | LICENSE_FLAGS_WHITELIST | 4374 | :term:`LICENSE_FLAGS_WHITELIST` |
| 4375 | Lists license flags that when specified in | 4375 | Lists license flags that when specified in |
| 4376 | :term:`LICENSE_FLAGS` within a recipe should not | 4376 | :term:`LICENSE_FLAGS` within a recipe should not |
| 4377 | prevent that recipe from being built. This practice is otherwise | 4377 | prevent that recipe from being built. This practice is otherwise |
| @@ -4379,7 +4379,7 @@ system and gives an overview of their function and contents. | |||
| 4379 | ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" | 4379 | ":ref:`dev-manual/dev-manual-common-tasks:enabling commercially licensed recipes`" |
| 4380 | section in the Yocto Project Development Tasks Manual. | 4380 | section in the Yocto Project Development Tasks Manual. |
| 4381 | 4381 | ||
| 4382 | LICENSE_PATH | 4382 | :term:`LICENSE_PATH` |
| 4383 | Path to additional licenses used during the build. By default, the | 4383 | Path to additional licenses used during the build. By default, the |
| 4384 | OpenEmbedded build system uses ``COMMON_LICENSE_DIR`` to define the | 4384 | OpenEmbedded build system uses ``COMMON_LICENSE_DIR`` to define the |
| 4385 | directory that holds common license text used during the build. The | 4385 | directory that holds common license text used during the build. The |
| @@ -4389,7 +4389,7 @@ system and gives an overview of their function and contents. | |||
| 4389 | 4389 | ||
| 4390 | LICENSE_PATH += "path-to-additional-common-licenses" | 4390 | LICENSE_PATH += "path-to-additional-common-licenses" |
| 4391 | 4391 | ||
| 4392 | LINUX_KERNEL_TYPE | 4392 | :term:`LINUX_KERNEL_TYPE` |
| 4393 | Defines the kernel type to be used in assembling the configuration. | 4393 | Defines the kernel type to be used in assembling the configuration. |
| 4394 | The linux-yocto recipes define "standard", "tiny", and "preempt-rt" | 4394 | The linux-yocto recipes define "standard", "tiny", and "preempt-rt" |
| 4395 | kernel types. See the ":ref:`kernel-dev/kernel-dev-advanced:kernel types`" | 4395 | kernel types. See the ":ref:`kernel-dev/kernel-dev-advanced:kernel types`" |
| @@ -4404,7 +4404,7 @@ system and gives an overview of their function and contents. | |||
| 4404 | kernel :term:`Metadata` with which to build out the sources | 4404 | kernel :term:`Metadata` with which to build out the sources |
| 4405 | and configuration. | 4405 | and configuration. |
| 4406 | 4406 | ||
| 4407 | LINUX_VERSION | 4407 | :term:`LINUX_VERSION` |
| 4408 | The Linux version from ``kernel.org`` on which the Linux kernel image | 4408 | The Linux version from ``kernel.org`` on which the Linux kernel image |
| 4409 | being built using the OpenEmbedded build system is based. You define | 4409 | being built using the OpenEmbedded build system is based. You define |
| 4410 | this variable in the kernel recipe. For example, the | 4410 | this variable in the kernel recipe. For example, the |
| @@ -4420,7 +4420,7 @@ system and gives an overview of their function and contents. | |||
| 4420 | 4420 | ||
| 4421 | PV = "${LINUX_VERSION}+git${SRCPV}" | 4421 | PV = "${LINUX_VERSION}+git${SRCPV}" |
| 4422 | 4422 | ||
| 4423 | LINUX_VERSION_EXTENSION | 4423 | :term:`LINUX_VERSION_EXTENSION` |
| 4424 | A string extension compiled into the version string of the Linux | 4424 | A string extension compiled into the version string of the Linux |
| 4425 | kernel built with the OpenEmbedded build system. You define this | 4425 | kernel built with the OpenEmbedded build system. You define this |
| 4426 | variable in the kernel recipe. For example, the linux-yocto kernel | 4426 | variable in the kernel recipe. For example, the linux-yocto kernel |
| @@ -4438,14 +4438,14 @@ system and gives an overview of their function and contents. | |||
| 4438 | $ uname -r | 4438 | $ uname -r |
| 4439 | 3.7.0-rc8-custom | 4439 | 3.7.0-rc8-custom |
| 4440 | 4440 | ||
| 4441 | LOG_DIR | 4441 | :term:`LOG_DIR` |
| 4442 | Specifies the directory to which the OpenEmbedded build system writes | 4442 | Specifies the directory to which the OpenEmbedded build system writes |
| 4443 | overall log files. The default directory is ``${TMPDIR}/log``. | 4443 | overall log files. The default directory is ``${TMPDIR}/log``. |
| 4444 | 4444 | ||
| 4445 | For the directory containing logs specific to each task, see the | 4445 | For the directory containing logs specific to each task, see the |
| 4446 | :term:`T` variable. | 4446 | :term:`T` variable. |
| 4447 | 4447 | ||
| 4448 | MACHINE | 4448 | :term:`MACHINE` |
| 4449 | Specifies the target device for which the image is built. You define | 4449 | Specifies the target device for which the image is built. You define |
| 4450 | ``MACHINE`` in the ``local.conf`` file found in the | 4450 | ``MACHINE`` in the ``local.conf`` file found in the |
| 4451 | :term:`Build Directory`. By default, ``MACHINE`` is set to | 4451 | :term:`Build Directory`. By default, ``MACHINE`` is set to |
| @@ -4488,13 +4488,13 @@ system and gives an overview of their function and contents. | |||
| 4488 | MACHINE | 4488 | MACHINE |
| 4489 | . | 4489 | . |
| 4490 | 4490 | ||
| 4491 | MACHINE_ARCH | 4491 | :term:`MACHINE_ARCH` |
| 4492 | Specifies the name of the machine-specific architecture. This | 4492 | Specifies the name of the machine-specific architecture. This |
| 4493 | variable is set automatically from :term:`MACHINE` or | 4493 | variable is set automatically from :term:`MACHINE` or |
| 4494 | :term:`TUNE_PKGARCH`. You should not hand-edit | 4494 | :term:`TUNE_PKGARCH`. You should not hand-edit |
| 4495 | the ``MACHINE_ARCH`` variable. | 4495 | the ``MACHINE_ARCH`` variable. |
| 4496 | 4496 | ||
| 4497 | MACHINE_ESSENTIAL_EXTRA_RDEPENDS | 4497 | :term:`MACHINE_ESSENTIAL_EXTRA_RDEPENDS` |
| 4498 | A list of required machine-specific packages to install as part of | 4498 | A list of required machine-specific packages to install as part of |
| 4499 | the image being built. The build process depends on these packages | 4499 | the image being built. The build process depends on these packages |
| 4500 | being present. Furthermore, because this is a "machine-essential" | 4500 | being present. Furthermore, because this is a "machine-essential" |
| @@ -4517,7 +4517,7 @@ system and gives an overview of their function and contents. | |||
| 4517 | 4517 | ||
| 4518 | MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init" | 4518 | MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "example-init" |
| 4519 | 4519 | ||
| 4520 | MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS | 4520 | :term:`MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS` |
| 4521 | A list of recommended machine-specific packages to install as part of | 4521 | A list of recommended machine-specific packages to install as part of |
| 4522 | the image being built. The build process does not depend on these | 4522 | the image being built. The build process does not depend on these |
| 4523 | packages being present. However, because this is a | 4523 | packages being present. However, because this is a |
| @@ -4562,7 +4562,7 @@ system and gives an overview of their function and contents. | |||
| 4562 | Some examples of these machine essentials are flash, screen, | 4562 | Some examples of these machine essentials are flash, screen, |
| 4563 | keyboard, mouse, or touchscreen drivers (depending on the machine). | 4563 | keyboard, mouse, or touchscreen drivers (depending on the machine). |
| 4564 | 4564 | ||
| 4565 | MACHINE_EXTRA_RDEPENDS | 4565 | :term:`MACHINE_EXTRA_RDEPENDS` |
| 4566 | A list of machine-specific packages to install as part of the image | 4566 | A list of machine-specific packages to install as part of the image |
| 4567 | being built that are not essential for the machine to boot. However, | 4567 | being built that are not essential for the machine to boot. However, |
| 4568 | the build process for more fully-featured images depends on the | 4568 | the build process for more fully-featured images depends on the |
| @@ -4589,7 +4589,7 @@ system and gives an overview of their function and contents. | |||
| 4589 | 4589 | ||
| 4590 | MACHINE_EXTRA_RDEPENDS += "wifidriver-firmware" | 4590 | MACHINE_EXTRA_RDEPENDS += "wifidriver-firmware" |
| 4591 | 4591 | ||
| 4592 | MACHINE_EXTRA_RRECOMMENDS | 4592 | :term:`MACHINE_EXTRA_RRECOMMENDS` |
| 4593 | A list of machine-specific packages to install as part of the image | 4593 | A list of machine-specific packages to install as part of the image |
| 4594 | being built that are not essential for booting the machine. The image | 4594 | being built that are not essential for booting the machine. The image |
| 4595 | being built has no build dependency on this list of packages. | 4595 | being built has no build dependency on this list of packages. |
| @@ -4616,7 +4616,7 @@ system and gives an overview of their function and contents. | |||
| 4616 | 4616 | ||
| 4617 | MACHINE_EXTRA_RRECOMMENDS += "kernel-module-examplewifi" | 4617 | MACHINE_EXTRA_RRECOMMENDS += "kernel-module-examplewifi" |
| 4618 | 4618 | ||
| 4619 | MACHINE_FEATURES | 4619 | :term:`MACHINE_FEATURES` |
| 4620 | Specifies the list of hardware features the | 4620 | Specifies the list of hardware features the |
| 4621 | :term:`MACHINE` is capable of supporting. For related | 4621 | :term:`MACHINE` is capable of supporting. For related |
| 4622 | information on enabling features, see the | 4622 | information on enabling features, see the |
| @@ -4628,7 +4628,7 @@ system and gives an overview of their function and contents. | |||
| 4628 | shipped, see the "`Machine Features <#ref-features-machine>`__" | 4628 | shipped, see the "`Machine Features <#ref-features-machine>`__" |
| 4629 | section. | 4629 | section. |
| 4630 | 4630 | ||
| 4631 | MACHINE_FEATURES_BACKFILL | 4631 | :term:`MACHINE_FEATURES_BACKFILL` |
| 4632 | Features to be added to ``MACHINE_FEATURES`` if not also present in | 4632 | Features to be added to ``MACHINE_FEATURES`` if not also present in |
| 4633 | ``MACHINE_FEATURES_BACKFILL_CONSIDERED``. | 4633 | ``MACHINE_FEATURES_BACKFILL_CONSIDERED``. |
| 4634 | 4634 | ||
| @@ -4639,13 +4639,13 @@ system and gives an overview of their function and contents. | |||
| 4639 | Backfilling <#ref-features-backfill>`__" section for more | 4639 | Backfilling <#ref-features-backfill>`__" section for more |
| 4640 | information. | 4640 | information. |
| 4641 | 4641 | ||
| 4642 | MACHINE_FEATURES_BACKFILL_CONSIDERED | 4642 | :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED` |
| 4643 | Features from ``MACHINE_FEATURES_BACKFILL`` that should not be | 4643 | Features from ``MACHINE_FEATURES_BACKFILL`` that should not be |
| 4644 | backfilled (i.e. added to ``MACHINE_FEATURES``) during the build. See | 4644 | backfilled (i.e. added to ``MACHINE_FEATURES``) during the build. See |
| 4645 | the "`Feature Backfilling <#ref-features-backfill>`__" section for | 4645 | the "`Feature Backfilling <#ref-features-backfill>`__" section for |
| 4646 | more information. | 4646 | more information. |
| 4647 | 4647 | ||
| 4648 | MACHINEOVERRIDES | 4648 | :term:`MACHINEOVERRIDES` |
| 4649 | A colon-separated list of overrides that apply to the current | 4649 | A colon-separated list of overrides that apply to the current |
| 4650 | machine. By default, this list includes the value of | 4650 | machine. By default, this list includes the value of |
| 4651 | :term:`MACHINE`. | 4651 | :term:`MACHINE`. |
| @@ -4673,10 +4673,10 @@ system and gives an overview of their function and contents. | |||
| 4673 | ``MACHINEOVERRIDES`` is simply that it is included in the default | 4673 | ``MACHINEOVERRIDES`` is simply that it is included in the default |
| 4674 | value of :term:`OVERRIDES`. | 4674 | value of :term:`OVERRIDES`. |
| 4675 | 4675 | ||
| 4676 | MAINTAINER | 4676 | :term:`MAINTAINER` |
| 4677 | The email address of the distribution maintainer. | 4677 | The email address of the distribution maintainer. |
| 4678 | 4678 | ||
| 4679 | MIRRORS | 4679 | :term:`MIRRORS` |
| 4680 | Specifies additional paths from which the OpenEmbedded build system | 4680 | Specifies additional paths from which the OpenEmbedded build system |
| 4681 | gets source code. When the build system searches for source code, it | 4681 | gets source code. When the build system searches for source code, it |
| 4682 | first tries the local download directory. If that location fails, the | 4682 | first tries the local download directory. If that location fails, the |
| @@ -4688,7 +4688,7 @@ system and gives an overview of their function and contents. | |||
| 4688 | the default value for ``MIRRORS`` is defined in the | 4688 | the default value for ``MIRRORS`` is defined in the |
| 4689 | ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. | 4689 | ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. |
| 4690 | 4690 | ||
| 4691 | MLPREFIX | 4691 | :term:`MLPREFIX` |
| 4692 | Specifies a prefix has been added to :term:`PN` to create a | 4692 | Specifies a prefix has been added to :term:`PN` to create a |
| 4693 | special version of a recipe or package (i.e. a Multilib version). The | 4693 | special version of a recipe or package (i.e. a Multilib version). The |
| 4694 | variable is used in places where the prefix needs to be added to or | 4694 | variable is used in places where the prefix needs to be added to or |
| @@ -4775,12 +4775,12 @@ system and gives an overview of their function and contents. | |||
| 4775 | For information on how to specify kernel modules to auto-load on | 4775 | For information on how to specify kernel modules to auto-load on |
| 4776 | boot, see the :term:`KERNEL_MODULE_AUTOLOAD` variable. | 4776 | boot, see the :term:`KERNEL_MODULE_AUTOLOAD` variable. |
| 4777 | 4777 | ||
| 4778 | MODULE_TARBALL_DEPLOY | 4778 | :term:`MODULE_TARBALL_DEPLOY` |
| 4779 | Controls creation of the ``modules-*.tgz`` file. Set this variable to | 4779 | Controls creation of the ``modules-*.tgz`` file. Set this variable to |
| 4780 | "0" to disable creation of this file, which contains all of the | 4780 | "0" to disable creation of this file, which contains all of the |
| 4781 | kernel modules resulting from a kernel build. | 4781 | kernel modules resulting from a kernel build. |
| 4782 | 4782 | ||
| 4783 | MODULE_TARBALL_LINK_NAME | 4783 | :term:`MODULE_TARBALL_LINK_NAME` |
| 4784 | The link name of the kernel module tarball. This variable is set in | 4784 | The link name of the kernel module tarball. This variable is set in |
| 4785 | the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: | 4785 | the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: |
| 4786 | :: | 4786 | :: |
| @@ -4796,7 +4796,7 @@ system and gives an overview of their function and contents. | |||
| 4796 | 4796 | ||
| 4797 | See the :term:`MACHINE` variable for additional information. | 4797 | See the :term:`MACHINE` variable for additional information. |
| 4798 | 4798 | ||
| 4799 | MODULE_TARBALL_NAME | 4799 | :term:`MODULE_TARBALL_NAME` |
| 4800 | The base name of the kernel module tarball. This variable is set in | 4800 | The base name of the kernel module tarball. This variable is set in |
| 4801 | the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: | 4801 | the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: |
| 4802 | :: | 4802 | :: |
| @@ -4809,7 +4809,7 @@ system and gives an overview of their function and contents. | |||
| 4809 | 4809 | ||
| 4810 | KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 4810 | KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
| 4811 | 4811 | ||
| 4812 | MULTIMACH_TARGET_SYS | 4812 | :term:`MULTIMACH_TARGET_SYS` |
| 4813 | Uniquely identifies the type of the target system for which packages | 4813 | Uniquely identifies the type of the target system for which packages |
| 4814 | are being built. This variable allows output for different types of | 4814 | are being built. This variable allows output for different types of |
| 4815 | target systems to be put into different subdirectories of the same | 4815 | target systems to be put into different subdirectories of the same |
| @@ -4827,7 +4827,7 @@ system and gives an overview of their function and contents. | |||
| 4827 | See the :term:`STAMP` variable for an example. See the | 4827 | See the :term:`STAMP` variable for an example. See the |
| 4828 | :term:`STAGING_DIR_TARGET` variable for more information. | 4828 | :term:`STAGING_DIR_TARGET` variable for more information. |
| 4829 | 4829 | ||
| 4830 | NATIVELSBSTRING | 4830 | :term:`NATIVELSBSTRING` |
| 4831 | A string identifying the host distribution. Strings consist of the | 4831 | A string identifying the host distribution. Strings consist of the |
| 4832 | host distributor ID followed by the release, as reported by the | 4832 | host distributor ID followed by the release, as reported by the |
| 4833 | ``lsb_release`` tool or as read from ``/etc/lsb-release``. For | 4833 | ``lsb_release`` tool or as read from ``/etc/lsb-release``. For |
| @@ -4842,10 +4842,10 @@ system and gives an overview of their function and contents. | |||
| 4842 | :term:`SANITY_TESTED_DISTROS` if that | 4842 | :term:`SANITY_TESTED_DISTROS` if that |
| 4843 | variable is set. | 4843 | variable is set. |
| 4844 | 4844 | ||
| 4845 | NM | 4845 | :term:`NM` |
| 4846 | The minimal command and arguments to run ``nm``. | 4846 | The minimal command and arguments to run ``nm``. |
| 4847 | 4847 | ||
| 4848 | NO_GENERIC_LICENSE | 4848 | :term:`NO_GENERIC_LICENSE` |
| 4849 | Avoids QA errors when you use a non-common, non-CLOSED license in a | 4849 | Avoids QA errors when you use a non-common, non-CLOSED license in a |
| 4850 | recipe. Packages exist, such as the linux-firmware package, with many | 4850 | recipe. Packages exist, such as the linux-firmware package, with many |
| 4851 | licenses that are not in any way common. Also, new licenses are added | 4851 | licenses that are not in any way common. Also, new licenses are added |
| @@ -4867,7 +4867,7 @@ system and gives an overview of their function and contents. | |||
| 4867 | 4867 | ||
| 4868 | NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" | 4868 | NO_GENERIC_LICENSE[Firmware-Abilis] = "LICENSE.Abilis.txt" |
| 4869 | 4869 | ||
| 4870 | NO_RECOMMENDATIONS | 4870 | :term:`NO_RECOMMENDATIONS` |
| 4871 | Prevents installation of all "recommended-only" packages. | 4871 | Prevents installation of all "recommended-only" packages. |
| 4872 | Recommended-only packages are packages installed only through the | 4872 | Recommended-only packages are packages installed only through the |
| 4873 | :term:`RRECOMMENDS` variable). Setting the | 4873 | :term:`RRECOMMENDS` variable). Setting the |
| @@ -4900,7 +4900,7 @@ system and gives an overview of their function and contents. | |||
| 4900 | the :term:`PACKAGE_EXCLUDE` variables for | 4900 | the :term:`PACKAGE_EXCLUDE` variables for |
| 4901 | related information. | 4901 | related information. |
| 4902 | 4902 | ||
| 4903 | NOAUTOPACKAGEDEBUG | 4903 | :term:`NOAUTOPACKAGEDEBUG` |
| 4904 | Disables auto package from splitting ``.debug`` files. If a recipe | 4904 | Disables auto package from splitting ``.debug`` files. If a recipe |
| 4905 | requires ``FILES_${PN}-dbg`` to be set manually, the | 4905 | requires ``FILES_${PN}-dbg`` to be set manually, the |
| 4906 | ``NOAUTOPACKAGEDEBUG`` can be defined allowing you to define the | 4906 | ``NOAUTOPACKAGEDEBUG`` can be defined allowing you to define the |
| @@ -4912,13 +4912,13 @@ system and gives an overview of their function and contents. | |||
| 4912 | FILES_${PN}-dbg = "/usr/src/debug/" | 4912 | FILES_${PN}-dbg = "/usr/src/debug/" |
| 4913 | FILES_${QT_BASE_NAME}-demos-doc = "${docdir}/${QT_DIR_NAME}/qch/qt.qch" | 4913 | FILES_${QT_BASE_NAME}-demos-doc = "${docdir}/${QT_DIR_NAME}/qch/qt.qch" |
| 4914 | 4914 | ||
| 4915 | OBJCOPY | 4915 | :term:`OBJCOPY` |
| 4916 | The minimal command and arguments to run ``objcopy``. | 4916 | The minimal command and arguments to run ``objcopy``. |
| 4917 | 4917 | ||
| 4918 | OBJDUMP | 4918 | :term:`OBJDUMP` |
| 4919 | The minimal command and arguments to run ``objdump``. | 4919 | The minimal command and arguments to run ``objdump``. |
| 4920 | 4920 | ||
| 4921 | OE_BINCONFIG_EXTRA_MANGLE | 4921 | :term:`OE_BINCONFIG_EXTRA_MANGLE` |
| 4922 | When inheriting the :ref:`binconfig <ref-classes-binconfig>` class, | 4922 | When inheriting the :ref:`binconfig <ref-classes-binconfig>` class, |
| 4923 | this variable specifies additional arguments passed to the "sed" | 4923 | this variable specifies additional arguments passed to the "sed" |
| 4924 | command. The sed command alters any paths in configuration scripts | 4924 | command. The sed command alters any paths in configuration scripts |
| @@ -4933,7 +4933,7 @@ system and gives an overview of their function and contents. | |||
| 4933 | information on the ``binconfig`` class, see the | 4933 | information on the ``binconfig`` class, see the |
| 4934 | ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section. | 4934 | ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section. |
| 4935 | 4935 | ||
| 4936 | OE_IMPORTS | 4936 | :term:`OE_IMPORTS` |
| 4937 | An internal variable used to tell the OpenEmbedded build system what | 4937 | An internal variable used to tell the OpenEmbedded build system what |
| 4938 | Python modules to import for every Python function run by the system. | 4938 | Python modules to import for every Python function run by the system. |
| 4939 | 4939 | ||
| @@ -4941,7 +4941,7 @@ system and gives an overview of their function and contents. | |||
| 4941 | 4941 | ||
| 4942 | Do not set this variable. It is for internal use only. | 4942 | Do not set this variable. It is for internal use only. |
| 4943 | 4943 | ||
| 4944 | OE_INIT_ENV_SCRIPT | 4944 | :term:`OE_INIT_ENV_SCRIPT` |
| 4945 | The name of the build environment setup script for the purposes of | 4945 | The name of the build environment setup script for the purposes of |
| 4946 | setting up the environment within the extensible SDK. The default | 4946 | setting up the environment within the extensible SDK. The default |
| 4947 | value is "oe-init-build-env". | 4947 | value is "oe-init-build-env". |
| @@ -4949,7 +4949,7 @@ system and gives an overview of their function and contents. | |||
| 4949 | If you use a custom script to set up your build environment, set the | 4949 | If you use a custom script to set up your build environment, set the |
| 4950 | ``OE_INIT_ENV_SCRIPT`` variable to its name. | 4950 | ``OE_INIT_ENV_SCRIPT`` variable to its name. |
| 4951 | 4951 | ||
| 4952 | OE_TERMINAL | 4952 | :term:`OE_TERMINAL` |
| 4953 | Controls how the OpenEmbedded build system spawns interactive | 4953 | Controls how the OpenEmbedded build system spawns interactive |
| 4954 | terminals on the host development system (e.g. using the BitBake | 4954 | terminals on the host development system (e.g. using the BitBake |
| 4955 | command with the ``-c devshell`` command-line option). For more | 4955 | command with the ``-c devshell`` command-line option). For more |
| @@ -4966,7 +4966,7 @@ system and gives an overview of their function and contents. | |||
| 4966 | - konsole | 4966 | - konsole |
| 4967 | - none | 4967 | - none |
| 4968 | 4968 | ||
| 4969 | OEROOT | 4969 | :term:`OEROOT` |
| 4970 | The directory from which the top-level build environment setup script | 4970 | The directory from which the top-level build environment setup script |
| 4971 | is sourced. The Yocto Project provides a top-level build environment | 4971 | is sourced. The Yocto Project provides a top-level build environment |
| 4972 | setup script: ````` <#structure-core-script>`__. When you run this | 4972 | setup script: ````` <#structure-core-script>`__. When you run this |
| @@ -4976,7 +4976,7 @@ system and gives an overview of their function and contents. | |||
| 4976 | For additional information on how this variable is used, see the | 4976 | For additional information on how this variable is used, see the |
| 4977 | initialization script. | 4977 | initialization script. |
| 4978 | 4978 | ||
| 4979 | OLDEST_KERNEL | 4979 | :term:`OLDEST_KERNEL` |
| 4980 | Declares the oldest version of the Linux kernel that the produced | 4980 | Declares the oldest version of the Linux kernel that the produced |
| 4981 | binaries must support. This variable is passed into the build of the | 4981 | binaries must support. This variable is passed into the build of the |
| 4982 | Embedded GNU C Library (``glibc``). | 4982 | Embedded GNU C Library (``glibc``). |
| @@ -4986,7 +4986,7 @@ system and gives an overview of their function and contents. | |||
| 4986 | default by setting the variable in a custom distribution | 4986 | default by setting the variable in a custom distribution |
| 4987 | configuration file. | 4987 | configuration file. |
| 4988 | 4988 | ||
| 4989 | OVERRIDES | 4989 | :term:`OVERRIDES` |
| 4990 | A colon-separated list of overrides that currently apply. Overrides | 4990 | A colon-separated list of overrides that currently apply. Overrides |
| 4991 | are a BitBake mechanism that allows variables to be selectively | 4991 | are a BitBake mechanism that allows variables to be selectively |
| 4992 | overridden at the end of parsing. The set of overrides in | 4992 | overridden at the end of parsing. The set of overrides in |
| @@ -5029,13 +5029,13 @@ system and gives an overview of their function and contents. | |||
| 5029 | " section in the Yocto Project Development Tasks Manual for more | 5029 | " section in the Yocto Project Development Tasks Manual for more |
| 5030 | information. | 5030 | information. |
| 5031 | 5031 | ||
| 5032 | P | 5032 | :term:`P` |
| 5033 | The recipe name and version. ``P`` is comprised of the following: | 5033 | The recipe name and version. ``P`` is comprised of the following: |
| 5034 | :: | 5034 | :: |
| 5035 | 5035 | ||
| 5036 | ${PN}-${PV} | 5036 | ${PN}-${PV} |
| 5037 | 5037 | ||
| 5038 | PACKAGE_ADD_METADATA | 5038 | :term:`PACKAGE_ADD_METADATA` |
| 5039 | This variable defines additional metdata to add to packages. | 5039 | This variable defines additional metdata to add to packages. |
| 5040 | 5040 | ||
| 5041 | You may find you need to inject additional metadata into packages. | 5041 | You may find you need to inject additional metadata into packages. |
| @@ -5051,7 +5051,7 @@ system and gives an overview of their function and contents. | |||
| 5051 | ":ref:`dev-manual/dev-manual-common-tasks:adding custom metadata to packages`" | 5051 | ":ref:`dev-manual/dev-manual-common-tasks:adding custom metadata to packages`" |
| 5052 | section in the Yocto Project Development Tasks Manual. | 5052 | section in the Yocto Project Development Tasks Manual. |
| 5053 | 5053 | ||
| 5054 | PACKAGE_ARCH | 5054 | :term:`PACKAGE_ARCH` |
| 5055 | The architecture of the resulting package or packages. | 5055 | The architecture of the resulting package or packages. |
| 5056 | 5056 | ||
| 5057 | By default, the value of this variable is set to | 5057 | By default, the value of this variable is set to |
| @@ -5074,19 +5074,19 @@ system and gives an overview of their function and contents. | |||
| 5074 | 5074 | ||
| 5075 | PACKAGE_ARCH = "${MACHINE_ARCH}" | 5075 | PACKAGE_ARCH = "${MACHINE_ARCH}" |
| 5076 | 5076 | ||
| 5077 | PACKAGE_ARCHS | 5077 | :term:`PACKAGE_ARCHS` |
| 5078 | Specifies a list of architectures compatible with the target machine. | 5078 | Specifies a list of architectures compatible with the target machine. |
| 5079 | This variable is set automatically and should not normally be | 5079 | This variable is set automatically and should not normally be |
| 5080 | hand-edited. Entries are separated using spaces and listed in order | 5080 | hand-edited. Entries are separated using spaces and listed in order |
| 5081 | of priority. The default value for ``PACKAGE_ARCHS`` is "all any | 5081 | of priority. The default value for ``PACKAGE_ARCHS`` is "all any |
| 5082 | noarch ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}". | 5082 | noarch ${PACKAGE_EXTRA_ARCHS} ${MACHINE_ARCH}". |
| 5083 | 5083 | ||
| 5084 | PACKAGE_BEFORE_PN | 5084 | :term:`PACKAGE_BEFORE_PN` |
| 5085 | Enables easily adding packages to ``PACKAGES`` before ``${PN}`` so | 5085 | Enables easily adding packages to ``PACKAGES`` before ``${PN}`` so |
| 5086 | that those added packages can pick up files that would normally be | 5086 | that those added packages can pick up files that would normally be |
| 5087 | included in the default package. | 5087 | included in the default package. |
| 5088 | 5088 | ||
| 5089 | PACKAGE_CLASSES | 5089 | :term:`PACKAGE_CLASSES` |
| 5090 | This variable, which is set in the ``local.conf`` configuration file | 5090 | This variable, which is set in the ``local.conf`` configuration file |
| 5091 | found in the ``conf`` folder of the | 5091 | found in the ``conf`` folder of the |
| 5092 | :term:`Build Directory`, specifies the package manager the | 5092 | :term:`Build Directory`, specifies the package manager the |
| @@ -5119,7 +5119,7 @@ system and gives an overview of their function and contents. | |||
| 5119 | result of the package manager in use, see the | 5119 | result of the package manager in use, see the |
| 5120 | ":ref:`package.bbclass <ref-classes-package>`" section. | 5120 | ":ref:`package.bbclass <ref-classes-package>`" section. |
| 5121 | 5121 | ||
| 5122 | PACKAGE_DEBUG_SPLIT_STYLE | 5122 | :term:`PACKAGE_DEBUG_SPLIT_STYLE` |
| 5123 | Determines how to split up the binary and debug information when | 5123 | Determines how to split up the binary and debug information when |
| 5124 | creating ``*-dbg`` packages to be used with the GNU Project Debugger | 5124 | creating ``*-dbg`` packages to be used with the GNU Project Debugger |
| 5125 | (GDB). | 5125 | (GDB). |
| @@ -5152,7 +5152,7 @@ system and gives an overview of their function and contents. | |||
| 5152 | ":ref:`platdev-gdb-remotedebug`" section | 5152 | ":ref:`platdev-gdb-remotedebug`" section |
| 5153 | in the Yocto Project Development Tasks Manual. | 5153 | in the Yocto Project Development Tasks Manual. |
| 5154 | 5154 | ||
| 5155 | PACKAGE_EXCLUDE_COMPLEMENTARY | 5155 | :term:`PACKAGE_EXCLUDE_COMPLEMENTARY` |
| 5156 | Prevents specific packages from being installed when you are | 5156 | Prevents specific packages from being installed when you are |
| 5157 | installing complementary packages. | 5157 | installing complementary packages. |
| 5158 | 5158 | ||
| @@ -5164,7 +5164,7 @@ system and gives an overview of their function and contents. | |||
| 5164 | use the ``PACKAGE_EXCLUDE_COMPLEMENTARY`` variable to specify regular | 5164 | use the ``PACKAGE_EXCLUDE_COMPLEMENTARY`` variable to specify regular |
| 5165 | expressions to match the packages you want to exclude. | 5165 | expressions to match the packages you want to exclude. |
| 5166 | 5166 | ||
| 5167 | PACKAGE_EXCLUDE | 5167 | :term:`PACKAGE_EXCLUDE` |
| 5168 | Lists packages that should not be installed into an image. For | 5168 | Lists packages that should not be installed into an image. For |
| 5169 | example: | 5169 | example: |
| 5170 | :: | 5170 | :: |
| @@ -5193,12 +5193,12 @@ system and gives an overview of their function and contents. | |||
| 5193 | :term:`BAD_RECOMMENDATIONS` variables for | 5193 | :term:`BAD_RECOMMENDATIONS` variables for |
| 5194 | related information. | 5194 | related information. |
| 5195 | 5195 | ||
| 5196 | PACKAGE_EXTRA_ARCHS | 5196 | :term:`PACKAGE_EXTRA_ARCHS` |
| 5197 | Specifies the list of architectures compatible with the device CPU. | 5197 | Specifies the list of architectures compatible with the device CPU. |
| 5198 | This variable is useful when you build for several different devices | 5198 | This variable is useful when you build for several different devices |
| 5199 | that use miscellaneous processors such as XScale and ARM926-EJS. | 5199 | that use miscellaneous processors such as XScale and ARM926-EJS. |
| 5200 | 5200 | ||
| 5201 | PACKAGE_FEED_ARCHS | 5201 | :term:`PACKAGE_FEED_ARCHS` |
| 5202 | Optionally specifies the package architectures used as part of the | 5202 | Optionally specifies the package architectures used as part of the |
| 5203 | package feed URIs during the build. When used, the | 5203 | package feed URIs during the build. When used, the |
| 5204 | ``PACKAGE_FEED_ARCHS`` variable is appended to the final package feed | 5204 | ``PACKAGE_FEED_ARCHS`` variable is appended to the final package feed |
| @@ -5239,7 +5239,7 @@ system and gives an overview of their function and contents. | |||
| 5239 | https://example.com/packagerepos/updates/rpm-dev/all | 5239 | https://example.com/packagerepos/updates/rpm-dev/all |
| 5240 | https://example.com/packagerepos/updates/rpm-dev/core2-64 | 5240 | https://example.com/packagerepos/updates/rpm-dev/core2-64 |
| 5241 | 5241 | ||
| 5242 | PACKAGE_FEED_BASE_PATHS | 5242 | :term:`PACKAGE_FEED_BASE_PATHS` |
| 5243 | Specifies the base path used when constructing package feed URIs. The | 5243 | Specifies the base path used when constructing package feed URIs. The |
| 5244 | ``PACKAGE_FEED_BASE_PATHS`` variable makes up the middle portion of a | 5244 | ``PACKAGE_FEED_BASE_PATHS`` variable makes up the middle portion of a |
| 5245 | package feed URI used by the OpenEmbedded build system. The base path | 5245 | package feed URI used by the OpenEmbedded build system. The base path |
| @@ -5268,7 +5268,7 @@ system and gives an overview of their function and contents. | |||
| 5268 | https://example.com/packagerepos/updates/rpm-dev/all | 5268 | https://example.com/packagerepos/updates/rpm-dev/all |
| 5269 | https://example.com/packagerepos/updates/rpm-dev/core2-64 | 5269 | https://example.com/packagerepos/updates/rpm-dev/core2-64 |
| 5270 | 5270 | ||
| 5271 | PACKAGE_FEED_URIS | 5271 | :term:`PACKAGE_FEED_URIS` |
| 5272 | Specifies the front portion of the package feed URI used by the | 5272 | Specifies the front portion of the package feed URI used by the |
| 5273 | OpenEmbedded build system. Each final package feed URI is comprised | 5273 | OpenEmbedded build system. Each final package feed URI is comprised |
| 5274 | of ``PACKAGE_FEED_URIS``, | 5274 | of ``PACKAGE_FEED_URIS``, |
| @@ -5297,7 +5297,7 @@ system and gives an overview of their function and contents. | |||
| 5297 | https://example.com/packagerepos/updates/rpm-dev/all | 5297 | https://example.com/packagerepos/updates/rpm-dev/all |
| 5298 | https://example.com/packagerepos/updates/rpm-dev/core2-64 | 5298 | https://example.com/packagerepos/updates/rpm-dev/core2-64 |
| 5299 | 5299 | ||
| 5300 | PACKAGE_INSTALL | 5300 | :term:`PACKAGE_INSTALL` |
| 5301 | The final list of packages passed to the package manager for | 5301 | The final list of packages passed to the package manager for |
| 5302 | installation into the image. | 5302 | installation into the image. |
| 5303 | 5303 | ||
| @@ -5315,18 +5315,18 @@ system and gives an overview of their function and contents. | |||
| 5315 | initramfs, see the ":ref:`building-an-initramfs-image`" section | 5315 | initramfs, see the ":ref:`building-an-initramfs-image`" section |
| 5316 | in the Yocto Project Development Tasks Manual. | 5316 | in the Yocto Project Development Tasks Manual. |
| 5317 | 5317 | ||
| 5318 | PACKAGE_INSTALL_ATTEMPTONLY | 5318 | :term:`PACKAGE_INSTALL_ATTEMPTONLY` |
| 5319 | Specifies a list of packages the OpenEmbedded build system attempts | 5319 | Specifies a list of packages the OpenEmbedded build system attempts |
| 5320 | to install when creating an image. If a listed package fails to | 5320 | to install when creating an image. If a listed package fails to |
| 5321 | install, the build system does not generate an error. This variable | 5321 | install, the build system does not generate an error. This variable |
| 5322 | is generally not user-defined. | 5322 | is generally not user-defined. |
| 5323 | 5323 | ||
| 5324 | PACKAGE_PREPROCESS_FUNCS | 5324 | :term:`PACKAGE_PREPROCESS_FUNCS` |
| 5325 | Specifies a list of functions run to pre-process the | 5325 | Specifies a list of functions run to pre-process the |
| 5326 | :term:`PKGD` directory prior to splitting the files out | 5326 | :term:`PKGD` directory prior to splitting the files out |
| 5327 | to individual packages. | 5327 | to individual packages. |
| 5328 | 5328 | ||
| 5329 | PACKAGE_WRITE_DEPS | 5329 | :term:`PACKAGE_WRITE_DEPS` |
| 5330 | Specifies a list of dependencies for post-installation and | 5330 | Specifies a list of dependencies for post-installation and |
| 5331 | pre-installation scripts on native/cross tools. If your | 5331 | pre-installation scripts on native/cross tools. If your |
| 5332 | post-installation or pre-installation script can execute at rootfs | 5332 | post-installation or pre-installation script can execute at rootfs |
| @@ -5338,7 +5338,7 @@ system and gives an overview of their function and contents. | |||
| 5338 | ":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`" | 5338 | ":ref:`dev-manual/dev-manual-common-tasks:post-installation scripts`" |
| 5339 | section in the Yocto Project Development Tasks Manual. | 5339 | section in the Yocto Project Development Tasks Manual. |
| 5340 | 5340 | ||
| 5341 | PACKAGECONFIG | 5341 | :term:`PACKAGECONFIG` |
| 5342 | This variable provides a means of enabling or disabling features of a | 5342 | This variable provides a means of enabling or disabling features of a |
| 5343 | recipe on a per-recipe basis. ``PACKAGECONFIG`` blocks are defined in | 5343 | recipe on a per-recipe basis. ``PACKAGECONFIG`` blocks are defined in |
| 5344 | recipes when you specify features and then arguments that define | 5344 | recipes when you specify features and then arguments that define |
| @@ -5430,7 +5430,7 @@ system and gives an overview of their function and contents. | |||
| 5430 | 5430 | ||
| 5431 | PACKAGECONFIG_append_pn-recipename = " f4" | 5431 | PACKAGECONFIG_append_pn-recipename = " f4" |
| 5432 | 5432 | ||
| 5433 | PACKAGECONFIG_CONFARGS | 5433 | :term:`PACKAGECONFIG_CONFARGS` |
| 5434 | A space-separated list of configuration options generated from the | 5434 | A space-separated list of configuration options generated from the |
| 5435 | :term:`PACKAGECONFIG` setting. | 5435 | :term:`PACKAGECONFIG` setting. |
| 5436 | 5436 | ||
| @@ -5441,7 +5441,7 @@ system and gives an overview of their function and contents. | |||
| 5441 | handles the ``do_configure`` task, then you need to use | 5441 | handles the ``do_configure`` task, then you need to use |
| 5442 | ``PACKAGECONFIG_CONFARGS`` appropriately. | 5442 | ``PACKAGECONFIG_CONFARGS`` appropriately. |
| 5443 | 5443 | ||
| 5444 | PACKAGEGROUP_DISABLE_COMPLEMENTARY | 5444 | :term:`PACKAGEGROUP_DISABLE_COMPLEMENTARY` |
| 5445 | For recipes inheriting the | 5445 | For recipes inheriting the |
| 5446 | :ref:`packagegroup <ref-classes-packagegroup>` class, setting | 5446 | :ref:`packagegroup <ref-classes-packagegroup>` class, setting |
| 5447 | ``PACKAGEGROUP_DISABLE_COMPLEMENTARY`` to "1" specifies that the | 5447 | ``PACKAGEGROUP_DISABLE_COMPLEMENTARY`` to "1" specifies that the |
| @@ -5449,7 +5449,7 @@ system and gives an overview of their function and contents. | |||
| 5449 | should not be automatically created by the ``packagegroup`` recipe, | 5449 | should not be automatically created by the ``packagegroup`` recipe, |
| 5450 | which is the default behavior. | 5450 | which is the default behavior. |
| 5451 | 5451 | ||
| 5452 | PACKAGES | 5452 | :term:`PACKAGES` |
| 5453 | The list of packages the recipe creates. The default value is the | 5453 | The list of packages the recipe creates. The default value is the |
| 5454 | following: | 5454 | following: |
| 5455 | :: | 5455 | :: |
| @@ -5469,7 +5469,7 @@ system and gives an overview of their function and contents. | |||
| 5469 | unless generation is forced through the | 5469 | unless generation is forced through the |
| 5470 | :term:`ALLOW_EMPTY` variable. | 5470 | :term:`ALLOW_EMPTY` variable. |
| 5471 | 5471 | ||
| 5472 | PACKAGES_DYNAMIC | 5472 | :term:`PACKAGES_DYNAMIC` |
| 5473 | A promise that your recipe satisfies runtime dependencies for | 5473 | A promise that your recipe satisfies runtime dependencies for |
| 5474 | optional modules that are found in other recipes. | 5474 | optional modules that are found in other recipes. |
| 5475 | ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it | 5475 | ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it |
| @@ -5492,7 +5492,7 @@ system and gives an overview of their function and contents. | |||
| 5492 | ":ref:`dev-manual/dev-manual-common-tasks:handling optional module packaging`" | 5492 | ":ref:`dev-manual/dev-manual-common-tasks:handling optional module packaging`" |
| 5493 | section in the Yocto Project Development Tasks Manual. | 5493 | section in the Yocto Project Development Tasks Manual. |
| 5494 | 5494 | ||
| 5495 | PACKAGESPLITFUNCS | 5495 | :term:`PACKAGESPLITFUNCS` |
| 5496 | Specifies a list of functions run to perform additional splitting of | 5496 | Specifies a list of functions run to perform additional splitting of |
| 5497 | files into individual packages. Recipes can either prepend to this | 5497 | files into individual packages. Recipes can either prepend to this |
| 5498 | variable or prepend to the ``populate_packages`` function in order to | 5498 | variable or prepend to the ``populate_packages`` function in order to |
| @@ -5502,7 +5502,7 @@ system and gives an overview of their function and contents. | |||
| 5502 | other packaging variables appropriately in order to perform the | 5502 | other packaging variables appropriately in order to perform the |
| 5503 | desired splitting. | 5503 | desired splitting. |
| 5504 | 5504 | ||
| 5505 | PARALLEL_MAKE | 5505 | :term:`PARALLEL_MAKE` |
| 5506 | Extra options passed to the ``make`` command during the | 5506 | Extra options passed to the ``make`` command during the |
| 5507 | :ref:`ref-tasks-compile` task in order to specify | 5507 | :ref:`ref-tasks-compile` task in order to specify |
| 5508 | parallel compilation on the local build host. This variable is | 5508 | parallel compilation on the local build host. This variable is |
| @@ -5548,7 +5548,7 @@ system and gives an overview of their function and contents. | |||
| 5548 | ":ref:`dev-manual/dev-manual-common-tasks:speeding up a build`" | 5548 | ":ref:`dev-manual/dev-manual-common-tasks:speeding up a build`" |
| 5549 | section in the Yocto Project Development Tasks Manual. | 5549 | section in the Yocto Project Development Tasks Manual. |
| 5550 | 5550 | ||
| 5551 | PARALLEL_MAKEINST | 5551 | :term:`PARALLEL_MAKEINST` |
| 5552 | Extra options passed to the ``make install`` command during the | 5552 | Extra options passed to the ``make install`` command during the |
| 5553 | :ref:`ref-tasks-install` task in order to specify | 5553 | :ref:`ref-tasks-install` task in order to specify |
| 5554 | parallel installation. This variable defaults to the value of | 5554 | parallel installation. This variable defaults to the value of |
| @@ -5568,7 +5568,7 @@ system and gives an overview of their function and contents. | |||
| 5568 | ":ref:`dev-manual/dev-manual-common-tasks:debugging parallel make races`" | 5568 | ":ref:`dev-manual/dev-manual-common-tasks:debugging parallel make races`" |
| 5569 | section in the Yocto Project Development Tasks Manual. | 5569 | section in the Yocto Project Development Tasks Manual. |
| 5570 | 5570 | ||
| 5571 | PATCHRESOLVE | 5571 | :term:`PATCHRESOLVE` |
| 5572 | Determines the action to take when a patch fails. You can set this | 5572 | Determines the action to take when a patch fails. You can set this |
| 5573 | variable to one of two values: "noop" and "user". | 5573 | variable to one of two values: "noop" and "user". |
| 5574 | 5574 | ||
| @@ -5580,7 +5580,7 @@ system and gives an overview of their function and contents. | |||
| 5580 | 5580 | ||
| 5581 | Set this variable in your ``local.conf`` file. | 5581 | Set this variable in your ``local.conf`` file. |
| 5582 | 5582 | ||
| 5583 | PATCHTOOL | 5583 | :term:`PATCHTOOL` |
| 5584 | Specifies the utility used to apply patches for a recipe during the | 5584 | Specifies the utility used to apply patches for a recipe during the |
| 5585 | :ref:`ref-tasks-patch` task. You can specify one of | 5585 | :ref:`ref-tasks-patch` task. You can specify one of |
| 5586 | three utilities: "patch", "quilt", or "git". The default utility used | 5586 | three utilities: "patch", "quilt", or "git". The default utility used |
| @@ -5596,20 +5596,20 @@ system and gives an overview of their function and contents. | |||
| 5596 | PATCHTOOL = "quilt" | 5596 | PATCHTOOL = "quilt" |
| 5597 | PATCHTOOL = "git" | 5597 | PATCHTOOL = "git" |
| 5598 | 5598 | ||
| 5599 | PE | 5599 | :term:`PE` |
| 5600 | The epoch of the recipe. By default, this variable is unset. The | 5600 | The epoch of the recipe. By default, this variable is unset. The |
| 5601 | variable is used to make upgrades possible when the versioning scheme | 5601 | variable is used to make upgrades possible when the versioning scheme |
| 5602 | changes in some backwards incompatible way. | 5602 | changes in some backwards incompatible way. |
| 5603 | 5603 | ||
| 5604 | ``PE`` is the default value of the :term:`PKGE` variable. | 5604 | ``PE`` is the default value of the :term:`PKGE` variable. |
| 5605 | 5605 | ||
| 5606 | PF | 5606 | :term:`PF` |
| 5607 | Specifies the recipe or package name and includes all version and | 5607 | Specifies the recipe or package name and includes all version and |
| 5608 | revision numbers (i.e. ``glibc-2.13-r20+svnr15508/`` and | 5608 | revision numbers (i.e. ``glibc-2.13-r20+svnr15508/`` and |
| 5609 | ``bash-4.2-r1/``). This variable is comprised of the following: | 5609 | ``bash-4.2-r1/``). This variable is comprised of the following: |
| 5610 | ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`} | 5610 | ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`} |
| 5611 | 5611 | ||
| 5612 | PIXBUF_PACKAGES | 5612 | :term:`PIXBUF_PACKAGES` |
| 5613 | When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>` | 5613 | When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>` |
| 5614 | class, this variable identifies packages that contain the pixbuf | 5614 | class, this variable identifies packages that contain the pixbuf |
| 5615 | loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache`` | 5615 | loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache`` |
| @@ -5617,7 +5617,7 @@ system and gives an overview of their function and contents. | |||
| 5617 | ``${``\ :term:`PN`\ ``}``). Use this variable if the | 5617 | ``${``\ :term:`PN`\ ``}``). Use this variable if the |
| 5618 | loaders you need are in a package other than that main package. | 5618 | loaders you need are in a package other than that main package. |
| 5619 | 5619 | ||
| 5620 | PKG | 5620 | :term:`PKG` |
| 5621 | The name of the resulting package created by the OpenEmbedded build | 5621 | The name of the resulting package created by the OpenEmbedded build |
| 5622 | system. | 5622 | system. |
| 5623 | 5623 | ||
| @@ -5631,11 +5631,11 @@ system and gives an overview of their function and contents. | |||
| 5631 | renames the output package, it does so by setting | 5631 | renames the output package, it does so by setting |
| 5632 | ``PKG_packagename``. | 5632 | ``PKG_packagename``. |
| 5633 | 5633 | ||
| 5634 | PKG_CONFIG_PATH | 5634 | :term:`PKG_CONFIG_PATH` |
| 5635 | The path to ``pkg-config`` files for the current build context. | 5635 | The path to ``pkg-config`` files for the current build context. |
| 5636 | ``pkg-config`` reads this variable from the environment. | 5636 | ``pkg-config`` reads this variable from the environment. |
| 5637 | 5637 | ||
| 5638 | PKGD | 5638 | :term:`PKGD` |
| 5639 | Points to the destination directory for files to be packaged before | 5639 | Points to the destination directory for files to be packaged before |
| 5640 | they are split into individual packages. This directory defaults to | 5640 | they are split into individual packages. This directory defaults to |
| 5641 | the following: | 5641 | the following: |
| @@ -5645,7 +5645,7 @@ system and gives an overview of their function and contents. | |||
| 5645 | 5645 | ||
| 5646 | Do not change this default. | 5646 | Do not change this default. |
| 5647 | 5647 | ||
| 5648 | PKGDATA_DIR | 5648 | :term:`PKGDATA_DIR` |
| 5649 | Points to a shared, global-state directory that holds data generated | 5649 | Points to a shared, global-state directory that holds data generated |
| 5650 | during the packaging process. During the packaging process, the | 5650 | during the packaging process. During the packaging process, the |
| 5651 | :ref:`ref-tasks-packagedata` task packages data | 5651 | :ref:`ref-tasks-packagedata` task packages data |
| @@ -5664,7 +5664,7 @@ system and gives an overview of their function and contents. | |||
| 5664 | information on the shared, global-state directory, see | 5664 | information on the shared, global-state directory, see |
| 5665 | :term:`STAGING_DIR_HOST`. | 5665 | :term:`STAGING_DIR_HOST`. |
| 5666 | 5666 | ||
| 5667 | PKGDEST | 5667 | :term:`PKGDEST` |
| 5668 | Points to the parent directory for files to be packaged after they | 5668 | Points to the parent directory for files to be packaged after they |
| 5669 | have been split into individual packages. This directory defaults to | 5669 | have been split into individual packages. This directory defaults to |
| 5670 | the following: | 5670 | the following: |
| @@ -5676,7 +5676,7 @@ system and gives an overview of their function and contents. | |||
| 5676 | package specified in :term:`PACKAGES`. Do not change | 5676 | package specified in :term:`PACKAGES`. Do not change |
| 5677 | this default. | 5677 | this default. |
| 5678 | 5678 | ||
| 5679 | PKGDESTWORK | 5679 | :term:`PKGDESTWORK` |
| 5680 | Points to a temporary work area where the | 5680 | Points to a temporary work area where the |
| 5681 | :ref:`ref-tasks-package` task saves package metadata. | 5681 | :ref:`ref-tasks-package` task saves package metadata. |
| 5682 | The ``PKGDESTWORK`` location defaults to the following: | 5682 | The ``PKGDESTWORK`` location defaults to the following: |
| @@ -5690,19 +5690,19 @@ system and gives an overview of their function and contents. | |||
| 5690 | package metadata from ``PKGDESTWORK`` to | 5690 | package metadata from ``PKGDESTWORK`` to |
| 5691 | :term:`PKGDATA_DIR` to make it available globally. | 5691 | :term:`PKGDATA_DIR` to make it available globally. |
| 5692 | 5692 | ||
| 5693 | PKGE | 5693 | :term:`PKGE` |
| 5694 | The epoch of the package(s) built by the recipe. By default, ``PKGE`` | 5694 | The epoch of the package(s) built by the recipe. By default, ``PKGE`` |
| 5695 | is set to :term:`PE`. | 5695 | is set to :term:`PE`. |
| 5696 | 5696 | ||
| 5697 | PKGR | 5697 | :term:`PKGR` |
| 5698 | The revision of the package(s) built by the recipe. By default, | 5698 | The revision of the package(s) built by the recipe. By default, |
| 5699 | ``PKGR`` is set to :term:`PR`. | 5699 | ``PKGR`` is set to :term:`PR`. |
| 5700 | 5700 | ||
| 5701 | PKGV | 5701 | :term:`PKGV` |
| 5702 | The version of the package(s) built by the recipe. By default, | 5702 | The version of the package(s) built by the recipe. By default, |
| 5703 | ``PKGV`` is set to :term:`PV`. | 5703 | ``PKGV`` is set to :term:`PV`. |
| 5704 | 5704 | ||
| 5705 | PN | 5705 | :term:`PN` |
| 5706 | This variable can have two separate functions depending on the | 5706 | This variable can have two separate functions depending on the |
| 5707 | context: a recipe name or a resulting package name. | 5707 | context: a recipe name or a resulting package name. |
| 5708 | 5708 | ||
| @@ -5721,7 +5721,7 @@ system and gives an overview of their function and contents. | |||
| 5721 | packages for the target and for Multilib, ``PN`` would be ``bash`` | 5721 | packages for the target and for Multilib, ``PN`` would be ``bash`` |
| 5722 | and ``lib64-bash``, respectively. | 5722 | and ``lib64-bash``, respectively. |
| 5723 | 5723 | ||
| 5724 | PNBLACKLIST | 5724 | :term:`PNBLACKLIST` |
| 5725 | Lists recipes you do not want the OpenEmbedded build system to build. | 5725 | Lists recipes you do not want the OpenEmbedded build system to build. |
| 5726 | This variable works in conjunction with the | 5726 | This variable works in conjunction with the |
| 5727 | :ref:`blacklist <ref-classes-blacklist>` class, which is inherited | 5727 | :ref:`blacklist <ref-classes-blacklist>` class, which is inherited |
| @@ -5734,7 +5734,7 @@ system and gives an overview of their function and contents. | |||
| 5734 | 5734 | ||
| 5735 | PNBLACKLIST[myrecipe] = "Not supported by our organization." | 5735 | PNBLACKLIST[myrecipe] = "Not supported by our organization." |
| 5736 | 5736 | ||
| 5737 | POPULATE_SDK_POST_HOST_COMMAND | 5737 | :term:`POPULATE_SDK_POST_HOST_COMMAND` |
| 5738 | Specifies a list of functions to call once the OpenEmbedded build | 5738 | Specifies a list of functions to call once the OpenEmbedded build |
| 5739 | system has created the host part of the SDK. You can specify | 5739 | system has created the host part of the SDK. You can specify |
| 5740 | functions separated by semicolons: | 5740 | functions separated by semicolons: |
| @@ -5747,7 +5747,7 @@ system and gives an overview of their function and contents. | |||
| 5747 | the OpenEmbedded build system when creating SDK output. See the | 5747 | the OpenEmbedded build system when creating SDK output. See the |
| 5748 | :term:`SDK_DIR` variable for more information. | 5748 | :term:`SDK_DIR` variable for more information. |
| 5749 | 5749 | ||
| 5750 | POPULATE_SDK_POST_TARGET_COMMAND | 5750 | :term:`POPULATE_SDK_POST_TARGET_COMMAND` |
| 5751 | Specifies a list of functions to call once the OpenEmbedded build | 5751 | Specifies a list of functions to call once the OpenEmbedded build |
| 5752 | system has created the target part of the SDK. You can specify | 5752 | system has created the target part of the SDK. You can specify |
| 5753 | functions separated by semicolons: | 5753 | functions separated by semicolons: |
| @@ -5760,7 +5760,7 @@ system and gives an overview of their function and contents. | |||
| 5760 | the OpenEmbedded build system when creating SDK output. See the | 5760 | the OpenEmbedded build system when creating SDK output. See the |
| 5761 | :term:`SDK_DIR` variable for more information. | 5761 | :term:`SDK_DIR` variable for more information. |
| 5762 | 5762 | ||
| 5763 | PR | 5763 | :term:`PR` |
| 5764 | The revision of the recipe. The default value for this variable is | 5764 | The revision of the recipe. The default value for this variable is |
| 5765 | "r0". Subsequent revisions of the recipe conventionally have the | 5765 | "r0". Subsequent revisions of the recipe conventionally have the |
| 5766 | values "r1", "r2", and so forth. When :term:`PV` increases, | 5766 | values "r1", "r2", and so forth. When :term:`PV` increases, |
| @@ -5799,7 +5799,7 @@ system and gives an overview of their function and contents. | |||
| 5799 | ":ref:`dev-manual/dev-manual-common-tasks:working with a pr service`" section | 5799 | ":ref:`dev-manual/dev-manual-common-tasks:working with a pr service`" section |
| 5800 | in the Yocto Project Development Tasks Manual for more information. | 5800 | in the Yocto Project Development Tasks Manual for more information. |
| 5801 | 5801 | ||
| 5802 | PREFERRED_PROVIDER | 5802 | :term:`PREFERRED_PROVIDER` |
| 5803 | If multiple recipes provide the same item, this variable determines | 5803 | If multiple recipes provide the same item, this variable determines |
| 5804 | which recipe is preferred and thus provides the item (i.e. the | 5804 | which recipe is preferred and thus provides the item (i.e. the |
| 5805 | preferred provider). You should always suffix this variable with the | 5805 | preferred provider). You should always suffix this variable with the |
| @@ -5838,7 +5838,7 @@ system and gives an overview of their function and contents. | |||
| 5838 | mechanism is designed to select between mutually exclusive | 5838 | mechanism is designed to select between mutually exclusive |
| 5839 | alternative providers. | 5839 | alternative providers. |
| 5840 | 5840 | ||
| 5841 | PREFERRED_VERSION | 5841 | :term:`PREFERRED_VERSION` |
| 5842 | If multiple versions of recipes exist, this variable determines which | 5842 | If multiple versions of recipes exist, this variable determines which |
| 5843 | version is given preference. You must always suffix the variable with | 5843 | version is given preference. You must always suffix the variable with |
| 5844 | the :term:`PN` you want to select, and you should set the | 5844 | the :term:`PN` you want to select, and you should set the |
| @@ -5900,7 +5900,7 @@ system and gives an overview of their function and contents. | |||
| 5900 | The \_forcevariable override is not handled specially. This override | 5900 | The \_forcevariable override is not handled specially. This override |
| 5901 | only works because the default value of OVERRIDES includes "forcevariable". | 5901 | only works because the default value of OVERRIDES includes "forcevariable". |
| 5902 | 5902 | ||
| 5903 | PREMIRRORS | 5903 | :term:`PREMIRRORS` |
| 5904 | Specifies additional paths from which the OpenEmbedded build system | 5904 | Specifies additional paths from which the OpenEmbedded build system |
| 5905 | gets source code. When the build system searches for source code, it | 5905 | gets source code. When the build system searches for source code, it |
| 5906 | first tries the local download directory. If that location fails, the | 5906 | first tries the local download directory. If that location fails, the |
| @@ -5930,7 +5930,7 @@ system and gives an overview of their function and contents. | |||
| 5930 | ``file://`` URLs to point to local directories or network shares as | 5930 | ``file://`` URLs to point to local directories or network shares as |
| 5931 | well. | 5931 | well. |
| 5932 | 5932 | ||
| 5933 | PRIORITY | 5933 | :term:`PRIORITY` |
| 5934 | Indicates the importance of a package. | 5934 | Indicates the importance of a package. |
| 5935 | 5935 | ||
| 5936 | ``PRIORITY`` is considered to be part of the distribution policy | 5936 | ``PRIORITY`` is considered to be part of the distribution policy |
| @@ -5941,7 +5941,7 @@ system and gives an overview of their function and contents. | |||
| 5941 | You can set ``PRIORITY`` to "required", "standard", "extra", and | 5941 | You can set ``PRIORITY`` to "required", "standard", "extra", and |
| 5942 | "optional", which is the default. | 5942 | "optional", which is the default. |
| 5943 | 5943 | ||
| 5944 | PRIVATE_LIBS | 5944 | :term:`PRIVATE_LIBS` |
| 5945 | Specifies libraries installed within a recipe that should be ignored | 5945 | Specifies libraries installed within a recipe that should be ignored |
| 5946 | by the OpenEmbedded build system's shared library resolver. This | 5946 | by the OpenEmbedded build system's shared library resolver. This |
| 5947 | variable is typically used when software being built by a recipe has | 5947 | variable is typically used when software being built by a recipe has |
| @@ -5967,7 +5967,7 @@ system and gives an overview of their function and contents. | |||
| 5967 | ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" | 5967 | ":ref:`overview-manual/overview-manual-concepts:automatically added runtime dependencies`" |
| 5968 | section in the Yocto Project Overview and Concepts Manual. | 5968 | section in the Yocto Project Overview and Concepts Manual. |
| 5969 | 5969 | ||
| 5970 | PROVIDES | 5970 | :term:`PROVIDES` |
| 5971 | A list of aliases by which a particular recipe can be known. By | 5971 | A list of aliases by which a particular recipe can be known. By |
| 5972 | default, a recipe's own ``PN`` is implicitly already in its | 5972 | default, a recipe's own ``PN`` is implicitly already in its |
| 5973 | ``PROVIDES`` list and therefore does not need to mention that it | 5973 | ``PROVIDES`` list and therefore does not need to mention that it |
| @@ -6030,7 +6030,7 @@ system and gives an overview of their function and contents. | |||
| 6030 | VIRTUAL-RUNTIME_dev_manager = "udev" | 6030 | VIRTUAL-RUNTIME_dev_manager = "udev" |
| 6031 | 6031 | ||
| 6032 | 6032 | ||
| 6033 | PRSERV_HOST | 6033 | :term:`PRSERV_HOST` |
| 6034 | The network based :term:`PR` service host and port. | 6034 | The network based :term:`PR` service host and port. |
| 6035 | 6035 | ||
| 6036 | The ``conf/local.conf.sample.extended`` configuration file in the | 6036 | The ``conf/local.conf.sample.extended`` configuration file in the |
| @@ -6045,7 +6045,7 @@ system and gives an overview of their function and contents. | |||
| 6045 | service <dev-manual/dev-manual-common-tasks:working with a pr service>`. You can | 6045 | service <dev-manual/dev-manual-common-tasks:working with a pr service>`. You can |
| 6046 | set ``PRSERV_HOST`` to other values to use a remote PR service. | 6046 | set ``PRSERV_HOST`` to other values to use a remote PR service. |
| 6047 | 6047 | ||
| 6048 | PTEST_ENABLED | 6048 | :term:`PTEST_ENABLED` |
| 6049 | Specifies whether or not :ref:`Package | 6049 | Specifies whether or not :ref:`Package |
| 6050 | Test <dev-manual/dev-manual-common-tasks:testing packages with ptest>` (ptest) | 6050 | Test <dev-manual/dev-manual-common-tasks:testing packages with ptest>` (ptest) |
| 6051 | functionality is enabled when building a recipe. You should not set | 6051 | functionality is enabled when building a recipe. You should not set |
| @@ -6053,7 +6053,7 @@ system and gives an overview of their function and contents. | |||
| 6053 | at build time should be done by adding "ptest" to (or removing it | 6053 | at build time should be done by adding "ptest" to (or removing it |
| 6054 | from) :term:`DISTRO_FEATURES`. | 6054 | from) :term:`DISTRO_FEATURES`. |
| 6055 | 6055 | ||
| 6056 | PV | 6056 | :term:`PV` |
| 6057 | The version of the recipe. The version is normally extracted from the | 6057 | The version of the recipe. The version is normally extracted from the |
| 6058 | recipe filename. For example, if the recipe is named | 6058 | recipe filename. For example, if the recipe is named |
| 6059 | ``expat_2.0.1.bb``, then the default value of ``PV`` will be "2.0.1". | 6059 | ``expat_2.0.1.bb``, then the default value of ``PV`` will be "2.0.1". |
| @@ -6063,7 +6063,7 @@ system and gives an overview of their function and contents. | |||
| 6063 | 6063 | ||
| 6064 | ``PV`` is the default value of the :term:`PKGV` variable. | 6064 | ``PV`` is the default value of the :term:`PKGV` variable. |
| 6065 | 6065 | ||
| 6066 | PYTHON_ABI | 6066 | :term:`PYTHON_ABI` |
| 6067 | When used by recipes that inherit the | 6067 | When used by recipes that inherit the |
| 6068 | :ref:`distutils3 <ref-classes-distutils3>`, | 6068 | :ref:`distutils3 <ref-classes-distutils3>`, |
| 6069 | :ref:`setuptools3 <ref-classes-setuptools3>`, | 6069 | :ref:`setuptools3 <ref-classes-setuptools3>`, |
| @@ -6081,7 +6081,7 @@ system and gives an overview of their function and contents. | |||
| 6081 | use this variable to locate the headers and libraries of the | 6081 | use this variable to locate the headers and libraries of the |
| 6082 | appropriate Python that the extension is targeting. | 6082 | appropriate Python that the extension is targeting. |
| 6083 | 6083 | ||
| 6084 | PYTHON_PN | 6084 | :term:`PYTHON_PN` |
| 6085 | When used by recipes that inherit the | 6085 | When used by recipes that inherit the |
| 6086 | `distutils3 <ref-classes-distutils3>`, | 6086 | `distutils3 <ref-classes-distutils3>`, |
| 6087 | :ref:`setuptools3 <ref-classes-setuptools3>`, | 6087 | :ref:`setuptools3 <ref-classes-setuptools3>`, |
| @@ -6100,10 +6100,10 @@ system and gives an overview of their function and contents. | |||
| 6100 | In the previous example, | 6100 | In the previous example, |
| 6101 | the version of the dependency is ``PYTHON_PN``. | 6101 | the version of the dependency is ``PYTHON_PN``. |
| 6102 | 6102 | ||
| 6103 | RANLIB | 6103 | :term:`RANLIB` |
| 6104 | The minimal command and arguments to run ``ranlib``. | 6104 | The minimal command and arguments to run ``ranlib``. |
| 6105 | 6105 | ||
| 6106 | RCONFLICTS | 6106 | :term:`RCONFLICTS` |
| 6107 | The list of packages that conflict with packages. Note that packages | 6107 | The list of packages that conflict with packages. Note that packages |
| 6108 | will not be installed if conflicting packages are not first removed. | 6108 | will not be installed if conflicting packages are not first removed. |
| 6109 | 6109 | ||
| @@ -6129,7 +6129,7 @@ system and gives an overview of their function and contents. | |||
| 6129 | 6129 | ||
| 6130 | RCONFLICTS_${PN} = "foo (>= 1.2)" | 6130 | RCONFLICTS_${PN} = "foo (>= 1.2)" |
| 6131 | 6131 | ||
| 6132 | RDEPENDS | 6132 | :term:`RDEPENDS` |
| 6133 | Lists runtime dependencies of a package. These dependencies are other | 6133 | Lists runtime dependencies of a package. These dependencies are other |
| 6134 | packages that must be installed in order for the package to function | 6134 | packages that must be installed in order for the package to function |
| 6135 | correctly. As an example, the following assignment declares that the | 6135 | correctly. As an example, the following assignment declares that the |
| @@ -6241,7 +6241,7 @@ system and gives an overview of their function and contents. | |||
| 6241 | BitBake User Manual for additional information on tasks and | 6241 | BitBake User Manual for additional information on tasks and |
| 6242 | dependencies. | 6242 | dependencies. |
| 6243 | 6243 | ||
| 6244 | REQUIRED_DISTRO_FEATURES | 6244 | :term:`REQUIRED_DISTRO_FEATURES` |
| 6245 | When inheriting the | 6245 | When inheriting the |
| 6246 | :ref:`distro_features_check <ref-classes-distro_features_check>` | 6246 | :ref:`distro_features_check <ref-classes-distro_features_check>` |
| 6247 | class, this variable identifies distribution features that must exist | 6247 | class, this variable identifies distribution features that must exist |
| @@ -6251,13 +6251,13 @@ system and gives an overview of their function and contents. | |||
| 6251 | appear in ``DISTRO_FEATURES`` within the current configuration, an | 6251 | appear in ``DISTRO_FEATURES`` within the current configuration, an |
| 6252 | error occurs and the build stops. | 6252 | error occurs and the build stops. |
| 6253 | 6253 | ||
| 6254 | RM_WORK_EXCLUDE | 6254 | :term:`RM_WORK_EXCLUDE` |
| 6255 | With ``rm_work`` enabled, this variable specifies a list of recipes | 6255 | With ``rm_work`` enabled, this variable specifies a list of recipes |
| 6256 | whose work directories should not be removed. See the | 6256 | whose work directories should not be removed. See the |
| 6257 | ":ref:`rm_work.bbclass <ref-classes-rm-work>`" section for more | 6257 | ":ref:`rm_work.bbclass <ref-classes-rm-work>`" section for more |
| 6258 | details. | 6258 | details. |
| 6259 | 6259 | ||
| 6260 | ROOT_HOME | 6260 | :term:`ROOT_HOME` |
| 6261 | Defines the root home directory. By default, this directory is set as | 6261 | Defines the root home directory. By default, this directory is set as |
| 6262 | follows in the BitBake configuration file: | 6262 | follows in the BitBake configuration file: |
| 6263 | :: | 6263 | :: |
| @@ -6283,13 +6283,13 @@ system and gives an overview of their function and contents. | |||
| 6283 | override examples use ``/root``, which is probably the most commonly | 6283 | override examples use ``/root``, which is probably the most commonly |
| 6284 | used override. | 6284 | used override. |
| 6285 | 6285 | ||
| 6286 | ROOTFS | 6286 | :term:`ROOTFS` |
| 6287 | Indicates a filesystem image to include as the root filesystem. | 6287 | Indicates a filesystem image to include as the root filesystem. |
| 6288 | 6288 | ||
| 6289 | The ``ROOTFS`` variable is an optional variable used with the | 6289 | The ``ROOTFS`` variable is an optional variable used with the |
| 6290 | :ref:`image-live <ref-classes-image-live>` class. | 6290 | :ref:`image-live <ref-classes-image-live>` class. |
| 6291 | 6291 | ||
| 6292 | ROOTFS_POSTINSTALL_COMMAND | 6292 | :term:`ROOTFS_POSTINSTALL_COMMAND` |
| 6293 | Specifies a list of functions to call after the OpenEmbedded build | 6293 | Specifies a list of functions to call after the OpenEmbedded build |
| 6294 | system has installed packages. You can specify functions separated by | 6294 | system has installed packages. You can specify functions separated by |
| 6295 | semicolons: | 6295 | semicolons: |
| @@ -6303,7 +6303,7 @@ system and gives an overview of their function and contents. | |||
| 6303 | :term:`IMAGE_ROOTFS` variable for more | 6303 | :term:`IMAGE_ROOTFS` variable for more |
| 6304 | information. | 6304 | information. |
| 6305 | 6305 | ||
| 6306 | ROOTFS_POSTPROCESS_COMMAND | 6306 | :term:`ROOTFS_POSTPROCESS_COMMAND` |
| 6307 | Specifies a list of functions to call once the OpenEmbedded build | 6307 | Specifies a list of functions to call once the OpenEmbedded build |
| 6308 | system has created the root filesystem. You can specify functions | 6308 | system has created the root filesystem. You can specify functions |
| 6309 | separated by semicolons: | 6309 | separated by semicolons: |
| @@ -6317,7 +6317,7 @@ system and gives an overview of their function and contents. | |||
| 6317 | :term:`IMAGE_ROOTFS` variable for more | 6317 | :term:`IMAGE_ROOTFS` variable for more |
| 6318 | information. | 6318 | information. |
| 6319 | 6319 | ||
| 6320 | ROOTFS_POSTUNINSTALL_COMMAND | 6320 | :term:`ROOTFS_POSTUNINSTALL_COMMAND` |
| 6321 | Specifies a list of functions to call after the OpenEmbedded build | 6321 | Specifies a list of functions to call after the OpenEmbedded build |
| 6322 | system has removed unnecessary packages. When runtime package | 6322 | system has removed unnecessary packages. When runtime package |
| 6323 | management is disabled in the image, several packages are removed | 6323 | management is disabled in the image, several packages are removed |
| @@ -6333,7 +6333,7 @@ system and gives an overview of their function and contents. | |||
| 6333 | :term:`IMAGE_ROOTFS` variable for more | 6333 | :term:`IMAGE_ROOTFS` variable for more |
| 6334 | information. | 6334 | information. |
| 6335 | 6335 | ||
| 6336 | ROOTFS_PREPROCESS_COMMAND | 6336 | :term:`ROOTFS_PREPROCESS_COMMAND` |
| 6337 | Specifies a list of functions to call before the OpenEmbedded build | 6337 | Specifies a list of functions to call before the OpenEmbedded build |
| 6338 | system has created the root filesystem. You can specify functions | 6338 | system has created the root filesystem. You can specify functions |
| 6339 | separated by semicolons: | 6339 | separated by semicolons: |
| @@ -6347,7 +6347,7 @@ system and gives an overview of their function and contents. | |||
| 6347 | :term:`IMAGE_ROOTFS` variable for more | 6347 | :term:`IMAGE_ROOTFS` variable for more |
| 6348 | information. | 6348 | information. |
| 6349 | 6349 | ||
| 6350 | RPROVIDES | 6350 | :term:`RPROVIDES` |
| 6351 | A list of package name aliases that a package also provides. These | 6351 | A list of package name aliases that a package also provides. These |
| 6352 | aliases are useful for satisfying runtime dependencies of other | 6352 | aliases are useful for satisfying runtime dependencies of other |
| 6353 | packages both during the build and on the target (as specified by | 6353 | packages both during the build and on the target (as specified by |
| @@ -6366,7 +6366,7 @@ system and gives an overview of their function and contents. | |||
| 6366 | 6366 | ||
| 6367 | RPROVIDES_${PN} = "widget-abi-2" | 6367 | RPROVIDES_${PN} = "widget-abi-2" |
| 6368 | 6368 | ||
| 6369 | RRECOMMENDS | 6369 | :term:`RRECOMMENDS` |
| 6370 | A list of packages that extends the usability of a package being | 6370 | A list of packages that extends the usability of a package being |
| 6371 | built. The package being built does not depend on this list of | 6371 | built. The package being built does not depend on this list of |
| 6372 | packages in order to successfully build, but rather uses them for | 6372 | packages in order to successfully build, but rather uses them for |
| @@ -6426,7 +6426,7 @@ system and gives an overview of their function and contents. | |||
| 6426 | 6426 | ||
| 6427 | RRECOMMENDS_${PN} = "foo (>= 1.2)" | 6427 | RRECOMMENDS_${PN} = "foo (>= 1.2)" |
| 6428 | 6428 | ||
| 6429 | RREPLACES | 6429 | :term:`RREPLACES` |
| 6430 | A list of packages replaced by a package. The package manager uses | 6430 | A list of packages replaced by a package. The package manager uses |
| 6431 | this variable to determine which package should be installed to | 6431 | this variable to determine which package should be installed to |
| 6432 | replace other package(s) during an upgrade. In order to also have the | 6432 | replace other package(s) during an upgrade. In order to also have the |
| @@ -6462,7 +6462,7 @@ system and gives an overview of their function and contents. | |||
| 6462 | 6462 | ||
| 6463 | RREPLACES_${PN} = "foo (>= 1.2)" | 6463 | RREPLACES_${PN} = "foo (>= 1.2)" |
| 6464 | 6464 | ||
| 6465 | RSUGGESTS | 6465 | :term:`RSUGGESTS` |
| 6466 | A list of additional packages that you can suggest for installation | 6466 | A list of additional packages that you can suggest for installation |
| 6467 | by the package manager at the time a package is installed. Not all | 6467 | by the package manager at the time a package is installed. Not all |
| 6468 | package managers support this functionality. | 6468 | package managers support this functionality. |
| @@ -6474,7 +6474,7 @@ system and gives an overview of their function and contents. | |||
| 6474 | 6474 | ||
| 6475 | RSUGGESTS_${PN} = "useful_package another_package" | 6475 | RSUGGESTS_${PN} = "useful_package another_package" |
| 6476 | 6476 | ||
| 6477 | S | 6477 | :term:`S` |
| 6478 | The location in the :term:`Build Directory` where | 6478 | The location in the :term:`Build Directory` where |
| 6479 | unpacked recipe source code resides. By default, this directory is | 6479 | unpacked recipe source code resides. By default, this directory is |
| 6480 | ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, | 6480 | ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, |
| @@ -6505,13 +6505,13 @@ system and gives an overview of their function and contents. | |||
| 6505 | SRC_URI = "git://path/to/repo.git" | 6505 | SRC_URI = "git://path/to/repo.git" |
| 6506 | S = "${WORKDIR}/git" | 6506 | S = "${WORKDIR}/git" |
| 6507 | 6507 | ||
| 6508 | SANITY_REQUIRED_UTILITIES | 6508 | :term:`SANITY_REQUIRED_UTILITIES` |
| 6509 | Specifies a list of command-line utilities that should be checked for | 6509 | Specifies a list of command-line utilities that should be checked for |
| 6510 | during the initial sanity checking process when running BitBake. If | 6510 | during the initial sanity checking process when running BitBake. If |
| 6511 | any of the utilities are not installed on the build host, then | 6511 | any of the utilities are not installed on the build host, then |
| 6512 | BitBake immediately exits with an error. | 6512 | BitBake immediately exits with an error. |
| 6513 | 6513 | ||
| 6514 | SANITY_TESTED_DISTROS | 6514 | :term:`SANITY_TESTED_DISTROS` |
| 6515 | A list of the host distribution identifiers that the build system has | 6515 | A list of the host distribution identifiers that the build system has |
| 6516 | been tested against. Identifiers consist of the host distributor ID | 6516 | been tested against. Identifiers consist of the host distributor ID |
| 6517 | followed by the release, as reported by the ``lsb_release`` tool or | 6517 | followed by the release, as reported by the ``lsb_release`` tool or |
| @@ -6522,11 +6522,11 @@ system and gives an overview of their function and contents. | |||
| 6522 | list, then the build system reports a warning that indicates the | 6522 | list, then the build system reports a warning that indicates the |
| 6523 | current host distribution has not been tested as a build host. | 6523 | current host distribution has not been tested as a build host. |
| 6524 | 6524 | ||
| 6525 | SDK_ARCH | 6525 | :term:`SDK_ARCH` |
| 6526 | The target architecture for the SDK. Typically, you do not directly | 6526 | The target architecture for the SDK. Typically, you do not directly |
| 6527 | set this variable. Instead, use :term:`SDKMACHINE`. | 6527 | set this variable. Instead, use :term:`SDKMACHINE`. |
| 6528 | 6528 | ||
| 6529 | SDK_DEPLOY | 6529 | :term:`SDK_DEPLOY` |
| 6530 | The directory set up and used by the | 6530 | The directory set up and used by the |
| 6531 | :ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which | 6531 | :ref:`populate_sdk_base <ref-classes-populate-sdk>` class to which |
| 6532 | the SDK is deployed. The ``populate_sdk_base`` class defines | 6532 | the SDK is deployed. The ``populate_sdk_base`` class defines |
| @@ -6535,7 +6535,7 @@ system and gives an overview of their function and contents. | |||
| 6535 | 6535 | ||
| 6536 | SDK_DEPLOY = "${TMPDIR}/deploy/sdk" | 6536 | SDK_DEPLOY = "${TMPDIR}/deploy/sdk" |
| 6537 | 6537 | ||
| 6538 | SDK_DIR | 6538 | :term:`SDK_DIR` |
| 6539 | The parent directory used by the OpenEmbedded build system when | 6539 | The parent directory used by the OpenEmbedded build system when |
| 6540 | creating SDK output. The | 6540 | creating SDK output. The |
| 6541 | :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class defines | 6541 | :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class defines |
| @@ -6554,7 +6554,7 @@ system and gives an overview of their function and contents. | |||
| 6554 | SDK_DEPLOY | 6554 | SDK_DEPLOY |
| 6555 | . | 6555 | . |
| 6556 | 6556 | ||
| 6557 | SDK_EXT_TYPE | 6557 | :term:`SDK_EXT_TYPE` |
| 6558 | Controls whether or not shared state artifacts are copied into the | 6558 | Controls whether or not shared state artifacts are copied into the |
| 6559 | extensible SDK. The default value of "full" copies all of the | 6559 | extensible SDK. The default value of "full" copies all of the |
| 6560 | required shared state artifacts into the extensible SDK. The value | 6560 | required shared state artifacts into the extensible SDK. The value |
| @@ -6567,7 +6567,7 @@ system and gives an overview of their function and contents. | |||
| 6567 | is set in the SDK's configuration to enable the artifacts to be | 6567 | is set in the SDK's configuration to enable the artifacts to be |
| 6568 | fetched as needed. | 6568 | fetched as needed. |
| 6569 | 6569 | ||
| 6570 | SDK_HOST_MANIFEST | 6570 | :term:`SDK_HOST_MANIFEST` |
| 6571 | The manifest file for the host part of the SDK. This file lists all | 6571 | The manifest file for the host part of the SDK. This file lists all |
| 6572 | the installed packages that make up the host part of the SDK. The | 6572 | the installed packages that make up the host part of the SDK. The |
| 6573 | file contains package information on a line-per-package basis as | 6573 | file contains package information on a line-per-package basis as |
| @@ -6585,7 +6585,7 @@ system and gives an overview of their function and contents. | |||
| 6585 | The location is derived using the :term:`SDK_DEPLOY` and | 6585 | The location is derived using the :term:`SDK_DEPLOY` and |
| 6586 | :term:`TOOLCHAIN_OUTPUTNAME` variables. | 6586 | :term:`TOOLCHAIN_OUTPUTNAME` variables. |
| 6587 | 6587 | ||
| 6588 | SDK_INCLUDE_PKGDATA | 6588 | :term:`SDK_INCLUDE_PKGDATA` |
| 6589 | When set to "1", specifies to include the packagedata for all recipes | 6589 | When set to "1", specifies to include the packagedata for all recipes |
| 6590 | in the "world" target in the extensible SDK. Including this data | 6590 | in the "world" target in the extensible SDK. Including this data |
| 6591 | allows the ``devtool search`` command to find these recipes in search | 6591 | allows the ``devtool search`` command to find these recipes in search |
| @@ -6600,7 +6600,7 @@ system and gives an overview of their function and contents. | |||
| 6600 | needs to be built. Enabling the variable also slightly increases | 6600 | needs to be built. Enabling the variable also slightly increases |
| 6601 | the size of the extensible SDK. | 6601 | the size of the extensible SDK. |
| 6602 | 6602 | ||
| 6603 | SDK_INCLUDE_TOOLCHAIN | 6603 | :term:`SDK_INCLUDE_TOOLCHAIN` |
| 6604 | When set to "1", specifies to include the toolchain in the extensible | 6604 | When set to "1", specifies to include the toolchain in the extensible |
| 6605 | SDK. Including the toolchain is useful particularly when | 6605 | SDK. Including the toolchain is useful particularly when |
| 6606 | :term:`SDK_EXT_TYPE` is set to "minimal" to keep | 6606 | :term:`SDK_EXT_TYPE` is set to "minimal" to keep |
| @@ -6613,7 +6613,7 @@ system and gives an overview of their function and contents. | |||
| 6613 | ``SDK_EXT_TYPE`` is set to "minimal", and defaults to "1" if | 6613 | ``SDK_EXT_TYPE`` is set to "minimal", and defaults to "1" if |
| 6614 | ``SDK_EXT_TYPE`` is set to "full". | 6614 | ``SDK_EXT_TYPE`` is set to "full". |
| 6615 | 6615 | ||
| 6616 | SDK_INHERIT_BLACKLIST | 6616 | :term:`SDK_INHERIT_BLACKLIST` |
| 6617 | A list of classes to remove from the :term:`INHERIT` | 6617 | A list of classes to remove from the :term:`INHERIT` |
| 6618 | value globally within the extensible SDK configuration. The | 6618 | value globally within the extensible SDK configuration. The |
| 6619 | :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the | 6619 | :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the |
| @@ -6631,7 +6631,7 @@ system and gives an overview of their function and contents. | |||
| 6631 | section in the Yocto Project Application Development and the | 6631 | section in the Yocto Project Application Development and the |
| 6632 | Extensible Software Development Kit (eSDK) manual. | 6632 | Extensible Software Development Kit (eSDK) manual. |
| 6633 | 6633 | ||
| 6634 | SDK_LOCAL_CONF_BLACKLIST | 6634 | :term:`SDK_LOCAL_CONF_BLACKLIST` |
| 6635 | A list of variables not allowed through from the OpenEmbedded build | 6635 | A list of variables not allowed through from the OpenEmbedded build |
| 6636 | system configuration into the extensible SDK configuration. Usually, | 6636 | system configuration into the extensible SDK configuration. Usually, |
| 6637 | these are variables that are specific to the machine on which the | 6637 | these are variables that are specific to the machine on which the |
| @@ -6657,7 +6657,7 @@ system and gives an overview of their function and contents. | |||
| 6657 | section in the Yocto Project Application Development and the | 6657 | section in the Yocto Project Application Development and the |
| 6658 | Extensible Software Development Kit (eSDK) manual. | 6658 | Extensible Software Development Kit (eSDK) manual. |
| 6659 | 6659 | ||
| 6660 | SDK_LOCAL_CONF_WHITELIST | 6660 | :term:`SDK_LOCAL_CONF_WHITELIST` |
| 6661 | A list of variables allowed through from the OpenEmbedded build | 6661 | A list of variables allowed through from the OpenEmbedded build |
| 6662 | system configuration into the extensible SDK configuration. By | 6662 | system configuration into the extensible SDK configuration. By |
| 6663 | default, the list of variables is empty and is set in the | 6663 | default, the list of variables is empty and is set in the |
| @@ -6676,7 +6676,7 @@ system and gives an overview of their function and contents. | |||
| 6676 | section in the Yocto Project Application Development and the | 6676 | section in the Yocto Project Application Development and the |
| 6677 | Extensible Software Development Kit (eSDK) manual. | 6677 | Extensible Software Development Kit (eSDK) manual. |
| 6678 | 6678 | ||
| 6679 | SDK_NAME | 6679 | :term:`SDK_NAME` |
| 6680 | The base name for SDK output files. The name is derived from the | 6680 | The base name for SDK output files. The name is derived from the |
| 6681 | :term:`DISTRO`, :term:`TCLIBC`, | 6681 | :term:`DISTRO`, :term:`TCLIBC`, |
| 6682 | :term:`SDK_ARCH`, | 6682 | :term:`SDK_ARCH`, |
| @@ -6686,11 +6686,11 @@ system and gives an overview of their function and contents. | |||
| 6686 | 6686 | ||
| 6687 | SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}" | 6687 | SDK_NAME = "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}" |
| 6688 | 6688 | ||
| 6689 | SDK_OS | 6689 | :term:`SDK_OS` |
| 6690 | Specifies the operating system for which the SDK will be built. The | 6690 | Specifies the operating system for which the SDK will be built. The |
| 6691 | default value is the value of :term:`BUILD_OS`. | 6691 | default value is the value of :term:`BUILD_OS`. |
| 6692 | 6692 | ||
| 6693 | SDK_OUTPUT | 6693 | :term:`SDK_OUTPUT` |
| 6694 | The location used by the OpenEmbedded build system when creating SDK | 6694 | The location used by the OpenEmbedded build system when creating SDK |
| 6695 | output. The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` | 6695 | output. The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` |
| 6696 | class defines the variable as follows: | 6696 | class defines the variable as follows: |
| @@ -6706,14 +6706,14 @@ system and gives an overview of their function and contents. | |||
| 6706 | WORKDIR by way of SDK_DIR. The final output directory is | 6706 | WORKDIR by way of SDK_DIR. The final output directory is |
| 6707 | SDK_DEPLOY. | 6707 | SDK_DEPLOY. |
| 6708 | 6708 | ||
| 6709 | SDK_PACKAGE_ARCHS | 6709 | :term:`SDK_PACKAGE_ARCHS` |
| 6710 | Specifies a list of architectures compatible with the SDK machine. | 6710 | Specifies a list of architectures compatible with the SDK machine. |
| 6711 | This variable is set automatically and should not normally be | 6711 | This variable is set automatically and should not normally be |
| 6712 | hand-edited. Entries are separated using spaces and listed in order | 6712 | hand-edited. Entries are separated using spaces and listed in order |
| 6713 | of priority. The default value for ``SDK_PACKAGE_ARCHS`` is "all any | 6713 | of priority. The default value for ``SDK_PACKAGE_ARCHS`` is "all any |
| 6714 | noarch ${SDK_ARCH}-${SDKPKGSUFFIX}". | 6714 | noarch ${SDK_ARCH}-${SDKPKGSUFFIX}". |
| 6715 | 6715 | ||
| 6716 | SDK_POSTPROCESS_COMMAND | 6716 | :term:`SDK_POSTPROCESS_COMMAND` |
| 6717 | Specifies a list of functions to call once the OpenEmbedded build | 6717 | Specifies a list of functions to call once the OpenEmbedded build |
| 6718 | system creates the SDK. You can specify functions separated by | 6718 | system creates the SDK. You can specify functions separated by |
| 6719 | semicolons: SDK_POSTPROCESS_COMMAND += "function; ... " | 6719 | semicolons: SDK_POSTPROCESS_COMMAND += "function; ... " |
| @@ -6723,13 +6723,13 @@ system and gives an overview of their function and contents. | |||
| 6723 | the OpenEmbedded build system when creating SDK output. See the | 6723 | the OpenEmbedded build system when creating SDK output. See the |
| 6724 | :term:`SDK_DIR` variable for more information. | 6724 | :term:`SDK_DIR` variable for more information. |
| 6725 | 6725 | ||
| 6726 | SDK_PREFIX | 6726 | :term:`SDK_PREFIX` |
| 6727 | The toolchain binary prefix used for ``nativesdk`` recipes. The | 6727 | The toolchain binary prefix used for ``nativesdk`` recipes. The |
| 6728 | OpenEmbedded build system uses the ``SDK_PREFIX`` value to set the | 6728 | OpenEmbedded build system uses the ``SDK_PREFIX`` value to set the |
| 6729 | :term:`TARGET_PREFIX` when building | 6729 | :term:`TARGET_PREFIX` when building |
| 6730 | ``nativesdk`` recipes. The default value is "${SDK_SYS}-". | 6730 | ``nativesdk`` recipes. The default value is "${SDK_SYS}-". |
| 6731 | 6731 | ||
| 6732 | SDK_RECRDEP_TASKS | 6732 | :term:`SDK_RECRDEP_TASKS` |
| 6733 | A list of shared state tasks added to the extensible SDK. By default, | 6733 | A list of shared state tasks added to the extensible SDK. By default, |
| 6734 | the following tasks are added: | 6734 | the following tasks are added: |
| 6735 | 6735 | ||
| @@ -6745,7 +6745,7 @@ system and gives an overview of their function and contents. | |||
| 6745 | tasks that are needed in order to build | 6745 | tasks that are needed in order to build |
| 6746 | :term:`SDK_TARGETS`). | 6746 | :term:`SDK_TARGETS`). |
| 6747 | 6747 | ||
| 6748 | SDK_SYS | 6748 | :term:`SDK_SYS` |
| 6749 | Specifies the system, including the architecture and the operating | 6749 | Specifies the system, including the architecture and the operating |
| 6750 | system, for which the SDK will be built. | 6750 | system, for which the SDK will be built. |
| 6751 | 6751 | ||
| @@ -6755,7 +6755,7 @@ system and gives an overview of their function and contents. | |||
| 6755 | :term:`SDK_OS`. You do not need to set the ``SDK_SYS`` | 6755 | :term:`SDK_OS`. You do not need to set the ``SDK_SYS`` |
| 6756 | variable yourself. | 6756 | variable yourself. |
| 6757 | 6757 | ||
| 6758 | SDK_TARGET_MANIFEST | 6758 | :term:`SDK_TARGET_MANIFEST` |
| 6759 | The manifest file for the target part of the SDK. This file lists all | 6759 | The manifest file for the target part of the SDK. This file lists all |
| 6760 | the installed packages that make up the target part of the SDK. The | 6760 | the installed packages that make up the target part of the SDK. The |
| 6761 | file contains package information on a line-per-package basis as | 6761 | file contains package information on a line-per-package basis as |
| @@ -6773,7 +6773,7 @@ system and gives an overview of their function and contents. | |||
| 6773 | The location is derived using the :term:`SDK_DEPLOY` and | 6773 | The location is derived using the :term:`SDK_DEPLOY` and |
| 6774 | :term:`TOOLCHAIN_OUTPUTNAME` variables. | 6774 | :term:`TOOLCHAIN_OUTPUTNAME` variables. |
| 6775 | 6775 | ||
| 6776 | SDK_TARGETS | 6776 | :term:`SDK_TARGETS` |
| 6777 | A list of targets to install from shared state as part of the | 6777 | A list of targets to install from shared state as part of the |
| 6778 | standard or extensible SDK installation. The default value is "${PN}" | 6778 | standard or extensible SDK installation. The default value is "${PN}" |
| 6779 | (i.e. the image from which the SDK is built). | 6779 | (i.e. the image from which the SDK is built). |
| @@ -6781,7 +6781,7 @@ system and gives an overview of their function and contents. | |||
| 6781 | The ``SDK_TARGETS`` variable is an internal variable and typically | 6781 | The ``SDK_TARGETS`` variable is an internal variable and typically |
| 6782 | would not be changed. | 6782 | would not be changed. |
| 6783 | 6783 | ||
| 6784 | SDK_TITLE | 6784 | :term:`SDK_TITLE` |
| 6785 | The title to be printed when running the SDK installer. By default, | 6785 | The title to be printed when running the SDK installer. By default, |
| 6786 | this title is based on the :term:`DISTRO_NAME` or | 6786 | this title is based on the :term:`DISTRO_NAME` or |
| 6787 | :term:`DISTRO` variable and is set in the | 6787 | :term:`DISTRO` variable and is set in the |
| @@ -6799,15 +6799,15 @@ system and gives an overview of their function and contents. | |||
| 6799 | section in the Yocto Project Application Development and the | 6799 | section in the Yocto Project Application Development and the |
| 6800 | Extensible Software Development Kit (eSDK) manual. | 6800 | Extensible Software Development Kit (eSDK) manual. |
| 6801 | 6801 | ||
| 6802 | SDK_UPDATE_URL | 6802 | :term:`SDK_UPDATE_URL` |
| 6803 | An optional URL for an update server for the extensible SDK. If set, | 6803 | An optional URL for an update server for the extensible SDK. If set, |
| 6804 | the value is used as the default update server when running | 6804 | the value is used as the default update server when running |
| 6805 | ``devtool sdk-update`` within the extensible SDK. | 6805 | ``devtool sdk-update`` within the extensible SDK. |
| 6806 | 6806 | ||
| 6807 | SDK_VENDOR | 6807 | :term:`SDK_VENDOR` |
| 6808 | Specifies the name of the SDK vendor. | 6808 | Specifies the name of the SDK vendor. |
| 6809 | 6809 | ||
| 6810 | SDK_VERSION | 6810 | :term:`SDK_VERSION` |
| 6811 | Specifies the version of the SDK. The distribution configuration file | 6811 | Specifies the version of the SDK. The distribution configuration file |
| 6812 | (e.g. ``/meta-poky/conf/distro/poky.conf``) defines the | 6812 | (e.g. ``/meta-poky/conf/distro/poky.conf``) defines the |
| 6813 | ``SDK_VERSION`` as follows: | 6813 | ``SDK_VERSION`` as follows: |
| @@ -6819,7 +6819,7 @@ system and gives an overview of their function and contents. | |||
| 6819 | :term:`DISTRO_VERSION` and | 6819 | :term:`DISTRO_VERSION` and |
| 6820 | :term:`DATE` variables. | 6820 | :term:`DATE` variables. |
| 6821 | 6821 | ||
| 6822 | SDKEXTPATH | 6822 | :term:`SDKEXTPATH` |
| 6823 | The default installation directory for the Extensible SDK. By | 6823 | The default installation directory for the Extensible SDK. By |
| 6824 | default, this directory is based on the :term:`DISTRO` | 6824 | default, this directory is based on the :term:`DISTRO` |
| 6825 | variable and is set in the | 6825 | variable and is set in the |
| @@ -6837,14 +6837,14 @@ system and gives an overview of their function and contents. | |||
| 6837 | section in the Yocto Project Application Development and the | 6837 | section in the Yocto Project Application Development and the |
| 6838 | Extensible Software Development Kit (eSDK) manual. | 6838 | Extensible Software Development Kit (eSDK) manual. |
| 6839 | 6839 | ||
| 6840 | SDKIMAGE_FEATURES | 6840 | :term:`SDKIMAGE_FEATURES` |
| 6841 | Equivalent to ``IMAGE_FEATURES``. However, this variable applies to | 6841 | Equivalent to ``IMAGE_FEATURES``. However, this variable applies to |
| 6842 | the SDK generated from an image using the following command: | 6842 | the SDK generated from an image using the following command: |
| 6843 | :: | 6843 | :: |
| 6844 | 6844 | ||
| 6845 | $ bitbake -c populate_sdk imagename | 6845 | $ bitbake -c populate_sdk imagename |
| 6846 | 6846 | ||
| 6847 | SDKMACHINE | 6847 | :term:`SDKMACHINE` |
| 6848 | The machine for which the SDK is built. In other words, the SDK is | 6848 | The machine for which the SDK is built. In other words, the SDK is |
| 6849 | built such that it runs on the target you specify with the | 6849 | built such that it runs on the target you specify with the |
| 6850 | ``SDKMACHINE`` value. The value points to a corresponding ``.conf`` | 6850 | ``SDKMACHINE`` value. The value points to a corresponding ``.conf`` |
| @@ -6864,23 +6864,23 @@ system and gives an overview of their function and contents. | |||
| 6864 | variable in your distribution configuration file. If you do, the | 6864 | variable in your distribution configuration file. If you do, the |
| 6865 | configuration will not take affect. | 6865 | configuration will not take affect. |
| 6866 | 6866 | ||
| 6867 | SDKPATH | 6867 | :term:`SDKPATH` |
| 6868 | Defines the path offered to the user for installation of the SDK that | 6868 | Defines the path offered to the user for installation of the SDK that |
| 6869 | is generated by the OpenEmbedded build system. The path appears as | 6869 | is generated by the OpenEmbedded build system. The path appears as |
| 6870 | the default location for installing the SDK when you run the SDK's | 6870 | the default location for installing the SDK when you run the SDK's |
| 6871 | installation script. You can override the offered path when you run | 6871 | installation script. You can override the offered path when you run |
| 6872 | the script. | 6872 | the script. |
| 6873 | 6873 | ||
| 6874 | SDKTARGETSYSROOT | 6874 | :term:`SDKTARGETSYSROOT` |
| 6875 | The full path to the sysroot used for cross-compilation within an SDK | 6875 | The full path to the sysroot used for cross-compilation within an SDK |
| 6876 | as it will be when installed into the default | 6876 | as it will be when installed into the default |
| 6877 | :term:`SDKPATH`. | 6877 | :term:`SDKPATH`. |
| 6878 | 6878 | ||
| 6879 | SECTION | 6879 | :term:`SECTION` |
| 6880 | The section in which packages should be categorized. Package | 6880 | The section in which packages should be categorized. Package |
| 6881 | management utilities can make use of this variable. | 6881 | management utilities can make use of this variable. |
| 6882 | 6882 | ||
| 6883 | SELECTED_OPTIMIZATION | 6883 | :term:`SELECTED_OPTIMIZATION` |
| 6884 | Specifies the optimization flags passed to the C compiler when | 6884 | Specifies the optimization flags passed to the C compiler when |
| 6885 | building for the target. The flags are passed through the default | 6885 | building for the target. The flags are passed through the default |
| 6886 | value of the :term:`TARGET_CFLAGS` variable. | 6886 | value of the :term:`TARGET_CFLAGS` variable. |
| @@ -6889,7 +6889,7 @@ system and gives an overview of their function and contents. | |||
| 6889 | ``FULL_OPTIMIZATION`` unless ``DEBUG_BUILD`` = "1". If that is the | 6889 | ``FULL_OPTIMIZATION`` unless ``DEBUG_BUILD`` = "1". If that is the |
| 6890 | case, the value of ``DEBUG_OPTIMIZATION`` is used. | 6890 | case, the value of ``DEBUG_OPTIMIZATION`` is used. |
| 6891 | 6891 | ||
| 6892 | SERIAL_CONSOLE | 6892 | :term:`SERIAL_CONSOLE` |
| 6893 | Defines a serial console (TTY) to enable using | 6893 | Defines a serial console (TTY) to enable using |
| 6894 | `getty <https://en.wikipedia.org/wiki/Getty_(Unix)>`__. Provide a | 6894 | `getty <https://en.wikipedia.org/wiki/Getty_(Unix)>`__. Provide a |
| 6895 | value that specifies the baud rate followed by the TTY device name | 6895 | value that specifies the baud rate followed by the TTY device name |
| @@ -6906,7 +6906,7 @@ system and gives an overview of their function and contents. | |||
| 6906 | SERIAL_CONSOLES | 6906 | SERIAL_CONSOLES |
| 6907 | variable. | 6907 | variable. |
| 6908 | 6908 | ||
| 6909 | SERIAL_CONSOLES | 6909 | :term:`SERIAL_CONSOLES` |
| 6910 | Defines a serial console (TTY) to enable using | 6910 | Defines a serial console (TTY) to enable using |
| 6911 | `getty <https://en.wikipedia.org/wiki/Getty_(Unix)>`__. Provide a | 6911 | `getty <https://en.wikipedia.org/wiki/Getty_(Unix)>`__. Provide a |
| 6912 | value that specifies the baud rate followed by the TTY device name | 6912 | value that specifies the baud rate followed by the TTY device name |
| @@ -6915,7 +6915,7 @@ system and gives an overview of their function and contents. | |||
| 6915 | 6915 | ||
| 6916 | SERIAL_CONSOLES = "115200;ttyS0 115200;ttyS1" | 6916 | SERIAL_CONSOLES = "115200;ttyS0 115200;ttyS1" |
| 6917 | 6917 | ||
| 6918 | SERIAL_CONSOLES_CHECK | 6918 | :term:`SERIAL_CONSOLES_CHECK` |
| 6919 | Specifies serial consoles, which must be listed in | 6919 | Specifies serial consoles, which must be listed in |
| 6920 | :term:`SERIAL_CONSOLES`, to check against | 6920 | :term:`SERIAL_CONSOLES`, to check against |
| 6921 | ``/proc/console`` before enabling them using getty. This variable | 6921 | ``/proc/console`` before enabling them using getty. This variable |
| @@ -6928,7 +6928,7 @@ system and gives an overview of their function and contents. | |||
| 6928 | This variable is currently only supported with SysVinit (i.e. not | 6928 | This variable is currently only supported with SysVinit (i.e. not |
| 6929 | with systemd). | 6929 | with systemd). |
| 6930 | 6930 | ||
| 6931 | SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS | 6931 | :term:`SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS` |
| 6932 | A list of recipe dependencies that should not be used to determine | 6932 | A list of recipe dependencies that should not be used to determine |
| 6933 | signatures of tasks from one recipe when they depend on tasks from | 6933 | signatures of tasks from one recipe when they depend on tasks from |
| 6934 | another recipe. For example: :: | 6934 | another recipe. For example: :: |
| @@ -6956,7 +6956,7 @@ system and gives an overview of their function and contents. | |||
| 6956 | the software might break during runtime if the interface of the | 6956 | the software might break during runtime if the interface of the |
| 6957 | second recipe was changed after the first recipe had been built. | 6957 | second recipe was changed after the first recipe had been built. |
| 6958 | 6958 | ||
| 6959 | SIGGEN_EXCLUDERECIPES_ABISAFE | 6959 | :term:`SIGGEN_EXCLUDERECIPES_ABISAFE` |
| 6960 | A list of recipes that are completely stable and will never change. | 6960 | A list of recipes that are completely stable and will never change. |
| 6961 | The ABI for the recipes in the list are presented by output from the | 6961 | The ABI for the recipes in the list are presented by output from the |
| 6962 | tasks run to build the recipe. Use of this variable is one way to | 6962 | tasks run to build the recipe. Use of this variable is one way to |
| @@ -6969,15 +6969,15 @@ system and gives an overview of their function and contents. | |||
| 6969 | might break at runtime if the interface of the recipe was changed | 6969 | might break at runtime if the interface of the recipe was changed |
| 6970 | after the other had been built. | 6970 | after the other had been built. |
| 6971 | 6971 | ||
| 6972 | SITEINFO_BITS | 6972 | :term:`SITEINFO_BITS` |
| 6973 | Specifies the number of bits for the target system CPU. The value | 6973 | Specifies the number of bits for the target system CPU. The value |
| 6974 | should be either "32" or "64". | 6974 | should be either "32" or "64". |
| 6975 | 6975 | ||
| 6976 | SITEINFO_ENDIANNESS | 6976 | :term:`SITEINFO_ENDIANNESS` |
| 6977 | Specifies the endian byte order of the target system. The value | 6977 | Specifies the endian byte order of the target system. The value |
| 6978 | should be either "le" for little-endian or "be" for big-endian. | 6978 | should be either "le" for little-endian or "be" for big-endian. |
| 6979 | 6979 | ||
| 6980 | SKIP_FILEDEPS | 6980 | :term:`SKIP_FILEDEPS` |
| 6981 | Enables removal of all files from the "Provides" section of an RPM | 6981 | Enables removal of all files from the "Provides" section of an RPM |
| 6982 | package. Removal of these files is required for packages containing | 6982 | package. Removal of these files is required for packages containing |
| 6983 | prebuilt binaries and libraries such as ``libstdc++`` and ``glibc``. | 6983 | prebuilt binaries and libraries such as ``libstdc++`` and ``glibc``. |
| @@ -6989,7 +6989,7 @@ system and gives an overview of their function and contents. | |||
| 6989 | 6989 | ||
| 6990 | SKIP_FILEDEPS = "1" | 6990 | SKIP_FILEDEPS = "1" |
| 6991 | 6991 | ||
| 6992 | SOC_FAMILY | 6992 | :term:`SOC_FAMILY` |
| 6993 | Groups together machines based upon the same family of SOC (System On | 6993 | Groups together machines based upon the same family of SOC (System On |
| 6994 | Chip). You typically set this variable in a common ``.inc`` file that | 6994 | Chip). You typically set this variable in a common ``.inc`` file that |
| 6995 | you include in the configuration files of all the machines. | 6995 | you include in the configuration files of all the machines. |
| @@ -7002,7 +7002,7 @@ system and gives an overview of their function and contents. | |||
| 7002 | MACHINEOVERRIDES | 7002 | MACHINEOVERRIDES |
| 7003 | . | 7003 | . |
| 7004 | 7004 | ||
| 7005 | SOLIBS | 7005 | :term:`SOLIBS` |
| 7006 | Defines the suffix for shared libraries used on the target platform. | 7006 | Defines the suffix for shared libraries used on the target platform. |
| 7007 | By default, this suffix is ".so.*" for all Linux-based systems and is | 7007 | By default, this suffix is ".so.*" for all Linux-based systems and is |
| 7008 | defined in the ``meta/conf/bitbake.conf`` configuration file. | 7008 | defined in the ``meta/conf/bitbake.conf`` configuration file. |
| @@ -7010,7 +7010,7 @@ system and gives an overview of their function and contents. | |||
| 7010 | You will see this variable referenced in the default values of | 7010 | You will see this variable referenced in the default values of |
| 7011 | ``FILES_${PN}``. | 7011 | ``FILES_${PN}``. |
| 7012 | 7012 | ||
| 7013 | SOLIBSDEV | 7013 | :term:`SOLIBSDEV` |
| 7014 | Defines the suffix for the development symbolic link (symlink) for | 7014 | Defines the suffix for the development symbolic link (symlink) for |
| 7015 | shared libraries on the target platform. By default, this suffix is | 7015 | shared libraries on the target platform. By default, this suffix is |
| 7016 | ".so" for Linux-based systems and is defined in the | 7016 | ".so" for Linux-based systems and is defined in the |
| @@ -7019,7 +7019,7 @@ system and gives an overview of their function and contents. | |||
| 7019 | You will see this variable referenced in the default values of | 7019 | You will see this variable referenced in the default values of |
| 7020 | ``FILES_${PN}-dev``. | 7020 | ``FILES_${PN}-dev``. |
| 7021 | 7021 | ||
| 7022 | SOURCE_MIRROR_FETCH | 7022 | :term:`SOURCE_MIRROR_FETCH` |
| 7023 | When you are fetching files to create a mirror of sources (i.e. | 7023 | When you are fetching files to create a mirror of sources (i.e. |
| 7024 | creating a source mirror), setting ``SOURCE_MIRROR_FETCH`` to "1" in | 7024 | creating a source mirror), setting ``SOURCE_MIRROR_FETCH`` to "1" in |
| 7025 | your ``local.conf`` configuration file ensures the source for all | 7025 | your ``local.conf`` configuration file ensures the source for all |
| @@ -7038,7 +7038,7 @@ system and gives an overview of their function and contents. | |||
| 7038 | variable unless you are creating a source mirror. In other words, | 7038 | variable unless you are creating a source mirror. In other words, |
| 7039 | do not set the variable during a normal build. | 7039 | do not set the variable during a normal build. |
| 7040 | 7040 | ||
| 7041 | SOURCE_MIRROR_URL | 7041 | :term:`SOURCE_MIRROR_URL` |
| 7042 | Defines your own :term:`PREMIRRORS` from which to | 7042 | Defines your own :term:`PREMIRRORS` from which to |
| 7043 | first fetch source before attempting to fetch from the upstream | 7043 | first fetch source before attempting to fetch from the upstream |
| 7044 | specified in :term:`SRC_URI`. | 7044 | specified in :term:`SRC_URI`. |
| @@ -7057,7 +7057,7 @@ system and gives an overview of their function and contents. | |||
| 7057 | SOURCE_MIRROR_URL | 7057 | SOURCE_MIRROR_URL |
| 7058 | . | 7058 | . |
| 7059 | 7059 | ||
| 7060 | SPDXLICENSEMAP | 7060 | :term:`SPDXLICENSEMAP` |
| 7061 | Maps commonly used license names to their SPDX counterparts found in | 7061 | Maps commonly used license names to their SPDX counterparts found in |
| 7062 | ``meta/files/common-licenses/``. For the default ``SPDXLICENSEMAP`` | 7062 | ``meta/files/common-licenses/``. For the default ``SPDXLICENSEMAP`` |
| 7063 | mappings, see the ``meta/conf/licenses.conf`` file. | 7063 | mappings, see the ``meta/conf/licenses.conf`` file. |
| @@ -7065,13 +7065,13 @@ system and gives an overview of their function and contents. | |||
| 7065 | For additional information, see the :term:`LICENSE` | 7065 | For additional information, see the :term:`LICENSE` |
| 7066 | variable. | 7066 | variable. |
| 7067 | 7067 | ||
| 7068 | SPECIAL_PKGSUFFIX | 7068 | :term:`SPECIAL_PKGSUFFIX` |
| 7069 | A list of prefixes for :term:`PN` used by the OpenEmbedded | 7069 | A list of prefixes for :term:`PN` used by the OpenEmbedded |
| 7070 | build system to create variants of recipes or packages. The list | 7070 | build system to create variants of recipes or packages. The list |
| 7071 | specifies the prefixes to strip off during certain circumstances such | 7071 | specifies the prefixes to strip off during certain circumstances such |
| 7072 | as the generation of the :term:`BPN` variable. | 7072 | as the generation of the :term:`BPN` variable. |
| 7073 | 7073 | ||
| 7074 | SPL_BINARY | 7074 | :term:`SPL_BINARY` |
| 7075 | The file type for the Secondary Program Loader (SPL). Some devices | 7075 | The file type for the Secondary Program Loader (SPL). Some devices |
| 7076 | use an SPL from which to boot (e.g. the BeagleBone development | 7076 | use an SPL from which to boot (e.g. the BeagleBone development |
| 7077 | board). For such cases, you can declare the file type of the SPL | 7077 | board). For such cases, you can declare the file type of the SPL |
| @@ -7099,7 +7099,7 @@ system and gives an overview of their function and contents. | |||
| 7099 | section in the Yocto Project Board Support Package Developer's Guide | 7099 | section in the Yocto Project Board Support Package Developer's Guide |
| 7100 | for additional information. | 7100 | for additional information. |
| 7101 | 7101 | ||
| 7102 | SRC_URI | 7102 | :term:`SRC_URI` |
| 7103 | The list of source files - local or remote. This variable tells the | 7103 | The list of source files - local or remote. This variable tells the |
| 7104 | OpenEmbedded build system which bits to pull in for the build and how | 7104 | OpenEmbedded build system which bits to pull in for the build and how |
| 7105 | to pull them in. For example, if the recipe or append file only needs | 7105 | to pull them in. For example, if the recipe or append file only needs |
| @@ -7242,18 +7242,18 @@ system and gives an overview of their function and contents. | |||
| 7242 | - ``downloadfilename`` - Specifies the filename used when storing | 7242 | - ``downloadfilename`` - Specifies the filename used when storing |
| 7243 | the downloaded file. | 7243 | the downloaded file. |
| 7244 | 7244 | ||
| 7245 | SRC_URI_OVERRIDES_PACKAGE_ARCH | 7245 | :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` |
| 7246 | By default, the OpenEmbedded build system automatically detects | 7246 | By default, the OpenEmbedded build system automatically detects |
| 7247 | whether ``SRC_URI`` contains files that are machine-specific. If so, | 7247 | whether ``SRC_URI`` contains files that are machine-specific. If so, |
| 7248 | the build system automatically changes ``PACKAGE_ARCH``. Setting this | 7248 | the build system automatically changes ``PACKAGE_ARCH``. Setting this |
| 7249 | variable to "0" disables this behavior. | 7249 | variable to "0" disables this behavior. |
| 7250 | 7250 | ||
| 7251 | SRCDATE | 7251 | :term:`SRCDATE` |
| 7252 | The date of the source code used to build the package. This variable | 7252 | The date of the source code used to build the package. This variable |
| 7253 | applies only if the source was fetched from a Source Code Manager | 7253 | applies only if the source was fetched from a Source Code Manager |
| 7254 | (SCM). | 7254 | (SCM). |
| 7255 | 7255 | ||
| 7256 | SRCPV | 7256 | :term:`SRCPV` |
| 7257 | Returns the version string of the current package. This string is | 7257 | Returns the version string of the current package. This string is |
| 7258 | used to help define the value of :term:`PV`. | 7258 | used to help define the value of :term:`PV`. |
| 7259 | 7259 | ||
| @@ -7272,7 +7272,7 @@ system and gives an overview of their function and contents. | |||
| 7272 | 7272 | ||
| 7273 | PV = "0.12-git${SRCPV}" | 7273 | PV = "0.12-git${SRCPV}" |
| 7274 | 7274 | ||
| 7275 | SRCREV | 7275 | :term:`SRCREV` |
| 7276 | The revision of the source code used to build the package. This | 7276 | The revision of the source code used to build the package. This |
| 7277 | variable applies to Subversion, Git, Mercurial, and Bazaar only. Note | 7277 | variable applies to Subversion, Git, Mercurial, and Bazaar only. Note |
| 7278 | that if you want to build a fixed revision and you want to avoid | 7278 | that if you want to build a fixed revision and you want to avoid |
| @@ -7291,10 +7291,10 @@ system and gives an overview of their function and contents. | |||
| 7291 | Automatically Incrementing a Binary Package Revision Number | 7291 | Automatically Incrementing a Binary Package Revision Number |
| 7292 | " section, which is in the Yocto Project Development Tasks Manual. | 7292 | " section, which is in the Yocto Project Development Tasks Manual. |
| 7293 | 7293 | ||
| 7294 | SSTATE_DIR | 7294 | :term:`SSTATE_DIR` |
| 7295 | The directory for the shared state cache. | 7295 | The directory for the shared state cache. |
| 7296 | 7296 | ||
| 7297 | SSTATE_MIRROR_ALLOW_NETWORK | 7297 | :term:`SSTATE_MIRROR_ALLOW_NETWORK` |
| 7298 | If set to "1", allows fetches from mirrors that are specified in | 7298 | If set to "1", allows fetches from mirrors that are specified in |
| 7299 | :term:`SSTATE_MIRRORS` to work even when | 7299 | :term:`SSTATE_MIRRORS` to work even when |
| 7300 | fetching from the network is disabled by setting ``BB_NO_NETWORK`` to | 7300 | fetching from the network is disabled by setting ``BB_NO_NETWORK`` to |
| @@ -7303,7 +7303,7 @@ system and gives an overview of their function and contents. | |||
| 7303 | your shared state cache, but you want to disable any other fetching | 7303 | your shared state cache, but you want to disable any other fetching |
| 7304 | from the network. | 7304 | from the network. |
| 7305 | 7305 | ||
| 7306 | SSTATE_MIRRORS | 7306 | :term:`SSTATE_MIRRORS` |
| 7307 | Configures the OpenEmbedded build system to search other mirror | 7307 | Configures the OpenEmbedded build system to search other mirror |
| 7308 | locations for prebuilt cache data objects before building out the | 7308 | locations for prebuilt cache data objects before building out the |
| 7309 | data. This variable works like fetcher :term:`MIRRORS` | 7309 | data. This variable works like fetcher :term:`MIRRORS` |
| @@ -7337,7 +7337,7 @@ system and gives an overview of their function and contents. | |||
| 7337 | file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \ | 7337 | file://.* http://someserver.tld/share/sstate/PATH;downloadfilename=PATH \n \ |
| 7338 | file://.* file:///some-local-dir/sstate/PATH" | 7338 | file://.* file:///some-local-dir/sstate/PATH" |
| 7339 | 7339 | ||
| 7340 | SSTATE_SCAN_FILES | 7340 | :term:`SSTATE_SCAN_FILES` |
| 7341 | Controls the list of files the OpenEmbedded build system scans for | 7341 | Controls the list of files the OpenEmbedded build system scans for |
| 7342 | hardcoded installation paths. The variable uses a space-separated | 7342 | hardcoded installation paths. The variable uses a space-separated |
| 7343 | list of filenames (not paths) with standard wildcard characters | 7343 | list of filenames (not paths) with standard wildcard characters |
| @@ -7356,21 +7356,21 @@ system and gives an overview of their function and contents. | |||
| 7356 | For details on the process, see the | 7356 | For details on the process, see the |
| 7357 | :ref:`staging <ref-classes-staging>` class. | 7357 | :ref:`staging <ref-classes-staging>` class. |
| 7358 | 7358 | ||
| 7359 | STAGING_BASE_LIBDIR_NATIVE | 7359 | :term:`STAGING_BASE_LIBDIR_NATIVE` |
| 7360 | Specifies the path to the ``/lib`` subdirectory of the sysroot | 7360 | Specifies the path to the ``/lib`` subdirectory of the sysroot |
| 7361 | directory for the build host. | 7361 | directory for the build host. |
| 7362 | 7362 | ||
| 7363 | STAGING_BASELIBDIR | 7363 | :term:`STAGING_BASELIBDIR` |
| 7364 | Specifies the path to the ``/lib`` subdirectory of the sysroot | 7364 | Specifies the path to the ``/lib`` subdirectory of the sysroot |
| 7365 | directory for the target for which the current recipe is being built | 7365 | directory for the target for which the current recipe is being built |
| 7366 | (:term:`STAGING_DIR_HOST`). | 7366 | (:term:`STAGING_DIR_HOST`). |
| 7367 | 7367 | ||
| 7368 | STAGING_BINDIR | 7368 | :term:`STAGING_BINDIR` |
| 7369 | Specifies the path to the ``/usr/bin`` subdirectory of the sysroot | 7369 | Specifies the path to the ``/usr/bin`` subdirectory of the sysroot |
| 7370 | directory for the target for which the current recipe is being built | 7370 | directory for the target for which the current recipe is being built |
| 7371 | (:term:`STAGING_DIR_HOST`). | 7371 | (:term:`STAGING_DIR_HOST`). |
| 7372 | 7372 | ||
| 7373 | STAGING_BINDIR_CROSS | 7373 | :term:`STAGING_BINDIR_CROSS` |
| 7374 | Specifies the path to the directory containing binary configuration | 7374 | Specifies the path to the directory containing binary configuration |
| 7375 | scripts. These scripts provide configuration information for other | 7375 | scripts. These scripts provide configuration information for other |
| 7376 | software that wants to make use of libraries or include files | 7376 | software that wants to make use of libraries or include files |
| @@ -7387,20 +7387,20 @@ system and gives an overview of their function and contents. | |||
| 7387 | pkg-config | 7387 | pkg-config |
| 7388 | instead of a provided configuration script. | 7388 | instead of a provided configuration script. |
| 7389 | 7389 | ||
| 7390 | STAGING_BINDIR_NATIVE | 7390 | :term:`STAGING_BINDIR_NATIVE` |
| 7391 | Specifies the path to the ``/usr/bin`` subdirectory of the sysroot | 7391 | Specifies the path to the ``/usr/bin`` subdirectory of the sysroot |
| 7392 | directory for the build host. | 7392 | directory for the build host. |
| 7393 | 7393 | ||
| 7394 | STAGING_DATADIR | 7394 | :term:`STAGING_DATADIR` |
| 7395 | Specifies the path to the ``/usr/share`` subdirectory of the sysroot | 7395 | Specifies the path to the ``/usr/share`` subdirectory of the sysroot |
| 7396 | directory for the target for which the current recipe is being built | 7396 | directory for the target for which the current recipe is being built |
| 7397 | (:term:`STAGING_DIR_HOST`). | 7397 | (:term:`STAGING_DIR_HOST`). |
| 7398 | 7398 | ||
| 7399 | STAGING_DATADIR_NATIVE | 7399 | :term:`STAGING_DATADIR_NATIVE` |
| 7400 | Specifies the path to the ``/usr/share`` subdirectory of the sysroot | 7400 | Specifies the path to the ``/usr/share`` subdirectory of the sysroot |
| 7401 | directory for the build host. | 7401 | directory for the build host. |
| 7402 | 7402 | ||
| 7403 | STAGING_DIR | 7403 | :term:`STAGING_DIR` |
| 7404 | Helps construct the ``recipe-sysroots`` directory, which is used | 7404 | Helps construct the ``recipe-sysroots`` directory, which is used |
| 7405 | during packaging. | 7405 | during packaging. |
| 7406 | 7406 | ||
| @@ -7426,7 +7426,7 @@ system and gives an overview of their function and contents. | |||
| 7426 | task and then the OpenEmbedded build system will stage a subset of | 7426 | task and then the OpenEmbedded build system will stage a subset of |
| 7427 | those files into the sysroot. | 7427 | those files into the sysroot. |
| 7428 | 7428 | ||
| 7429 | STAGING_DIR_HOST | 7429 | :term:`STAGING_DIR_HOST` |
| 7430 | Specifies the path to the sysroot directory for the system on which | 7430 | Specifies the path to the sysroot directory for the system on which |
| 7431 | the component is built to run (the system that hosts the component). | 7431 | the component is built to run (the system that hosts the component). |
| 7432 | For most recipes, this sysroot is the one in which that recipe's | 7432 | For most recipes, this sysroot is the one in which that recipe's |
| @@ -7464,11 +7464,11 @@ system and gives an overview of their function and contents. | |||
| 7464 | for ``-native`` recipes, as they make use of host headers and | 7464 | for ``-native`` recipes, as they make use of host headers and |
| 7465 | libraries. | 7465 | libraries. |
| 7466 | 7466 | ||
| 7467 | STAGING_DIR_NATIVE | 7467 | :term:`STAGING_DIR_NATIVE` |
| 7468 | Specifies the path to the sysroot directory used when building | 7468 | Specifies the path to the sysroot directory used when building |
| 7469 | components that run on the build host itself. | 7469 | components that run on the build host itself. |
| 7470 | 7470 | ||
| 7471 | STAGING_DIR_TARGET | 7471 | :term:`STAGING_DIR_TARGET` |
| 7472 | Specifies the path to the sysroot used for the system for which the | 7472 | Specifies the path to the sysroot used for the system for which the |
| 7473 | component generates code. For components that do not generate code, | 7473 | component generates code. For components that do not generate code, |
| 7474 | which is the majority, ``STAGING_DIR_TARGET`` is set to match | 7474 | which is the majority, ``STAGING_DIR_TARGET`` is set to match |
| @@ -7484,45 +7484,45 @@ system and gives an overview of their function and contents. | |||
| 7484 | for the "HOST" system, while ``STAGING_DIR_TARGET`` points to the | 7484 | for the "HOST" system, while ``STAGING_DIR_TARGET`` points to the |
| 7485 | sysroot used for the "TARGET" system. | 7485 | sysroot used for the "TARGET" system. |
| 7486 | 7486 | ||
| 7487 | STAGING_ETCDIR_NATIVE | 7487 | :term:`STAGING_ETCDIR_NATIVE` |
| 7488 | Specifies the path to the ``/etc`` subdirectory of the sysroot | 7488 | Specifies the path to the ``/etc`` subdirectory of the sysroot |
| 7489 | directory for the build host. | 7489 | directory for the build host. |
| 7490 | 7490 | ||
| 7491 | STAGING_EXECPREFIXDIR | 7491 | :term:`STAGING_EXECPREFIXDIR` |
| 7492 | Specifies the path to the ``/usr`` subdirectory of the sysroot | 7492 | Specifies the path to the ``/usr`` subdirectory of the sysroot |
| 7493 | directory for the target for which the current recipe is being built | 7493 | directory for the target for which the current recipe is being built |
| 7494 | (:term:`STAGING_DIR_HOST`). | 7494 | (:term:`STAGING_DIR_HOST`). |
| 7495 | 7495 | ||
| 7496 | STAGING_INCDIR | 7496 | :term:`STAGING_INCDIR` |
| 7497 | Specifies the path to the ``/usr/include`` subdirectory of the | 7497 | Specifies the path to the ``/usr/include`` subdirectory of the |
| 7498 | sysroot directory for the target for which the current recipe being | 7498 | sysroot directory for the target for which the current recipe being |
| 7499 | built (:term:`STAGING_DIR_HOST`). | 7499 | built (:term:`STAGING_DIR_HOST`). |
| 7500 | 7500 | ||
| 7501 | STAGING_INCDIR_NATIVE | 7501 | :term:`STAGING_INCDIR_NATIVE` |
| 7502 | Specifies the path to the ``/usr/include`` subdirectory of the | 7502 | Specifies the path to the ``/usr/include`` subdirectory of the |
| 7503 | sysroot directory for the build host. | 7503 | sysroot directory for the build host. |
| 7504 | 7504 | ||
| 7505 | STAGING_KERNEL_BUILDDIR | 7505 | :term:`STAGING_KERNEL_BUILDDIR` |
| 7506 | Points to the directory containing the kernel build artifacts. | 7506 | Points to the directory containing the kernel build artifacts. |
| 7507 | Recipes building software that needs to access kernel build artifacts | 7507 | Recipes building software that needs to access kernel build artifacts |
| 7508 | (e.g. ``systemtap-uprobes``) can look in the directory specified with | 7508 | (e.g. ``systemtap-uprobes``) can look in the directory specified with |
| 7509 | the ``STAGING_KERNEL_BUILDDIR`` variable to find these artifacts | 7509 | the ``STAGING_KERNEL_BUILDDIR`` variable to find these artifacts |
| 7510 | after the kernel has been built. | 7510 | after the kernel has been built. |
| 7511 | 7511 | ||
| 7512 | STAGING_KERNEL_DIR | 7512 | :term:`STAGING_KERNEL_DIR` |
| 7513 | The directory with kernel headers that are required to build | 7513 | The directory with kernel headers that are required to build |
| 7514 | out-of-tree modules. | 7514 | out-of-tree modules. |
| 7515 | 7515 | ||
| 7516 | STAGING_LIBDIR | 7516 | :term:`STAGING_LIBDIR` |
| 7517 | Specifies the path to the ``/usr/lib`` subdirectory of the sysroot | 7517 | Specifies the path to the ``/usr/lib`` subdirectory of the sysroot |
| 7518 | directory for the target for which the current recipe is being built | 7518 | directory for the target for which the current recipe is being built |
| 7519 | (:term:`STAGING_DIR_HOST`). | 7519 | (:term:`STAGING_DIR_HOST`). |
| 7520 | 7520 | ||
| 7521 | STAGING_LIBDIR_NATIVE | 7521 | :term:`STAGING_LIBDIR_NATIVE` |
| 7522 | Specifies the path to the ``/usr/lib`` subdirectory of the sysroot | 7522 | Specifies the path to the ``/usr/lib`` subdirectory of the sysroot |
| 7523 | directory for the build host. | 7523 | directory for the build host. |
| 7524 | 7524 | ||
| 7525 | STAMP | 7525 | :term:`STAMP` |
| 7526 | Specifies the base path used to create recipe stamp files. The path | 7526 | Specifies the base path used to create recipe stamp files. The path |
| 7527 | to an actual stamp file is constructed by evaluating this string and | 7527 | to an actual stamp file is constructed by evaluating this string and |
| 7528 | then appending additional information. Currently, the default | 7528 | then appending additional information. Currently, the default |
| @@ -7543,26 +7543,26 @@ system and gives an overview of their function and contents. | |||
| 7543 | :term:`PV`, and :term:`PR` for related variable | 7543 | :term:`PV`, and :term:`PR` for related variable |
| 7544 | information. | 7544 | information. |
| 7545 | 7545 | ||
| 7546 | STAMPS_DIR | 7546 | :term:`STAMPS_DIR` |
| 7547 | Specifies the base directory in which the OpenEmbedded build system | 7547 | Specifies the base directory in which the OpenEmbedded build system |
| 7548 | places stamps. The default directory is ``${TMPDIR}/stamps``. | 7548 | places stamps. The default directory is ``${TMPDIR}/stamps``. |
| 7549 | 7549 | ||
| 7550 | STRIP | 7550 | :term:`STRIP` |
| 7551 | The minimal command and arguments to run ``strip``, which is used to | 7551 | The minimal command and arguments to run ``strip``, which is used to |
| 7552 | strip symbols. | 7552 | strip symbols. |
| 7553 | 7553 | ||
| 7554 | SUMMARY | 7554 | :term:`SUMMARY` |
| 7555 | The short (72 characters or less) summary of the binary package for | 7555 | The short (72 characters or less) summary of the binary package for |
| 7556 | packaging systems such as ``opkg``, ``rpm``, or ``dpkg``. By default, | 7556 | packaging systems such as ``opkg``, ``rpm``, or ``dpkg``. By default, |
| 7557 | ``SUMMARY`` is used to define the | 7557 | ``SUMMARY`` is used to define the |
| 7558 | :term:`DESCRIPTION` variable if ``DESCRIPTION`` is | 7558 | :term:`DESCRIPTION` variable if ``DESCRIPTION`` is |
| 7559 | not set in the recipe. | 7559 | not set in the recipe. |
| 7560 | 7560 | ||
| 7561 | SVNDIR | 7561 | :term:`SVNDIR` |
| 7562 | The directory in which files checked out of a Subversion system are | 7562 | The directory in which files checked out of a Subversion system are |
| 7563 | stored. | 7563 | stored. |
| 7564 | 7564 | ||
| 7565 | SYSLINUX_DEFAULT_CONSOLE | 7565 | :term:`SYSLINUX_DEFAULT_CONSOLE` |
| 7566 | Specifies the kernel boot default console. If you want to use a | 7566 | Specifies the kernel boot default console. If you want to use a |
| 7567 | console other than the default, set this variable in your recipe as | 7567 | console other than the default, set this variable in your recipe as |
| 7568 | follows where "X" is the console number you want to use: | 7568 | follows where "X" is the console number you want to use: |
| @@ -7573,7 +7573,7 @@ system and gives an overview of their function and contents. | |||
| 7573 | The :ref:`syslinux <ref-classes-syslinux>` class initially sets | 7573 | The :ref:`syslinux <ref-classes-syslinux>` class initially sets |
| 7574 | this variable to null but then checks for a value later. | 7574 | this variable to null but then checks for a value later. |
| 7575 | 7575 | ||
| 7576 | SYSLINUX_OPTS | 7576 | :term:`SYSLINUX_OPTS` |
| 7577 | Lists additional options to add to the syslinux file. You need to set | 7577 | Lists additional options to add to the syslinux file. You need to set |
| 7578 | this variable in your recipe. If you want to list multiple options, | 7578 | this variable in your recipe. If you want to list multiple options, |
| 7579 | separate the options with a semicolon character (``;``). | 7579 | separate the options with a semicolon character (``;``). |
| @@ -7581,7 +7581,7 @@ system and gives an overview of their function and contents. | |||
| 7581 | The :ref:`syslinux <ref-classes-syslinux>` class uses this variable | 7581 | The :ref:`syslinux <ref-classes-syslinux>` class uses this variable |
| 7582 | to create a set of options. | 7582 | to create a set of options. |
| 7583 | 7583 | ||
| 7584 | SYSLINUX_SERIAL | 7584 | :term:`SYSLINUX_SERIAL` |
| 7585 | Specifies the alternate serial port or turns it off. To turn off | 7585 | Specifies the alternate serial port or turns it off. To turn off |
| 7586 | serial, set this variable to an empty string in your recipe. The | 7586 | serial, set this variable to an empty string in your recipe. The |
| 7587 | variable's default value is set in the | 7587 | variable's default value is set in the |
| @@ -7592,7 +7592,7 @@ system and gives an overview of their function and contents. | |||
| 7592 | 7592 | ||
| 7593 | The class checks for and uses the variable as needed. | 7593 | The class checks for and uses the variable as needed. |
| 7594 | 7594 | ||
| 7595 | SYSLINUX_SERIAL_TTY | 7595 | :term:`SYSLINUX_SERIAL_TTY` |
| 7596 | Specifies the alternate console=tty... kernel boot argument. The | 7596 | Specifies the alternate console=tty... kernel boot argument. The |
| 7597 | variable's default value is set in the | 7597 | variable's default value is set in the |
| 7598 | :ref:`syslinux <ref-classes-syslinux>` class as follows: | 7598 | :ref:`syslinux <ref-classes-syslinux>` class as follows: |
| @@ -7602,7 +7602,7 @@ system and gives an overview of their function and contents. | |||
| 7602 | 7602 | ||
| 7603 | The class checks for and uses the variable as needed. | 7603 | The class checks for and uses the variable as needed. |
| 7604 | 7604 | ||
| 7605 | SYSLINUX_SPLASH | 7605 | :term:`SYSLINUX_SPLASH` |
| 7606 | An ``.LSS`` file used as the background for the VGA boot menu when | 7606 | An ``.LSS`` file used as the background for the VGA boot menu when |
| 7607 | you use the boot menu. You need to set this variable in your recipe. | 7607 | you use the boot menu. You need to set this variable in your recipe. |
| 7608 | 7608 | ||
| @@ -7610,13 +7610,13 @@ system and gives an overview of their function and contents. | |||
| 7610 | variable and if found, the OpenEmbedded build system installs the | 7610 | variable and if found, the OpenEmbedded build system installs the |
| 7611 | splash screen. | 7611 | splash screen. |
| 7612 | 7612 | ||
| 7613 | SYSROOT_DESTDIR | 7613 | :term:`SYSROOT_DESTDIR` |
| 7614 | Points to the temporary directory under the work directory (default | 7614 | Points to the temporary directory under the work directory (default |
| 7615 | "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``") | 7615 | "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``") |
| 7616 | where the files populated into the sysroot are assembled during the | 7616 | where the files populated into the sysroot are assembled during the |
| 7617 | :ref:`ref-tasks-populate_sysroot` task. | 7617 | :ref:`ref-tasks-populate_sysroot` task. |
| 7618 | 7618 | ||
| 7619 | SYSROOT_DIRS | 7619 | :term:`SYSROOT_DIRS` |
| 7620 | Directories that are staged into the sysroot by the | 7620 | Directories that are staged into the sysroot by the |
| 7621 | :ref:`ref-tasks-populate_sysroot` task. By | 7621 | :ref:`ref-tasks-populate_sysroot` task. By |
| 7622 | default, the following directories are staged: | 7622 | default, the following directories are staged: |
| @@ -7630,7 +7630,7 @@ system and gives an overview of their function and contents. | |||
| 7630 | ${datadir} \ | 7630 | ${datadir} \ |
| 7631 | " | 7631 | " |
| 7632 | 7632 | ||
| 7633 | SYSROOT_DIRS_BLACKLIST | 7633 | :term:`SYSROOT_DIRS_BLACKLIST` |
| 7634 | Directories that are not staged into the sysroot by the | 7634 | Directories that are not staged into the sysroot by the |
| 7635 | :ref:`ref-tasks-populate_sysroot` task. You | 7635 | :ref:`ref-tasks-populate_sysroot` task. You |
| 7636 | can use this variable to exclude certain subdirectories of | 7636 | can use this variable to exclude certain subdirectories of |
| @@ -7648,7 +7648,7 @@ system and gives an overview of their function and contents. | |||
| 7648 | ${datadir}/pixmaps \ | 7648 | ${datadir}/pixmaps \ |
| 7649 | " | 7649 | " |
| 7650 | 7650 | ||
| 7651 | SYSROOT_DIRS_NATIVE | 7651 | :term:`SYSROOT_DIRS_NATIVE` |
| 7652 | Extra directories staged into the sysroot by the | 7652 | Extra directories staged into the sysroot by the |
| 7653 | :ref:`ref-tasks-populate_sysroot` task for | 7653 | :ref:`ref-tasks-populate_sysroot` task for |
| 7654 | ``-native`` recipes, in addition to those specified in | 7654 | ``-native`` recipes, in addition to those specified in |
| @@ -7675,12 +7675,12 @@ system and gives an overview of their function and contents. | |||
| 7675 | ), which is why additional directories containing program | 7675 | ), which is why additional directories containing program |
| 7676 | executables and supporting files need to be staged. | 7676 | executables and supporting files need to be staged. |
| 7677 | 7677 | ||
| 7678 | SYSROOT_PREPROCESS_FUNCS | 7678 | :term:`SYSROOT_PREPROCESS_FUNCS` |
| 7679 | A list of functions to execute after files are staged into the | 7679 | A list of functions to execute after files are staged into the |
| 7680 | sysroot. These functions are usually used to apply additional | 7680 | sysroot. These functions are usually used to apply additional |
| 7681 | processing on the staged files, or to stage additional files. | 7681 | processing on the staged files, or to stage additional files. |
| 7682 | 7682 | ||
| 7683 | SYSTEMD_AUTO_ENABLE | 7683 | :term:`SYSTEMD_AUTO_ENABLE` |
| 7684 | When inheriting the :ref:`systemd <ref-classes-systemd>` class, | 7684 | When inheriting the :ref:`systemd <ref-classes-systemd>` class, |
| 7685 | this variable specifies whether the specified service in | 7685 | this variable specifies whether the specified service in |
| 7686 | :term:`SYSTEMD_SERVICE` should start | 7686 | :term:`SYSTEMD_SERVICE` should start |
| @@ -7693,7 +7693,7 @@ system and gives an overview of their function and contents. | |||
| 7693 | 7693 | ||
| 7694 | You can disable the service by setting the variable to "disable". | 7694 | You can disable the service by setting the variable to "disable". |
| 7695 | 7695 | ||
| 7696 | SYSTEMD_BOOT_CFG | 7696 | :term:`SYSTEMD_BOOT_CFG` |
| 7697 | When :term:`EFI_PROVIDER` is set to | 7697 | When :term:`EFI_PROVIDER` is set to |
| 7698 | "systemd-boot", the ``SYSTEMD_BOOT_CFG`` variable specifies the | 7698 | "systemd-boot", the ``SYSTEMD_BOOT_CFG`` variable specifies the |
| 7699 | configuration file that should be used. By default, the | 7699 | configuration file that should be used. By default, the |
| @@ -7706,7 +7706,7 @@ system and gives an overview of their function and contents. | |||
| 7706 | For information on Systemd-boot, see the `Systemd-boot | 7706 | For information on Systemd-boot, see the `Systemd-boot |
| 7707 | documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. | 7707 | documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. |
| 7708 | 7708 | ||
| 7709 | SYSTEMD_BOOT_ENTRIES | 7709 | :term:`SYSTEMD_BOOT_ENTRIES` |
| 7710 | When :term:`EFI_PROVIDER` is set to | 7710 | When :term:`EFI_PROVIDER` is set to |
| 7711 | "systemd-boot", the ``SYSTEMD_BOOT_ENTRIES`` variable specifies a | 7711 | "systemd-boot", the ``SYSTEMD_BOOT_ENTRIES`` variable specifies a |
| 7712 | list of entry files (``*.conf``) to install that contain one boot | 7712 | list of entry files (``*.conf``) to install that contain one boot |
| @@ -7720,7 +7720,7 @@ system and gives an overview of their function and contents. | |||
| 7720 | For information on Systemd-boot, see the `Systemd-boot | 7720 | For information on Systemd-boot, see the `Systemd-boot |
| 7721 | documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. | 7721 | documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. |
| 7722 | 7722 | ||
| 7723 | SYSTEMD_BOOT_TIMEOUT | 7723 | :term:`SYSTEMD_BOOT_TIMEOUT` |
| 7724 | When :term:`EFI_PROVIDER` is set to | 7724 | When :term:`EFI_PROVIDER` is set to |
| 7725 | "systemd-boot", the ``SYSTEMD_BOOT_TIMEOUT`` variable specifies the | 7725 | "systemd-boot", the ``SYSTEMD_BOOT_TIMEOUT`` variable specifies the |
| 7726 | boot menu timeout in seconds. By default, the | 7726 | boot menu timeout in seconds. By default, the |
| @@ -7733,7 +7733,7 @@ system and gives an overview of their function and contents. | |||
| 7733 | For information on Systemd-boot, see the `Systemd-boot | 7733 | For information on Systemd-boot, see the `Systemd-boot |
| 7734 | documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. | 7734 | documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. |
| 7735 | 7735 | ||
| 7736 | SYSTEMD_PACKAGES | 7736 | :term:`SYSTEMD_PACKAGES` |
| 7737 | When inheriting the :ref:`systemd <ref-classes-systemd>` class, | 7737 | When inheriting the :ref:`systemd <ref-classes-systemd>` class, |
| 7738 | this variable locates the systemd unit files when they are not found | 7738 | this variable locates the systemd unit files when they are not found |
| 7739 | in the main recipe's package. By default, the ``SYSTEMD_PACKAGES`` | 7739 | in the main recipe's package. By default, the ``SYSTEMD_PACKAGES`` |
| @@ -7747,7 +7747,7 @@ system and gives an overview of their function and contents. | |||
| 7747 | to use ``SYSTEMD_PACKAGES`` to list the package or packages in which | 7747 | to use ``SYSTEMD_PACKAGES`` to list the package or packages in which |
| 7748 | the build system can find the systemd unit files. | 7748 | the build system can find the systemd unit files. |
| 7749 | 7749 | ||
| 7750 | SYSTEMD_SERVICE | 7750 | :term:`SYSTEMD_SERVICE` |
| 7751 | When inheriting the :ref:`systemd <ref-classes-systemd>` class, | 7751 | When inheriting the :ref:`systemd <ref-classes-systemd>` class, |
| 7752 | this variable specifies the systemd service name for a package. | 7752 | this variable specifies the systemd service name for a package. |
| 7753 | 7753 | ||
| @@ -7758,7 +7758,7 @@ system and gives an overview of their function and contents. | |||
| 7758 | 7758 | ||
| 7759 | SYSTEMD_SERVICE_${PN} = "connman.service" | 7759 | SYSTEMD_SERVICE_${PN} = "connman.service" |
| 7760 | 7760 | ||
| 7761 | SYSVINIT_ENABLED_GETTYS | 7761 | :term:`SYSVINIT_ENABLED_GETTYS` |
| 7762 | When using | 7762 | When using |
| 7763 | :ref:`SysVinit <dev-manual/dev-manual-common-tasks:enabling system services>`, | 7763 | :ref:`SysVinit <dev-manual/dev-manual-common-tasks:enabling system services>`, |
| 7764 | specifies a space-separated list of the virtual terminals that should | 7764 | specifies a space-separated list of the virtual terminals that should |
| @@ -7769,7 +7769,7 @@ system and gives an overview of their function and contents. | |||
| 7769 | The default value for ``SYSVINIT_ENABLED_GETTYS`` is "1" (i.e. only | 7769 | The default value for ``SYSVINIT_ENABLED_GETTYS`` is "1" (i.e. only |
| 7770 | run a getty on the first virtual terminal). | 7770 | run a getty on the first virtual terminal). |
| 7771 | 7771 | ||
| 7772 | T | 7772 | :term:`T` |
| 7773 | This variable points to a directory were BitBake places temporary | 7773 | This variable points to a directory were BitBake places temporary |
| 7774 | files, which consist mostly of task logs and scripts, when building a | 7774 | files, which consist mostly of task logs and scripts, when building a |
| 7775 | particular recipe. The variable is typically set as follows: | 7775 | particular recipe. The variable is typically set as follows: |
| @@ -7786,7 +7786,7 @@ system and gives an overview of their function and contents. | |||
| 7786 | the directory tree where BitBake places the output of an entire | 7786 | the directory tree where BitBake places the output of an entire |
| 7787 | build. | 7787 | build. |
| 7788 | 7788 | ||
| 7789 | TARGET_ARCH | 7789 | :term:`TARGET_ARCH` |
| 7790 | The target machine's architecture. The OpenEmbedded build system | 7790 | The target machine's architecture. The OpenEmbedded build system |
| 7791 | supports many architectures. Here is an example list of architectures | 7791 | supports many architectures. Here is an example list of architectures |
| 7792 | supported. This list is by no means complete as the architecture is | 7792 | supported. This list is by no means complete as the architecture is |
| @@ -7803,7 +7803,7 @@ system and gives an overview of their function and contents. | |||
| 7803 | For additional information on machine architectures, see the | 7803 | For additional information on machine architectures, see the |
| 7804 | :term:`TUNE_ARCH` variable. | 7804 | :term:`TUNE_ARCH` variable. |
| 7805 | 7805 | ||
| 7806 | TARGET_AS_ARCH | 7806 | :term:`TARGET_AS_ARCH` |
| 7807 | Specifies architecture-specific assembler flags for the target | 7807 | Specifies architecture-specific assembler flags for the target |
| 7808 | system. ``TARGET_AS_ARCH`` is initialized from | 7808 | system. ``TARGET_AS_ARCH`` is initialized from |
| 7809 | :term:`TUNE_ASARGS` by default in the BitBake | 7809 | :term:`TUNE_ASARGS` by default in the BitBake |
| @@ -7812,7 +7812,7 @@ system and gives an overview of their function and contents. | |||
| 7812 | 7812 | ||
| 7813 | TARGET_AS_ARCH = "${TUNE_ASARGS}" | 7813 | TARGET_AS_ARCH = "${TUNE_ASARGS}" |
| 7814 | 7814 | ||
| 7815 | TARGET_CC_ARCH | 7815 | :term:`TARGET_CC_ARCH` |
| 7816 | Specifies architecture-specific C compiler flags for the target | 7816 | Specifies architecture-specific C compiler flags for the target |
| 7817 | system. ``TARGET_CC_ARCH`` is initialized from | 7817 | system. ``TARGET_CC_ARCH`` is initialized from |
| 7818 | :term:`TUNE_CCARGS` by default. | 7818 | :term:`TUNE_CCARGS` by default. |
| @@ -7828,7 +7828,7 @@ system and gives an overview of their function and contents. | |||
| 7828 | LDFLAGS | 7828 | LDFLAGS |
| 7829 | variable. | 7829 | variable. |
| 7830 | 7830 | ||
| 7831 | TARGET_CC_KERNEL_ARCH | 7831 | :term:`TARGET_CC_KERNEL_ARCH` |
| 7832 | This is a specific kernel compiler flag for a CPU or Application | 7832 | This is a specific kernel compiler flag for a CPU or Application |
| 7833 | Binary Interface (ABI) tune. The flag is used rarely and only for | 7833 | Binary Interface (ABI) tune. The flag is used rarely and only for |
| 7834 | cases where a userspace :term:`TUNE_CCARGS` is not | 7834 | cases where a userspace :term:`TUNE_CCARGS` is not |
| @@ -7838,7 +7838,7 @@ system and gives an overview of their function and contents. | |||
| 7838 | ``meta/conf/machine/include/arm/feature-arm-thumb.inc`` file in the | 7838 | ``meta/conf/machine/include/arm/feature-arm-thumb.inc`` file in the |
| 7839 | :term:`Source Directory` for an example. | 7839 | :term:`Source Directory` for an example. |
| 7840 | 7840 | ||
| 7841 | TARGET_CFLAGS | 7841 | :term:`TARGET_CFLAGS` |
| 7842 | Specifies the flags to pass to the C compiler when building for the | 7842 | Specifies the flags to pass to the C compiler when building for the |
| 7843 | target. When building in the target context, | 7843 | target. When building in the target context, |
| 7844 | :term:`CFLAGS` is set to the value of this variable by | 7844 | :term:`CFLAGS` is set to the value of this variable by |
| @@ -7848,7 +7848,7 @@ system and gives an overview of their function and contents. | |||
| 7848 | variable in the environment to the ``TARGET_CFLAGS`` value so that | 7848 | variable in the environment to the ``TARGET_CFLAGS`` value so that |
| 7849 | executables built using the SDK also have the flags applied. | 7849 | executables built using the SDK also have the flags applied. |
| 7850 | 7850 | ||
| 7851 | TARGET_CPPFLAGS | 7851 | :term:`TARGET_CPPFLAGS` |
| 7852 | Specifies the flags to pass to the C pre-processor (i.e. to both the | 7852 | Specifies the flags to pass to the C pre-processor (i.e. to both the |
| 7853 | C and the C++ compilers) when building for the target. When building | 7853 | C and the C++ compilers) when building for the target. When building |
| 7854 | in the target context, :term:`CPPFLAGS` is set to the | 7854 | in the target context, :term:`CPPFLAGS` is set to the |
| @@ -7859,7 +7859,7 @@ system and gives an overview of their function and contents. | |||
| 7859 | value so that executables built using the SDK also have the flags | 7859 | value so that executables built using the SDK also have the flags |
| 7860 | applied. | 7860 | applied. |
| 7861 | 7861 | ||
| 7862 | TARGET_CXXFLAGS | 7862 | :term:`TARGET_CXXFLAGS` |
| 7863 | Specifies the flags to pass to the C++ compiler when building for the | 7863 | Specifies the flags to pass to the C++ compiler when building for the |
| 7864 | target. When building in the target context, | 7864 | target. When building in the target context, |
| 7865 | :term:`CXXFLAGS` is set to the value of this variable | 7865 | :term:`CXXFLAGS` is set to the value of this variable |
| @@ -7870,13 +7870,13 @@ system and gives an overview of their function and contents. | |||
| 7870 | value so that executables built using the SDK also have the flags | 7870 | value so that executables built using the SDK also have the flags |
| 7871 | applied. | 7871 | applied. |
| 7872 | 7872 | ||
| 7873 | TARGET_FPU | 7873 | :term:`TARGET_FPU` |
| 7874 | Specifies the method for handling FPU code. For FPU-less targets, | 7874 | Specifies the method for handling FPU code. For FPU-less targets, |
| 7875 | which include most ARM CPUs, the variable must be set to "soft". If | 7875 | which include most ARM CPUs, the variable must be set to "soft". If |
| 7876 | not, the kernel emulation gets used, which results in a performance | 7876 | not, the kernel emulation gets used, which results in a performance |
| 7877 | penalty. | 7877 | penalty. |
| 7878 | 7878 | ||
| 7879 | TARGET_LD_ARCH | 7879 | :term:`TARGET_LD_ARCH` |
| 7880 | Specifies architecture-specific linker flags for the target system. | 7880 | Specifies architecture-specific linker flags for the target system. |
| 7881 | ``TARGET_LD_ARCH`` is initialized from | 7881 | ``TARGET_LD_ARCH`` is initialized from |
| 7882 | :term:`TUNE_LDARGS` by default in the BitBake | 7882 | :term:`TUNE_LDARGS` by default in the BitBake |
| @@ -7885,7 +7885,7 @@ system and gives an overview of their function and contents. | |||
| 7885 | 7885 | ||
| 7886 | TARGET_LD_ARCH = "${TUNE_LDARGS}" | 7886 | TARGET_LD_ARCH = "${TUNE_LDARGS}" |
| 7887 | 7887 | ||
| 7888 | TARGET_LDFLAGS | 7888 | :term:`TARGET_LDFLAGS` |
| 7889 | Specifies the flags to pass to the linker when building for the | 7889 | Specifies the flags to pass to the linker when building for the |
| 7890 | target. When building in the target context, | 7890 | target. When building in the target context, |
| 7891 | :term:`LDFLAGS` is set to the value of this variable | 7891 | :term:`LDFLAGS` is set to the value of this variable |
| @@ -7896,13 +7896,13 @@ system and gives an overview of their function and contents. | |||
| 7896 | ``TARGET_LDFLAGS`` value so that executables built using the SDK also | 7896 | ``TARGET_LDFLAGS`` value so that executables built using the SDK also |
| 7897 | have the flags applied. | 7897 | have the flags applied. |
| 7898 | 7898 | ||
| 7899 | TARGET_OS | 7899 | :term:`TARGET_OS` |
| 7900 | Specifies the target's operating system. The variable can be set to | 7900 | Specifies the target's operating system. The variable can be set to |
| 7901 | "linux" for glibc-based systems (GNU C Library) and to "linux-musl" | 7901 | "linux" for glibc-based systems (GNU C Library) and to "linux-musl" |
| 7902 | for musl libc. For ARM/EABI targets, "linux-gnueabi" and | 7902 | for musl libc. For ARM/EABI targets, "linux-gnueabi" and |
| 7903 | "linux-musleabi" possible values exist. | 7903 | "linux-musleabi" possible values exist. |
| 7904 | 7904 | ||
| 7905 | TARGET_PREFIX | 7905 | :term:`TARGET_PREFIX` |
| 7906 | Specifies the prefix used for the toolchain binary target tools. | 7906 | Specifies the prefix used for the toolchain binary target tools. |
| 7907 | 7907 | ||
| 7908 | Depending on the type of recipe and the build target, | 7908 | Depending on the type of recipe and the build target, |
| @@ -7917,7 +7917,7 @@ system and gives an overview of their function and contents. | |||
| 7917 | - For native SDK recipes (``nativesdk``), the build system sets the | 7917 | - For native SDK recipes (``nativesdk``), the build system sets the |
| 7918 | variable to the value of ``SDK_PREFIX``. | 7918 | variable to the value of ``SDK_PREFIX``. |
| 7919 | 7919 | ||
| 7920 | TARGET_SYS | 7920 | :term:`TARGET_SYS` |
| 7921 | Specifies the system, including the architecture and the operating | 7921 | Specifies the system, including the architecture and the operating |
| 7922 | system, for which the build is occurring in the context of the | 7922 | system, for which the build is occurring in the context of the |
| 7923 | current recipe. | 7923 | current recipe. |
| @@ -7939,17 +7939,17 @@ system and gives an overview of their function and contents. | |||
| 7939 | - Given a recipe being built for a little-endian, MIPS target | 7939 | - Given a recipe being built for a little-endian, MIPS target |
| 7940 | running Linux, the value might be "mipsel-linux". | 7940 | running Linux, the value might be "mipsel-linux". |
| 7941 | 7941 | ||
| 7942 | TARGET_VENDOR | 7942 | :term:`TARGET_VENDOR` |
| 7943 | Specifies the name of the target vendor. | 7943 | Specifies the name of the target vendor. |
| 7944 | 7944 | ||
| 7945 | TCLIBC | 7945 | :term:`TCLIBC` |
| 7946 | Specifies the GNU standard C library (``libc``) variant to use during | 7946 | Specifies the GNU standard C library (``libc``) variant to use during |
| 7947 | the build process. This variable replaces ``POKYLIBC``, which is no | 7947 | the build process. This variable replaces ``POKYLIBC``, which is no |
| 7948 | longer supported. | 7948 | longer supported. |
| 7949 | 7949 | ||
| 7950 | You can select "glibc", "musl", "newlib", or "baremetal" | 7950 | You can select "glibc", "musl", "newlib", or "baremetal" |
| 7951 | 7951 | ||
| 7952 | TCLIBCAPPEND | 7952 | :term:`TCLIBCAPPEND` |
| 7953 | Specifies a suffix to be appended onto the | 7953 | Specifies a suffix to be appended onto the |
| 7954 | :term:`TMPDIR` value. The suffix identifies the | 7954 | :term:`TMPDIR` value. The suffix identifies the |
| 7955 | ``libc`` variant for building. When you are building for multiple | 7955 | ``libc`` variant for building. When you are building for multiple |
| @@ -7963,7 +7963,7 @@ system and gives an overview of their function and contents. | |||
| 7963 | ``TCLIBCAPPEND`` to "" in their distro configuration file resulting | 7963 | ``TCLIBCAPPEND`` to "" in their distro configuration file resulting |
| 7964 | in no suffix being applied. | 7964 | in no suffix being applied. |
| 7965 | 7965 | ||
| 7966 | TCMODE | 7966 | :term:`TCMODE` |
| 7967 | Specifies the toolchain selector. ``TCMODE`` controls the | 7967 | Specifies the toolchain selector. ``TCMODE`` controls the |
| 7968 | characteristics of the generated packages and images by telling the | 7968 | characteristics of the generated packages and images by telling the |
| 7969 | OpenEmbedded build system which toolchain profile to use. By default, | 7969 | OpenEmbedded build system which toolchain profile to use. By default, |
| @@ -8007,7 +8007,7 @@ system and gives an overview of their function and contents. | |||
| 8007 | toolchain. You can use ``meta-sourcery`` as a template for adding | 8007 | toolchain. You can use ``meta-sourcery`` as a template for adding |
| 8008 | support for other external toolchains. | 8008 | support for other external toolchains. |
| 8009 | 8009 | ||
| 8010 | TEST_EXPORT_DIR | 8010 | :term:`TEST_EXPORT_DIR` |
| 8011 | The location the OpenEmbedded build system uses to export tests when | 8011 | The location the OpenEmbedded build system uses to export tests when |
| 8012 | the :term:`TEST_EXPORT_ONLY` variable is set | 8012 | the :term:`TEST_EXPORT_ONLY` variable is set |
| 8013 | to "1". | 8013 | to "1". |
| @@ -8015,12 +8015,12 @@ system and gives an overview of their function and contents. | |||
| 8015 | The ``TEST_EXPORT_DIR`` variable defaults to | 8015 | The ``TEST_EXPORT_DIR`` variable defaults to |
| 8016 | ``"${TMPDIR}/testimage/${PN}"``. | 8016 | ``"${TMPDIR}/testimage/${PN}"``. |
| 8017 | 8017 | ||
| 8018 | TEST_EXPORT_ONLY | 8018 | :term:`TEST_EXPORT_ONLY` |
| 8019 | Specifies to export the tests only. Set this variable to "1" if you | 8019 | Specifies to export the tests only. Set this variable to "1" if you |
| 8020 | do not want to run the tests but you want them to be exported in a | 8020 | do not want to run the tests but you want them to be exported in a |
| 8021 | manner that you to run them outside of the build system. | 8021 | manner that you to run them outside of the build system. |
| 8022 | 8022 | ||
| 8023 | TEST_LOG_DIR | 8023 | :term:`TEST_LOG_DIR` |
| 8024 | Holds the SSH log and the boot log for QEMU machines. The | 8024 | Holds the SSH log and the boot log for QEMU machines. The |
| 8025 | ``TEST_LOG_DIR`` variable defaults to ``"${WORKDIR}/testimage"``. | 8025 | ``TEST_LOG_DIR`` variable defaults to ``"${WORKDIR}/testimage"``. |
| 8026 | 8026 | ||
| @@ -8032,7 +8032,7 @@ system and gives an overview of their function and contents. | |||
| 8032 | ${WORKDIR}/temp/ | 8032 | ${WORKDIR}/temp/ |
| 8033 | directory. | 8033 | directory. |
| 8034 | 8034 | ||
| 8035 | TEST_POWERCONTROL_CMD | 8035 | :term:`TEST_POWERCONTROL_CMD` |
| 8036 | For automated hardware testing, specifies the command to use to | 8036 | For automated hardware testing, specifies the command to use to |
| 8037 | control the power of the target machine under test. Typically, this | 8037 | control the power of the target machine under test. Typically, this |
| 8038 | command would point to a script that performs the appropriate action | 8038 | command would point to a script that performs the appropriate action |
| @@ -8041,7 +8041,7 @@ system and gives an overview of their function and contents. | |||
| 8041 | "cycle" specifying to power off, on, or cycle (power off and then | 8041 | "cycle" specifying to power off, on, or cycle (power off and then |
| 8042 | power on) the device, respectively. | 8042 | power on) the device, respectively. |
| 8043 | 8043 | ||
| 8044 | TEST_POWERCONTROL_EXTRA_ARGS | 8044 | :term:`TEST_POWERCONTROL_EXTRA_ARGS` |
| 8045 | For automated hardware testing, specifies additional arguments to | 8045 | For automated hardware testing, specifies additional arguments to |
| 8046 | pass through to the command specified in | 8046 | pass through to the command specified in |
| 8047 | :term:`TEST_POWERCONTROL_CMD`. Setting | 8047 | :term:`TEST_POWERCONTROL_CMD`. Setting |
| @@ -8049,7 +8049,7 @@ system and gives an overview of their function and contents. | |||
| 8049 | wish, for example, to separate the machine-specific and | 8049 | wish, for example, to separate the machine-specific and |
| 8050 | non-machine-specific parts of the arguments. | 8050 | non-machine-specific parts of the arguments. |
| 8051 | 8051 | ||
| 8052 | TEST_QEMUBOOT_TIMEOUT | 8052 | :term:`TEST_QEMUBOOT_TIMEOUT` |
| 8053 | The time in seconds allowed for an image to boot before automated | 8053 | The time in seconds allowed for an image to boot before automated |
| 8054 | runtime tests begin to run against an image. The default timeout | 8054 | runtime tests begin to run against an image. The default timeout |
| 8055 | period to allow the boot process to reach the login prompt is 500 | 8055 | period to allow the boot process to reach the login prompt is 500 |
| @@ -8060,7 +8060,7 @@ system and gives an overview of their function and contents. | |||
| 8060 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | 8060 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" |
| 8061 | section in the Yocto Project Development Tasks Manual. | 8061 | section in the Yocto Project Development Tasks Manual. |
| 8062 | 8062 | ||
| 8063 | TEST_SERIALCONTROL_CMD | 8063 | :term:`TEST_SERIALCONTROL_CMD` |
| 8064 | For automated hardware testing, specifies the command to use to | 8064 | For automated hardware testing, specifies the command to use to |
| 8065 | connect to the serial console of the target machine under test. This | 8065 | connect to the serial console of the target machine under test. This |
| 8066 | command simply needs to connect to the serial console and forward | 8066 | command simply needs to connect to the serial console and forward |
| @@ -8073,7 +8073,7 @@ system and gives an overview of their function and contents. | |||
| 8073 | 8073 | ||
| 8074 | TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200" | 8074 | TEST_SERIALCONTROL_CMD = "picocom /dev/ttyUSB0 -b 115200" |
| 8075 | 8075 | ||
| 8076 | TEST_SERIALCONTROL_EXTRA_ARGS | 8076 | :term:`TEST_SERIALCONTROL_EXTRA_ARGS` |
| 8077 | For automated hardware testing, specifies additional arguments to | 8077 | For automated hardware testing, specifies additional arguments to |
| 8078 | pass through to the command specified in | 8078 | pass through to the command specified in |
| 8079 | :term:`TEST_SERIALCONTROL_CMD`. Setting | 8079 | :term:`TEST_SERIALCONTROL_CMD`. Setting |
| @@ -8081,7 +8081,7 @@ system and gives an overview of their function and contents. | |||
| 8081 | wish, for example, to separate the machine-specific and | 8081 | wish, for example, to separate the machine-specific and |
| 8082 | non-machine-specific parts of the command. | 8082 | non-machine-specific parts of the command. |
| 8083 | 8083 | ||
| 8084 | TEST_SERVER_IP | 8084 | :term:`TEST_SERVER_IP` |
| 8085 | The IP address of the build machine (host machine). This IP address | 8085 | The IP address of the build machine (host machine). This IP address |
| 8086 | is usually automatically detected. However, if detection fails, this | 8086 | is usually automatically detected. However, if detection fails, this |
| 8087 | variable needs to be set to the IP address of the build machine (i.e. | 8087 | variable needs to be set to the IP address of the build machine (i.e. |
| @@ -8096,7 +8096,7 @@ system and gives an overview of their function and contents. | |||
| 8096 | WORKDIR/oe-rootfs-repo | 8096 | WORKDIR/oe-rootfs-repo |
| 8097 | . | 8097 | . |
| 8098 | 8098 | ||
| 8099 | TEST_SUITES | 8099 | :term:`TEST_SUITES` |
| 8100 | An ordered list of tests (modules) to run against an image when | 8100 | An ordered list of tests (modules) to run against an image when |
| 8101 | performing automated runtime testing. | 8101 | performing automated runtime testing. |
| 8102 | 8102 | ||
| @@ -8139,7 +8139,7 @@ system and gives an overview of their function and contents. | |||
| 8139 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" | 8139 | ":ref:`dev-manual/dev-manual-common-tasks:performing automated runtime testing`" |
| 8140 | section in the Yocto Project Development Tasks Manual. | 8140 | section in the Yocto Project Development Tasks Manual. |
| 8141 | 8141 | ||
| 8142 | TEST_TARGET | 8142 | :term:`TEST_TARGET` |
| 8143 | Specifies the target controller to use when running tests against a | 8143 | Specifies the target controller to use when running tests against a |
| 8144 | test image. The default controller to use is "qemu": | 8144 | test image. The default controller to use is "qemu": |
| 8145 | :: | 8145 | :: |
| @@ -8176,7 +8176,7 @@ system and gives an overview of their function and contents. | |||
| 8176 | ":ref:`hardware-image-enabling-tests`" | 8176 | ":ref:`hardware-image-enabling-tests`" |
| 8177 | section in the Yocto Project Development Tasks Manual. | 8177 | section in the Yocto Project Development Tasks Manual. |
| 8178 | 8178 | ||
| 8179 | TEST_TARGET_IP | 8179 | :term:`TEST_TARGET_IP` |
| 8180 | The IP address of your hardware under test. The ``TEST_TARGET_IP`` | 8180 | The IP address of your hardware under test. The ``TEST_TARGET_IP`` |
| 8181 | variable has no effect when :term:`TEST_TARGET` is | 8181 | variable has no effect when :term:`TEST_TARGET` is |
| 8182 | set to "qemu". | 8182 | set to "qemu". |
| @@ -8193,7 +8193,7 @@ system and gives an overview of their function and contents. | |||
| 8193 | directly accessible from your host and you need to do port address | 8193 | directly accessible from your host and you need to do port address |
| 8194 | translation. | 8194 | translation. |
| 8195 | 8195 | ||
| 8196 | TESTIMAGE_AUTO | 8196 | :term:`TESTIMAGE_AUTO` |
| 8197 | Automatically runs the series of automated tests for images when an | 8197 | Automatically runs the series of automated tests for images when an |
| 8198 | image is successfully built. Setting ``TESTIMAGE_AUTO`` to "1" causes | 8198 | image is successfully built. Setting ``TESTIMAGE_AUTO`` to "1" causes |
| 8199 | any image that successfully builds to automatically boot under QEMU. | 8199 | any image that successfully builds to automatically boot under QEMU. |
| @@ -8215,16 +8215,16 @@ system and gives an overview of their function and contents. | |||
| 8215 | section in the Yocto Project Development Tasks Manual and the | 8215 | section in the Yocto Project Development Tasks Manual and the |
| 8216 | ":ref:`testimage*.bbclass <ref-classes-testimage*>`" section. | 8216 | ":ref:`testimage*.bbclass <ref-classes-testimage*>`" section. |
| 8217 | 8217 | ||
| 8218 | THISDIR | 8218 | :term:`THISDIR` |
| 8219 | The directory in which the file BitBake is currently parsing is | 8219 | The directory in which the file BitBake is currently parsing is |
| 8220 | located. Do not manually set this variable. | 8220 | located. Do not manually set this variable. |
| 8221 | 8221 | ||
| 8222 | TIME | 8222 | :term:`TIME` |
| 8223 | The time the build was started. Times appear using the hour, minute, | 8223 | The time the build was started. Times appear using the hour, minute, |
| 8224 | and second (HMS) format (e.g. "140159" for one minute and fifty-nine | 8224 | and second (HMS) format (e.g. "140159" for one minute and fifty-nine |
| 8225 | seconds past 1400 hours). | 8225 | seconds past 1400 hours). |
| 8226 | 8226 | ||
| 8227 | TMPDIR | 8227 | :term:`TMPDIR` |
| 8228 | This variable is the base directory the OpenEmbedded build system | 8228 | This variable is the base directory the OpenEmbedded build system |
| 8229 | uses for all build output and intermediate files (other than the | 8229 | uses for all build output and intermediate files (other than the |
| 8230 | shared state cache). By default, the ``TMPDIR`` variable points to | 8230 | shared state cache). By default, the ``TMPDIR`` variable points to |
| @@ -8246,7 +8246,7 @@ system and gives an overview of their function and contents. | |||
| 8246 | implementations, NFS does not meet this minimum requirement. | 8246 | implementations, NFS does not meet this minimum requirement. |
| 8247 | Consequently, ``TMPDIR`` cannot be on NFS. | 8247 | Consequently, ``TMPDIR`` cannot be on NFS. |
| 8248 | 8248 | ||
| 8249 | TOOLCHAIN_HOST_TASK | 8249 | :term:`TOOLCHAIN_HOST_TASK` |
| 8250 | This variable lists packages the OpenEmbedded build system uses when | 8250 | This variable lists packages the OpenEmbedded build system uses when |
| 8251 | building an SDK, which contains a cross-development environment. The | 8251 | building an SDK, which contains a cross-development environment. The |
| 8252 | packages specified by this variable are part of the toolchain set | 8252 | packages specified by this variable are part of the toolchain set |
| @@ -8271,7 +8271,7 @@ system and gives an overview of their function and contents. | |||
| 8271 | information on setting up a cross-development environment, see the | 8271 | information on setting up a cross-development environment, see the |
| 8272 | :doc:`../sdk-manual/sdk-manual` manual. | 8272 | :doc:`../sdk-manual/sdk-manual` manual. |
| 8273 | 8273 | ||
| 8274 | TOOLCHAIN_OUTPUTNAME | 8274 | :term:`TOOLCHAIN_OUTPUTNAME` |
| 8275 | This variable defines the name used for the toolchain output. The | 8275 | This variable defines the name used for the toolchain output. The |
| 8276 | :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class sets | 8276 | :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class sets |
| 8277 | the ``TOOLCHAIN_OUTPUTNAME`` variable as follows: | 8277 | the ``TOOLCHAIN_OUTPUTNAME`` variable as follows: |
| @@ -8284,7 +8284,7 @@ system and gives an overview of their function and contents. | |||
| 8284 | :term:`SDK_VERSION` variables for additional | 8284 | :term:`SDK_VERSION` variables for additional |
| 8285 | information. | 8285 | information. |
| 8286 | 8286 | ||
| 8287 | TOOLCHAIN_TARGET_TASK | 8287 | :term:`TOOLCHAIN_TARGET_TASK` |
| 8288 | This variable lists packages the OpenEmbedded build system uses when | 8288 | This variable lists packages the OpenEmbedded build system uses when |
| 8289 | it creates the target part of an SDK (i.e. the part built for the | 8289 | it creates the target part of an SDK (i.e. the part built for the |
| 8290 | target hardware), which includes libraries and headers. Use this | 8290 | target hardware), which includes libraries and headers. Use this |
| @@ -8301,12 +8301,12 @@ system and gives an overview of their function and contents. | |||
| 8301 | information on setting up a cross-development environment, see the | 8301 | information on setting up a cross-development environment, see the |
| 8302 | :doc:`../sdk-manual/sdk-manual` manual. | 8302 | :doc:`../sdk-manual/sdk-manual` manual. |
| 8303 | 8303 | ||
| 8304 | TOPDIR | 8304 | :term:`TOPDIR` |
| 8305 | The top-level :term:`Build Directory`. BitBake | 8305 | The top-level :term:`Build Directory`. BitBake |
| 8306 | automatically sets this variable when you initialize your build | 8306 | automatically sets this variable when you initialize your build |
| 8307 | environment using ````` <#structure-core-script>`__. | 8307 | environment using ````` <#structure-core-script>`__. |
| 8308 | 8308 | ||
| 8309 | TRANSLATED_TARGET_ARCH | 8309 | :term:`TRANSLATED_TARGET_ARCH` |
| 8310 | A sanitized version of :term:`TARGET_ARCH`. This | 8310 | A sanitized version of :term:`TARGET_ARCH`. This |
| 8311 | variable is used where the architecture is needed in a value where | 8311 | variable is used where the architecture is needed in a value where |
| 8312 | underscores are not allowed, for example within package filenames. In | 8312 | underscores are not allowed, for example within package filenames. In |
| @@ -8315,7 +8315,7 @@ system and gives an overview of their function and contents. | |||
| 8315 | 8315 | ||
| 8316 | Do not edit this variable. | 8316 | Do not edit this variable. |
| 8317 | 8317 | ||
| 8318 | TUNE_ARCH | 8318 | :term:`TUNE_ARCH` |
| 8319 | The GNU canonical architecture for a specific architecture (i.e. | 8319 | The GNU canonical architecture for a specific architecture (i.e. |
| 8320 | ``arm``, ``armeb``, ``mips``, ``mips64``, and so forth). BitBake uses | 8320 | ``arm``, ``armeb``, ``mips``, ``mips64``, and so forth). BitBake uses |
| 8321 | this value to setup configuration. | 8321 | this value to setup configuration. |
| @@ -8347,7 +8347,7 @@ system and gives an overview of their function and contents. | |||
| 8347 | - mips | 8347 | - mips |
| 8348 | - mipsel | 8348 | - mipsel |
| 8349 | 8349 | ||
| 8350 | TUNE_ASARGS | 8350 | :term:`TUNE_ASARGS` |
| 8351 | Specifies architecture-specific assembler flags for the target | 8351 | Specifies architecture-specific assembler flags for the target |
| 8352 | system. The set of flags is based on the selected tune features. | 8352 | system. The set of flags is based on the selected tune features. |
| 8353 | ``TUNE_ASARGS`` is set using the tune include files, which are | 8353 | ``TUNE_ASARGS`` is set using the tune include files, which are |
| @@ -8365,7 +8365,7 @@ system and gives an overview of their function and contents. | |||
| 8365 | in turn, affects the tune variables themselves (i.e. the tune can | 8365 | in turn, affects the tune variables themselves (i.e. the tune can |
| 8366 | supply its own set of flags). | 8366 | supply its own set of flags). |
| 8367 | 8367 | ||
| 8368 | TUNE_CCARGS | 8368 | :term:`TUNE_CCARGS` |
| 8369 | Specifies architecture-specific C compiler flags for the target | 8369 | Specifies architecture-specific C compiler flags for the target |
| 8370 | system. The set of flags is based on the selected tune features. | 8370 | system. The set of flags is based on the selected tune features. |
| 8371 | ``TUNE_CCARGS`` is set using the tune include files, which are | 8371 | ``TUNE_CCARGS`` is set using the tune include files, which are |
| @@ -8378,7 +8378,7 @@ system and gives an overview of their function and contents. | |||
| 8378 | in turn, affects the tune variables themselves (i.e. the tune can | 8378 | in turn, affects the tune variables themselves (i.e. the tune can |
| 8379 | supply its own set of flags). | 8379 | supply its own set of flags). |
| 8380 | 8380 | ||
| 8381 | TUNE_FEATURES | 8381 | :term:`TUNE_FEATURES` |
| 8382 | Features used to "tune" a compiler for optimal use given a specific | 8382 | Features used to "tune" a compiler for optimal use given a specific |
| 8383 | processor. The features are defined within the tune files and allow | 8383 | processor. The features are defined within the tune files and allow |
| 8384 | arguments (i.e. ``TUNE_*ARGS``) to be dynamically generated based on | 8384 | arguments (i.e. ``TUNE_*ARGS``) to be dynamically generated based on |
| @@ -8395,7 +8395,7 @@ system and gives an overview of their function and contents. | |||
| 8395 | 8395 | ||
| 8396 | See the :term:`DEFAULTTUNE` variable for more information. | 8396 | See the :term:`DEFAULTTUNE` variable for more information. |
| 8397 | 8397 | ||
| 8398 | TUNE_LDARGS | 8398 | :term:`TUNE_LDARGS` |
| 8399 | Specifies architecture-specific linker flags for the target system. | 8399 | Specifies architecture-specific linker flags for the target system. |
| 8400 | The set of flags is based on the selected tune features. | 8400 | The set of flags is based on the selected tune features. |
| 8401 | ``TUNE_LDARGS`` is set using the tune include files, which are | 8401 | ``TUNE_LDARGS`` is set using the tune include files, which are |
| @@ -8413,7 +8413,7 @@ system and gives an overview of their function and contents. | |||
| 8413 | in turn, affects the tune variables themselves (i.e. the tune can | 8413 | in turn, affects the tune variables themselves (i.e. the tune can |
| 8414 | supply its own set of flags). | 8414 | supply its own set of flags). |
| 8415 | 8415 | ||
| 8416 | TUNE_PKGARCH | 8416 | :term:`TUNE_PKGARCH` |
| 8417 | The package architecture understood by the packaging system to define | 8417 | The package architecture understood by the packaging system to define |
| 8418 | the architecture, ABI, and tuning of output packages. The specific | 8418 | the architecture, ABI, and tuning of output packages. The specific |
| 8419 | tune is defined using the "_tune" override as follows: | 8419 | tune is defined using the "_tune" override as follows: |
| @@ -8428,7 +8428,7 @@ system and gives an overview of their function and contents. | |||
| 8428 | 8428 | ||
| 8429 | TUNE_PKGARCH_tune-core2-32 = "core2-32" | 8429 | TUNE_PKGARCH_tune-core2-32 = "core2-32" |
| 8430 | 8430 | ||
| 8431 | TUNEABI | 8431 | :term:`TUNEABI` |
| 8432 | An underlying Application Binary Interface (ABI) used by a particular | 8432 | An underlying Application Binary Interface (ABI) used by a particular |
| 8433 | tuning in a given toolchain layer. Providers that use prebuilt | 8433 | tuning in a given toolchain layer. Providers that use prebuilt |
| 8434 | libraries can use the ``TUNEABI``, | 8434 | libraries can use the ``TUNEABI``, |
| @@ -8440,7 +8440,7 @@ system and gives an overview of their function and contents. | |||
| 8440 | :ref:`sanity <ref-classes-sanity>` class to see how the variable is | 8440 | :ref:`sanity <ref-classes-sanity>` class to see how the variable is |
| 8441 | used. | 8441 | used. |
| 8442 | 8442 | ||
| 8443 | TUNEABI_OVERRIDE | 8443 | :term:`TUNEABI_OVERRIDE` |
| 8444 | If set, the OpenEmbedded system ignores the | 8444 | If set, the OpenEmbedded system ignores the |
| 8445 | :term:`TUNEABI_WHITELIST` variable. | 8445 | :term:`TUNEABI_WHITELIST` variable. |
| 8446 | Providers that use prebuilt libraries can use the | 8446 | Providers that use prebuilt libraries can use the |
| @@ -8451,7 +8451,7 @@ system and gives an overview of their function and contents. | |||
| 8451 | See the :ref:`sanity <ref-classes-sanity>` class to see how the | 8451 | See the :ref:`sanity <ref-classes-sanity>` class to see how the |
| 8452 | variable is used. | 8452 | variable is used. |
| 8453 | 8453 | ||
| 8454 | TUNEABI_WHITELIST | 8454 | :term:`TUNEABI_WHITELIST` |
| 8455 | A whitelist of permissible :term:`TUNEABI` values. If | 8455 | A whitelist of permissible :term:`TUNEABI` values. If |
| 8456 | ``TUNEABI_WHITELIST`` is not set, all tunes are allowed. Providers | 8456 | ``TUNEABI_WHITELIST`` is not set, all tunes are allowed. Providers |
| 8457 | that use prebuilt libraries can use the ``TUNEABI_WHITELIST``, | 8457 | that use prebuilt libraries can use the ``TUNEABI_WHITELIST``, |
| @@ -8462,7 +8462,7 @@ system and gives an overview of their function and contents. | |||
| 8462 | See the :ref:`sanity <ref-classes-sanity>` class to see how the | 8462 | See the :ref:`sanity <ref-classes-sanity>` class to see how the |
| 8463 | variable is used. | 8463 | variable is used. |
| 8464 | 8464 | ||
| 8465 | TUNECONFLICTS[feature] | 8465 | :term:`TUNECONFLICTS[feature]` |
| 8466 | Specifies CPU or Application Binary Interface (ABI) tuning features | 8466 | Specifies CPU or Application Binary Interface (ABI) tuning features |
| 8467 | that conflict with feature. | 8467 | that conflict with feature. |
| 8468 | 8468 | ||
| @@ -8475,7 +8475,7 @@ system and gives an overview of their function and contents. | |||
| 8475 | 8475 | ||
| 8476 | TUNECONFLICTS[n32] = "o32 n64" | 8476 | TUNECONFLICTS[n32] = "o32 n64" |
| 8477 | 8477 | ||
| 8478 | TUNEVALID[feature] | 8478 | :term:`TUNEVALID[feature]` |
| 8479 | Specifies a valid CPU or Application Binary Interface (ABI) tuning | 8479 | Specifies a valid CPU or Application Binary Interface (ABI) tuning |
| 8480 | feature. The specified feature is stored as a flag. Valid features | 8480 | feature. The specified feature is stored as a flag. Valid features |
| 8481 | are specified in the machine include files (e.g. | 8481 | are specified in the machine include files (e.g. |
| @@ -8488,7 +8488,7 @@ system and gives an overview of their function and contents. | |||
| 8488 | See the machine include files in the :term:`Source Directory` | 8488 | See the machine include files in the :term:`Source Directory` |
| 8489 | for these features. | 8489 | for these features. |
| 8490 | 8490 | ||
| 8491 | UBOOT_CONFIG | 8491 | :term:`UBOOT_CONFIG` |
| 8492 | Configures the :term:`UBOOT_MACHINE` and can | 8492 | Configures the :term:`UBOOT_MACHINE` and can |
| 8493 | also define :term:`IMAGE_FSTYPES` for individual | 8493 | also define :term:`IMAGE_FSTYPES` for individual |
| 8494 | cases. | 8494 | cases. |
| @@ -8510,30 +8510,30 @@ system and gives an overview of their function and contents. | |||
| 8510 | :ref:`uboot-config <ref-classes-uboot-config>` | 8510 | :ref:`uboot-config <ref-classes-uboot-config>` |
| 8511 | class. | 8511 | class. |
| 8512 | 8512 | ||
| 8513 | UBOOT_DTB_LOADADDRESS | 8513 | :term:`UBOOT_DTB_LOADADDRESS` |
| 8514 | Specifies the load address for the dtb image used by U-boot. During FIT | 8514 | Specifies the load address for the dtb image used by U-boot. During FIT |
| 8515 | image creation, the ``UBOOT_DTB_LOADADDRESS`` variable is used in | 8515 | image creation, the ``UBOOT_DTB_LOADADDRESS`` variable is used in |
| 8516 | :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify | 8516 | :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify |
| 8517 | the load address to be used in | 8517 | the load address to be used in |
| 8518 | creating the dtb sections of Image Tree Source for the FIT image. | 8518 | creating the dtb sections of Image Tree Source for the FIT image. |
| 8519 | 8519 | ||
| 8520 | UBOOT_DTBO_LOADADDRESS | 8520 | :term:`UBOOT_DTBO_LOADADDRESS` |
| 8521 | Specifies the load address for the dtbo image used by U-boot. During FIT | 8521 | Specifies the load address for the dtbo image used by U-boot. During FIT |
| 8522 | image creation, the ``UBOOT_DTBO_LOADADDRESS`` variable is used in | 8522 | image creation, the ``UBOOT_DTBO_LOADADDRESS`` variable is used in |
| 8523 | :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the load address to be used in | 8523 | :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to specify the load address to be used in |
| 8524 | creating the dtbo sections of Image Tree Source for the FIT image. | 8524 | creating the dtbo sections of Image Tree Source for the FIT image. |
| 8525 | 8525 | ||
| 8526 | UBOOT_ENTRYPOINT | 8526 | :term:`UBOOT_ENTRYPOINT` |
| 8527 | Specifies the entry point for the U-Boot image. During U-Boot image | 8527 | Specifies the entry point for the U-Boot image. During U-Boot image |
| 8528 | creation, the ``UBOOT_ENTRYPOINT`` variable is passed as a | 8528 | creation, the ``UBOOT_ENTRYPOINT`` variable is passed as a |
| 8529 | command-line parameter to the ``uboot-mkimage`` utility. | 8529 | command-line parameter to the ``uboot-mkimage`` utility. |
| 8530 | 8530 | ||
| 8531 | UBOOT_LOADADDRESS | 8531 | :term:`UBOOT_LOADADDRESS` |
| 8532 | Specifies the load address for the U-Boot image. During U-Boot image | 8532 | Specifies the load address for the U-Boot image. During U-Boot image |
| 8533 | creation, the ``UBOOT_LOADADDRESS`` variable is passed as a | 8533 | creation, the ``UBOOT_LOADADDRESS`` variable is passed as a |
| 8534 | command-line parameter to the ``uboot-mkimage`` utility. | 8534 | command-line parameter to the ``uboot-mkimage`` utility. |
| 8535 | 8535 | ||
| 8536 | UBOOT_LOCALVERSION | 8536 | :term:`UBOOT_LOCALVERSION` |
| 8537 | Appends a string to the name of the local version of the U-Boot | 8537 | Appends a string to the name of the local version of the U-Boot |
| 8538 | image. For example, assuming the version of the U-Boot image built | 8538 | image. For example, assuming the version of the U-Boot image built |
| 8539 | was "2013.10", the full version string reported by U-Boot would be | 8539 | was "2013.10", the full version string reported by U-Boot would be |
| @@ -8542,7 +8542,7 @@ system and gives an overview of their function and contents. | |||
| 8542 | 8542 | ||
| 8543 | UBOOT_LOCALVERSION = "-yocto" | 8543 | UBOOT_LOCALVERSION = "-yocto" |
| 8544 | 8544 | ||
| 8545 | UBOOT_MACHINE | 8545 | :term:`UBOOT_MACHINE` |
| 8546 | Specifies the value passed on the ``make`` command line when building | 8546 | Specifies the value passed on the ``make`` command line when building |
| 8547 | a U-Boot image. The value indicates the target platform | 8547 | a U-Boot image. The value indicates the target platform |
| 8548 | configuration. You typically set this variable from the machine | 8548 | configuration. You typically set this variable from the machine |
| @@ -8551,15 +8551,15 @@ system and gives an overview of their function and contents. | |||
| 8551 | Please see the "Selection of Processor Architecture and Board Type" | 8551 | Please see the "Selection of Processor Architecture and Board Type" |
| 8552 | section in the U-Boot README for valid values for this variable. | 8552 | section in the U-Boot README for valid values for this variable. |
| 8553 | 8553 | ||
| 8554 | UBOOT_MAKE_TARGET | 8554 | :term:`UBOOT_MAKE_TARGET` |
| 8555 | Specifies the target called in the ``Makefile``. The default target | 8555 | Specifies the target called in the ``Makefile``. The default target |
| 8556 | is "all". | 8556 | is "all". |
| 8557 | 8557 | ||
| 8558 | UBOOT_MKIMAGE_DTCOPTS | 8558 | :term:`UBOOT_MKIMAGE_DTCOPTS` |
| 8559 | Options for the device tree compiler passed to mkimage '-D' | 8559 | Options for the device tree compiler passed to mkimage '-D' |
| 8560 | feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. | 8560 | feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. |
| 8561 | 8561 | ||
| 8562 | UBOOT_RD_ENTRYPOINT | 8562 | :term:`UBOOT_RD_ENTRYPOINT` |
| 8563 | Specifies the entrypoint for the RAM disk image. | 8563 | Specifies the entrypoint for the RAM disk image. |
| 8564 | During FIT image creation, the | 8564 | During FIT image creation, the |
| 8565 | ``UBOOT_RD_ENTRYPOINT`` variable is used | 8565 | ``UBOOT_RD_ENTRYPOINT`` variable is used |
| @@ -8567,7 +8567,7 @@ system and gives an overview of their function and contents. | |||
| 8567 | entrypoint to be used in creating the Image Tree Source for | 8567 | entrypoint to be used in creating the Image Tree Source for |
| 8568 | the FIT image. | 8568 | the FIT image. |
| 8569 | 8569 | ||
| 8570 | UBOOT_RD_LOADADDRESS | 8570 | :term:`UBOOT_RD_LOADADDRESS` |
| 8571 | Specifies the load address for the RAM disk image. | 8571 | Specifies the load address for the RAM disk image. |
| 8572 | During FIT image creation, the | 8572 | During FIT image creation, the |
| 8573 | ``UBOOT_RD_LOADADDRESS`` variable is used | 8573 | ``UBOOT_RD_LOADADDRESS`` variable is used |
| @@ -8575,33 +8575,33 @@ system and gives an overview of their function and contents. | |||
| 8575 | load address to be used in creating the Image Tree Source for | 8575 | load address to be used in creating the Image Tree Source for |
| 8576 | the FIT image. | 8576 | the FIT image. |
| 8577 | 8577 | ||
| 8578 | UBOOT_SIGN_ENABLE | 8578 | :term:`UBOOT_SIGN_ENABLE` |
| 8579 | Enable signing of FIT image. The default value is "0". | 8579 | Enable signing of FIT image. The default value is "0". |
| 8580 | 8580 | ||
| 8581 | UBOOT_SIGN_KEYDIR | 8581 | :term:`UBOOT_SIGN_KEYDIR` |
| 8582 | Location of the directory containing the RSA key and | 8582 | Location of the directory containing the RSA key and |
| 8583 | certificate used for signing FIT image. | 8583 | certificate used for signing FIT image. |
| 8584 | 8584 | ||
| 8585 | UBOOT_SIGN_KEYNAME | 8585 | :term:`UBOOT_SIGN_KEYNAME` |
| 8586 | The name of keys used for signing U-boot FIT image stored in | 8586 | The name of keys used for signing U-boot FIT image stored in |
| 8587 | :term:`UBOOT_SIGN_KEYDIR` directory. For e.g. dev.key key and dev.crt | 8587 | :term:`UBOOT_SIGN_KEYDIR` directory. For e.g. dev.key key and dev.crt |
| 8588 | certificate stored in :term:`UBOOT_SIGN_KEYDIR` directory will have | 8588 | certificate stored in :term:`UBOOT_SIGN_KEYDIR` directory will have |
| 8589 | :term:`UBOOT_SIGN_KEYNAME` set to "dev". | 8589 | :term:`UBOOT_SIGN_KEYNAME` set to "dev". |
| 8590 | 8590 | ||
| 8591 | UBOOT_SUFFIX | 8591 | :term:`UBOOT_SUFFIX` |
| 8592 | Points to the generated U-Boot extension. For example, ``u-boot.sb`` | 8592 | Points to the generated U-Boot extension. For example, ``u-boot.sb`` |
| 8593 | has a ``.sb`` extension. | 8593 | has a ``.sb`` extension. |
| 8594 | 8594 | ||
| 8595 | The default U-Boot extension is ``.bin`` | 8595 | The default U-Boot extension is ``.bin`` |
| 8596 | 8596 | ||
| 8597 | UBOOT_TARGET | 8597 | :term:`UBOOT_TARGET` |
| 8598 | Specifies the target used for building U-Boot. The target is passed | 8598 | Specifies the target used for building U-Boot. The target is passed |
| 8599 | directly as part of the "make" command (e.g. SPL and AIS). If you do | 8599 | directly as part of the "make" command (e.g. SPL and AIS). If you do |
| 8600 | not specifically set this variable, the OpenEmbedded build process | 8600 | not specifically set this variable, the OpenEmbedded build process |
| 8601 | passes and uses "all" for the target during the U-Boot building | 8601 | passes and uses "all" for the target during the U-Boot building |
| 8602 | process. | 8602 | process. |
| 8603 | 8603 | ||
| 8604 | UNKNOWN_CONFIGURE_WHITELIST | 8604 | :term:`UNKNOWN_CONFIGURE_WHITELIST` |
| 8605 | Specifies a list of options that, if reported by the configure script | 8605 | Specifies a list of options that, if reported by the configure script |
| 8606 | as being invalid, should not generate a warning during the | 8606 | as being invalid, should not generate a warning during the |
| 8607 | :ref:`ref-tasks-configure` task. Normally, invalid | 8607 | :ref:`ref-tasks-configure` task. Normally, invalid |
| @@ -8619,7 +8619,7 @@ system and gives an overview of their function and contents. | |||
| 8619 | :ref:`insane <ref-classes-insane>` class and is only enabled if the | 8619 | :ref:`insane <ref-classes-insane>` class and is only enabled if the |
| 8620 | recipe inherits the :ref:`autotools <ref-classes-autotools>` class. | 8620 | recipe inherits the :ref:`autotools <ref-classes-autotools>` class. |
| 8621 | 8621 | ||
| 8622 | UPDATERCPN | 8622 | :term:`UPDATERCPN` |
| 8623 | For recipes inheriting the | 8623 | For recipes inheriting the |
| 8624 | :ref:`update-rc.d <ref-classes-update-rc.d>` class, ``UPDATERCPN`` | 8624 | :ref:`update-rc.d <ref-classes-update-rc.d>` class, ``UPDATERCPN`` |
| 8625 | specifies the package that contains the initscript that is enabled. | 8625 | specifies the package that contains the initscript that is enabled. |
| @@ -8628,7 +8628,7 @@ system and gives an overview of their function and contents. | |||
| 8628 | install initscripts package them in the main package for the recipe, | 8628 | install initscripts package them in the main package for the recipe, |
| 8629 | you rarely need to set this variable in individual recipes. | 8629 | you rarely need to set this variable in individual recipes. |
| 8630 | 8630 | ||
| 8631 | UPSTREAM_CHECK_GITTAGREGEX | 8631 | :term:`UPSTREAM_CHECK_GITTAGREGEX` |
| 8632 | You can perform a per-recipe check for what the latest upstream | 8632 | You can perform a per-recipe check for what the latest upstream |
| 8633 | source code version is by calling ``bitbake -c checkpkg`` recipe. If | 8633 | source code version is by calling ``bitbake -c checkpkg`` recipe. If |
| 8634 | the recipe source code is provided from Git repositories, the | 8634 | the recipe source code is provided from Git repositories, the |
| @@ -8642,7 +8642,7 @@ system and gives an overview of their function and contents. | |||
| 8642 | 8642 | ||
| 8643 | UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex" | 8643 | UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex" |
| 8644 | 8644 | ||
| 8645 | UPSTREAM_CHECK_REGEX | 8645 | :term:`UPSTREAM_CHECK_REGEX` |
| 8646 | Use the ``UPSTREAM_CHECK_REGEX`` variable to specify a different | 8646 | Use the ``UPSTREAM_CHECK_REGEX`` variable to specify a different |
| 8647 | regular expression instead of the default one when the package | 8647 | regular expression instead of the default one when the package |
| 8648 | checking system is parsing the page found using | 8648 | checking system is parsing the page found using |
| @@ -8651,7 +8651,7 @@ system and gives an overview of their function and contents. | |||
| 8651 | 8651 | ||
| 8652 | UPSTREAM_CHECK_REGEX = "package_regex" | 8652 | UPSTREAM_CHECK_REGEX = "package_regex" |
| 8653 | 8653 | ||
| 8654 | UPSTREAM_CHECK_URI | 8654 | :term:`UPSTREAM_CHECK_URI` |
| 8655 | You can perform a per-recipe check for what the latest upstream | 8655 | You can perform a per-recipe check for what the latest upstream |
| 8656 | source code version is by calling ``bitbake -c checkpkg`` recipe. If | 8656 | source code version is by calling ``bitbake -c checkpkg`` recipe. If |
| 8657 | the source code is provided from tarballs, the latest version is | 8657 | the source code is provided from tarballs, the latest version is |
| @@ -8663,7 +8663,7 @@ system and gives an overview of their function and contents. | |||
| 8663 | 8663 | ||
| 8664 | UPSTREAM_CHECK_URI = "recipe_url" | 8664 | UPSTREAM_CHECK_URI = "recipe_url" |
| 8665 | 8665 | ||
| 8666 | USE_DEVFS | 8666 | :term:`USE_DEVFS` |
| 8667 | Determines if ``devtmpfs`` is used for ``/dev`` population. The | 8667 | Determines if ``devtmpfs`` is used for ``/dev`` population. The |
| 8668 | default value used for ``USE_DEVFS`` is "1" when no value is | 8668 | default value used for ``USE_DEVFS`` is "1" when no value is |
| 8669 | specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a | 8669 | specifically set. Typically, you would set ``USE_DEVFS`` to "0" for a |
| @@ -8673,7 +8673,7 @@ system and gives an overview of their function and contents. | |||
| 8673 | the Yocto Project Development Tasks Manual for information on how to | 8673 | the Yocto Project Development Tasks Manual for information on how to |
| 8674 | use this variable. | 8674 | use this variable. |
| 8675 | 8675 | ||
| 8676 | USE_VT | 8676 | :term:`USE_VT` |
| 8677 | When using | 8677 | When using |
| 8678 | :ref:`SysVinit <new-recipe-enabling-system-services>`, | 8678 | :ref:`SysVinit <new-recipe-enabling-system-services>`, |
| 8679 | determines whether or not to run a | 8679 | determines whether or not to run a |
| @@ -8687,7 +8687,7 @@ system and gives an overview of their function and contents. | |||
| 8687 | display attached and therefore do not need virtual terminal | 8687 | display attached and therefore do not need virtual terminal |
| 8688 | functionality. | 8688 | functionality. |
| 8689 | 8689 | ||
| 8690 | USER_CLASSES | 8690 | :term:`USER_CLASSES` |
| 8691 | A list of classes to globally inherit. These classes are used by the | 8691 | A list of classes to globally inherit. These classes are used by the |
| 8692 | OpenEmbedded build system to enable extra features (e.g. | 8692 | OpenEmbedded build system to enable extra features (e.g. |
| 8693 | ``buildstats``, ``image-mklibs``, and so forth). | 8693 | ``buildstats``, ``image-mklibs``, and so forth). |
| @@ -8700,7 +8700,7 @@ system and gives an overview of their function and contents. | |||
| 8700 | For more information, see | 8700 | For more information, see |
| 8701 | ``meta-poky/conf/local.conf.sample`` in the :term:`Source Directory`. | 8701 | ``meta-poky/conf/local.conf.sample`` in the :term:`Source Directory`. |
| 8702 | 8702 | ||
| 8703 | USERADD_ERROR_DYNAMIC | 8703 | :term:`USERADD_ERROR_DYNAMIC` |
| 8704 | If set to ``error``, forces the OpenEmbedded build system to produce | 8704 | If set to ``error``, forces the OpenEmbedded build system to produce |
| 8705 | an error if the user identification (``uid``) and group | 8705 | an error if the user identification (``uid``) and group |
| 8706 | identification (``gid``) values are not defined in any of the files | 8706 | identification (``gid``) values are not defined in any of the files |
| @@ -8745,7 +8745,7 @@ system and gives an overview of their function and contents. | |||
| 8745 | This saves you from having to add static IDs for recipes that you | 8745 | This saves you from having to add static IDs for recipes that you |
| 8746 | know will never be built. | 8746 | know will never be built. |
| 8747 | 8747 | ||
| 8748 | USERADD_GID_TABLES | 8748 | :term:`USERADD_GID_TABLES` |
| 8749 | Specifies a password file to use for obtaining static group | 8749 | Specifies a password file to use for obtaining static group |
| 8750 | identification (``gid``) values when the OpenEmbedded build system | 8750 | identification (``gid``) values when the OpenEmbedded build system |
| 8751 | adds a group to the system during package installation. | 8751 | adds a group to the system during package installation. |
| @@ -8768,7 +8768,7 @@ system and gives an overview of their function and contents. | |||
| 8768 | gid | 8768 | gid |
| 8769 | values. | 8769 | values. |
| 8770 | 8770 | ||
| 8771 | USERADD_PACKAGES | 8771 | :term:`USERADD_PACKAGES` |
| 8772 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, | 8772 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, |
| 8773 | this variable specifies the individual packages within the recipe | 8773 | this variable specifies the individual packages within the recipe |
| 8774 | that require users and/or groups to be added. | 8774 | that require users and/or groups to be added. |
| @@ -8792,7 +8792,7 @@ system and gives an overview of their function and contents. | |||
| 8792 | GROUPMEMS_PARAM | 8792 | GROUPMEMS_PARAM |
| 8793 | variables. | 8793 | variables. |
| 8794 | 8794 | ||
| 8795 | USERADD_PARAM | 8795 | :term:`USERADD_PARAM` |
| 8796 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, | 8796 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, |
| 8797 | this variable specifies for a package what parameters should pass to | 8797 | this variable specifies for a package what parameters should pass to |
| 8798 | the ``useradd`` command if you add a user to the system when the | 8798 | the ``useradd`` command if you add a user to the system when the |
| @@ -8809,7 +8809,7 @@ system and gives an overview of their function and contents. | |||
| 8809 | standard Linux shell command ``useradd``, see | 8809 | standard Linux shell command ``useradd``, see |
| 8810 | http://linux.die.net/man/8/useradd. | 8810 | http://linux.die.net/man/8/useradd. |
| 8811 | 8811 | ||
| 8812 | USERADD_UID_TABLES | 8812 | :term:`USERADD_UID_TABLES` |
| 8813 | Specifies a password file to use for obtaining static user | 8813 | Specifies a password file to use for obtaining static user |
| 8814 | identification (``uid``) values when the OpenEmbedded build system | 8814 | identification (``uid``) values when the OpenEmbedded build system |
| 8815 | adds a user to the system during package installation. | 8815 | adds a user to the system during package installation. |
| @@ -8831,7 +8831,7 @@ system and gives an overview of their function and contents. | |||
| 8831 | uid | 8831 | uid |
| 8832 | values. | 8832 | values. |
| 8833 | 8833 | ||
| 8834 | USERADDEXTENSION | 8834 | :term:`USERADDEXTENSION` |
| 8835 | When set to "useradd-staticids", causes the OpenEmbedded build system | 8835 | When set to "useradd-staticids", causes the OpenEmbedded build system |
| 8836 | to base all user and group additions on a static ``passwd`` and | 8836 | to base all user and group additions on a static ``passwd`` and |
| 8837 | ``group`` files found in :term:`BBPATH`. | 8837 | ``group`` files found in :term:`BBPATH`. |
| @@ -8857,7 +8857,7 @@ system and gives an overview of their function and contents. | |||
| 8857 | Additionally, you should also set the | 8857 | Additionally, you should also set the |
| 8858 | :term:`USERADD_ERROR_DYNAMIC` variable. | 8858 | :term:`USERADD_ERROR_DYNAMIC` variable. |
| 8859 | 8859 | ||
| 8860 | VOLATILE_LOG_DIR | 8860 | :term:`VOLATILE_LOG_DIR` |
| 8861 | Specifies the persistence of the target's ``/var/log`` directory, | 8861 | Specifies the persistence of the target's ``/var/log`` directory, |
| 8862 | which is used to house postinstall target log files. | 8862 | which is used to house postinstall target log files. |
| 8863 | 8863 | ||
| @@ -8865,14 +8865,14 @@ system and gives an overview of their function and contents. | |||
| 8865 | file is not persistent. You can override this setting by setting the | 8865 | file is not persistent. You can override this setting by setting the |
| 8866 | variable to "no" to make the log directory persistent. | 8866 | variable to "no" to make the log directory persistent. |
| 8867 | 8867 | ||
| 8868 | WARN_QA | 8868 | :term:`WARN_QA` |
| 8869 | Specifies the quality assurance checks whose failures are reported as | 8869 | Specifies the quality assurance checks whose failures are reported as |
| 8870 | warnings by the OpenEmbedded build system. You set this variable in | 8870 | warnings by the OpenEmbedded build system. You set this variable in |
| 8871 | your distribution configuration file. For a list of the checks you | 8871 | your distribution configuration file. For a list of the checks you |
| 8872 | can control with this variable, see the | 8872 | can control with this variable, see the |
| 8873 | ":ref:`insane.bbclass <ref-classes-insane>`" section. | 8873 | ":ref:`insane.bbclass <ref-classes-insane>`" section. |
| 8874 | 8874 | ||
| 8875 | WKS_FILE | 8875 | :term:`WKS_FILE` |
| 8876 | Specifies the location of the Wic kickstart file that is used by the | 8876 | Specifies the location of the Wic kickstart file that is used by the |
| 8877 | OpenEmbedded build system to create a partitioned image | 8877 | OpenEmbedded build system to create a partitioned image |
| 8878 | (image\ ``.wic``). For information on how to create a partitioned | 8878 | (image\ ``.wic``). For information on how to create a partitioned |
| @@ -8881,7 +8881,7 @@ system and gives an overview of their function and contents. | |||
| 8881 | section in the Yocto Project Development Tasks Manual. For details on | 8881 | section in the Yocto Project Development Tasks Manual. For details on |
| 8882 | the kickstart file format, see the ":doc:`../ref-manual/ref-kickstart`" Chapter. | 8882 | the kickstart file format, see the ":doc:`../ref-manual/ref-kickstart`" Chapter. |
| 8883 | 8883 | ||
| 8884 | WKS_FILE_DEPENDS | 8884 | :term:`WKS_FILE_DEPENDS` |
| 8885 | When placed in the recipe that builds your image, this variable lists | 8885 | When placed in the recipe that builds your image, this variable lists |
| 8886 | build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only | 8886 | build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only |
| 8887 | applicable when Wic images are active (i.e. when | 8887 | applicable when Wic images are active (i.e. when |
| @@ -8906,7 +8906,7 @@ system and gives an overview of their function and contents. | |||
| 8906 | previous example, some-native-tool would be replaced with an actual | 8906 | previous example, some-native-tool would be replaced with an actual |
| 8907 | native tool on which the build would depend. | 8907 | native tool on which the build would depend. |
| 8908 | 8908 | ||
| 8909 | WORKDIR | 8909 | :term:`WORKDIR` |
| 8910 | The pathname of the work directory in which the OpenEmbedded build | 8910 | The pathname of the work directory in which the OpenEmbedded build |
| 8911 | system builds a recipe. This directory is located within the | 8911 | system builds a recipe. This directory is located within the |
| 8912 | :term:`TMPDIR` directory structure and is specific to | 8912 | :term:`TMPDIR` directory structure and is specific to |
| @@ -8946,7 +8946,7 @@ system and gives an overview of their function and contents. | |||
| 8946 | 8946 | ||
| 8947 | poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 | 8947 | poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 |
| 8948 | 8948 | ||
| 8949 | XSERVER | 8949 | :term:`XSERVER` |
| 8950 | Specifies the packages that should be installed to provide an X | 8950 | Specifies the packages that should be installed to provide an X |
| 8951 | server and drivers for the current machine, assuming your image | 8951 | server and drivers for the current machine, assuming your image |
| 8952 | directly includes ``packagegroup-core-x11-xserver`` or, perhaps | 8952 | directly includes ``packagegroup-core-x11-xserver`` or, perhaps |
