diff options
Diffstat (limited to 'documentation/ref-manual/ref-variables.rst')
-rw-r--r-- | documentation/ref-manual/ref-variables.rst | 1336 |
1 files changed, 668 insertions, 668 deletions
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst index b84640c6a7..3eae836fd6 100644 --- a/documentation/ref-manual/ref-variables.rst +++ b/documentation/ref-manual/ref-variables.rst | |||
@@ -7,12 +7,12 @@ Variables Glossary | |||
7 | This chapter lists common variables used in the OpenEmbedded build | 7 | This chapter lists common variables used in the OpenEmbedded build |
8 | system and gives an overview of their function and contents. | 8 | system and gives an overview of their function and contents. |
9 | 9 | ||
10 | `A <#var-ABIEXTENSION>`__ `B <#var-B>`__ `C <#var-CACHE>`__ | 10 | `A <#var-ABIEXTENSION>`__ :term:`B` `C <#var-CACHE>`__ |
11 | `D <#var-D>`__ `E <#var-EFI_PROVIDER>`__ `F <#var-FEATURE_PACKAGES>`__ | 11 | :term:`D` `E <#var-EFI_PROVIDER>`__ `F <#var-FEATURE_PACKAGES>`__ |
12 | `G <#var-GCCPIE>`__ `H <#var-HOMEPAGE>`__ `I <#var-ICECC_DISABLED>`__ | 12 | `G <#var-GCCPIE>`__ `H <#var-HOMEPAGE>`__ `I <#var-ICECC_DISABLED>`__ |
13 | `K <#var-KARCH>`__ `L <#var-LABELS>`__ `M <#var-MACHINE>`__ | 13 | `K <#var-KARCH>`__ `L <#var-LABELS>`__ `M <#var-MACHINE>`__ |
14 | `N <#var-NATIVELSBSTRING>`__ `O <#var-OBJCOPY>`__ `P <#var-P>`__ | 14 | `N <#var-NATIVELSBSTRING>`__ `O <#var-OBJCOPY>`__ :term:`P` |
15 | `R <#var-RANLIB>`__ `S <#var-S>`__ `T <#var-T>`__ | 15 | `R <#var-RANLIB>`__ :term:`S` :term:`T` |
16 | `U <#var-UBOOT_CONFIG>`__ `V <#var-VOLATILE_LOG_DIR>`__ | 16 | `U <#var-UBOOT_CONFIG>`__ `V <#var-VOLATILE_LOG_DIR>`__ |
17 | `W <#var-WARN_QA>`__ `X <#var-XSERVER>`__ | 17 | `W <#var-WARN_QA>`__ `X <#var-XSERVER>`__ |
18 | 18 | ||
@@ -30,7 +30,7 @@ system and gives an overview of their function and contents. | |||
30 | Specifies whether to produce an output package even if it is empty. | 30 | Specifies whether to produce an output package even if it is empty. |
31 | By default, BitBake does not produce empty packages. This default | 31 | By default, BitBake does not produce empty packages. This default |
32 | behavior can cause issues when there is an | 32 | behavior can cause issues when there is an |
33 | ```RDEPENDS`` <#var-RDEPENDS>`__ or some other hard runtime | 33 | :term:`RDEPENDS` or some other hard runtime |
34 | requirement on the existence of the package. | 34 | requirement on the existence of the package. |
35 | 35 | ||
36 | Like all package-controlling variables, you must always use them in | 36 | Like all package-controlling variables, you must always use them in |
@@ -49,7 +49,7 @@ system and gives an overview of their function and contents. | |||
49 | has four commands that also exist as part of another package, you | 49 | has four commands that also exist as part of another package, you |
50 | identify them as follows: ALTERNATIVE_busybox = "sh sed test bracket" | 50 | identify them as follows: ALTERNATIVE_busybox = "sh sed test bracket" |
51 | For more information on the alternatives system, see the | 51 | For more information on the alternatives system, see the |
52 | "```update-alternatives.bbclass`` <#ref-classes-update-alternatives>`__" | 52 | ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" |
53 | section. | 53 | section. |
54 | 54 | ||
55 | ALTERNATIVE_LINK_NAME | 55 | ALTERNATIVE_LINK_NAME |
@@ -72,7 +72,7 @@ system and gives an overview of their function and contents. | |||
72 | . | 72 | . |
73 | 73 | ||
74 | For more information on the alternatives system, see the | 74 | For more information on the alternatives system, see the |
75 | "```update-alternatives.bbclass`` <#ref-classes-update-alternatives>`__" | 75 | ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" |
76 | section. | 76 | section. |
77 | 77 | ||
78 | ALTERNATIVE_PRIORITY | 78 | ALTERNATIVE_PRIORITY |
@@ -86,7 +86,7 @@ system and gives an overview of their function and contents. | |||
86 | ALTERNATIVE_PRIORITY_pkg[name] = "priority" | 86 | ALTERNATIVE_PRIORITY_pkg[name] = "priority" |
87 | 87 | ||
88 | For more information on the alternatives system, see the | 88 | For more information on the alternatives system, see the |
89 | "```update-alternatives.bbclass`` <#ref-classes-update-alternatives>`__" | 89 | ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" |
90 | section. | 90 | section. |
91 | 91 | ||
92 | ALTERNATIVE_TARGET | 92 | ALTERNATIVE_TARGET |
@@ -103,7 +103,7 @@ system and gives an overview of their function and contents. | |||
103 | 103 | ||
104 | If ``ALTERNATIVE_TARGET`` is not defined, it inherits the value | 104 | If ``ALTERNATIVE_TARGET`` is not defined, it inherits the value |
105 | from the | 105 | from the |
106 | ```ALTERNATIVE_LINK_NAME`` <#var-ALTERNATIVE_LINK_NAME>`__ | 106 | :term:`ALTERNATIVE_LINK_NAME` |
107 | variable. | 107 | variable. |
108 | 108 | ||
109 | If ``ALTERNATIVE_LINK_NAME`` and ``ALTERNATIVE_TARGET`` are the | 109 | If ``ALTERNATIVE_LINK_NAME`` and ``ALTERNATIVE_TARGET`` are the |
@@ -112,25 +112,25 @@ system and gives an overview of their function and contents. | |||
112 | 112 | ||
113 | Finally, if the file referenced has not been renamed, the | 113 | Finally, if the file referenced has not been renamed, the |
114 | alternatives system will rename it to avoid the need to rename | 114 | alternatives system will rename it to avoid the need to rename |
115 | alternative files in the ```do_install`` <#ref-tasks-install>`__ | 115 | alternative files in the :ref:`ref-tasks-install` |
116 | task while retaining support for the command if necessary. | 116 | task while retaining support for the command if necessary. |
117 | 117 | ||
118 | For more information on the alternatives system, see the | 118 | For more information on the alternatives system, see the |
119 | "```update-alternatives.bbclass`` <#ref-classes-update-alternatives>`__" | 119 | ":ref:`update-alternatives.bbclass <ref-classes-update-alternatives>`" |
120 | section. | 120 | section. |
121 | 121 | ||
122 | APPEND | 122 | APPEND |
123 | An override list of append strings for each target specified with | 123 | An override list of append strings for each target specified with |
124 | ```LABELS`` <#var-LABELS>`__. | 124 | :term:`LABELS`. |
125 | 125 | ||
126 | See the ```grub-efi`` <#ref-classes-grub-efi>`__ class for more | 126 | See the :ref:`grub-efi <ref-classes-grub-efi>` class for more |
127 | information on how this variable is used. | 127 | information on how this variable is used. |
128 | 128 | ||
129 | AR | 129 | AR |
130 | The minimal command and arguments used to run ``ar``. | 130 | The minimal command and arguments used to run ``ar``. |
131 | 131 | ||
132 | ARCHIVER_MODE | 132 | ARCHIVER_MODE |
133 | When used with the ```archiver`` <#ref-classes-archiver>`__ class, | 133 | When used with the :ref:`archiver <ref-classes-archiver>` class, |
134 | determines the type of information used to create a released archive. | 134 | determines the type of information used to create a released archive. |
135 | You can use this variable to create archives of patched source, | 135 | You can use this variable to create archives of patched source, |
136 | original source, configured source, and so forth by employing the | 136 | original source, configured source, and so forth by employing the |
@@ -151,7 +151,7 @@ system and gives an overview of their function and contents. | |||
151 | Minimal command and arguments needed to run the assembler. | 151 | Minimal command and arguments needed to run the assembler. |
152 | 152 | ||
153 | ASSUME_PROVIDED | 153 | ASSUME_PROVIDED |
154 | Lists recipe names (```PN`` <#var-PN>`__ values) BitBake does not | 154 | Lists recipe names (:term:`PN` values) BitBake does not |
155 | attempt to build. Instead, BitBake assumes these recipes have already | 155 | attempt to build. Instead, BitBake assumes these recipes have already |
156 | been built. | 156 | been built. |
157 | 157 | ||
@@ -178,7 +178,7 @@ system and gives an overview of their function and contents. | |||
178 | order to send patches and forward bugs. | 178 | order to send patches and forward bugs. |
179 | 179 | ||
180 | AUTO_LIBNAME_PKGS | 180 | AUTO_LIBNAME_PKGS |
181 | When the ```debian`` <#ref-classes-debian>`__ class is inherited, | 181 | When the :ref:`debian <ref-classes-debian>` class is inherited, |
182 | which is the default behavior, ``AUTO_LIBNAME_PKGS`` specifies which | 182 | which is the default behavior, ``AUTO_LIBNAME_PKGS`` specifies which |
183 | packages should be checked for libraries and renamed according to | 183 | packages should be checked for libraries and renamed according to |
184 | Debian library package naming. | 184 | Debian library package naming. |
@@ -189,7 +189,7 @@ system and gives an overview of their function and contents. | |||
189 | AUTO_SYSLINUXMENU | 189 | AUTO_SYSLINUXMENU |
190 | Enables creating an automatic menu for the syslinux bootloader. You | 190 | Enables creating an automatic menu for the syslinux bootloader. You |
191 | must set this variable in your recipe. The | 191 | must set this variable in your recipe. The |
192 | ```syslinux`` <#ref-classes-syslinux>`__ class checks this variable. | 192 | :ref:`syslinux <ref-classes-syslinux>` class checks this variable. |
193 | 193 | ||
194 | AUTOREV | 194 | AUTOREV |
195 | When ``SRCREV`` is set to the value of this variable, it specifies to | 195 | When ``SRCREV`` is set to the value of this variable, it specifies to |
@@ -197,10 +197,10 @@ system and gives an overview of their function and contents. | |||
197 | SRCREV = "${AUTOREV}" | 197 | SRCREV = "${AUTOREV}" |
198 | 198 | ||
199 | If you use the previous statement to retrieve the latest version of | 199 | If you use the previous statement to retrieve the latest version of |
200 | software, you need to be sure ```PV`` <#var-PV>`__ contains | 200 | software, you need to be sure :term:`PV` contains |
201 | ``${``\ ```SRCPV`` <#var-SRCPV>`__\ ``}``. For example, suppose you | 201 | ``${``\ :term:`SRCPV`\ ``}``. For example, suppose you |
202 | have a kernel recipe that inherits the | 202 | have a kernel recipe that inherits the |
203 | `kernel <#ref-classes-kernel>`__ class and you use the previous | 203 | :ref:`kernel <ref-classes-kernel>` class and you use the previous |
204 | statement. In this example, ``${SRCPV}`` does not automatically get | 204 | statement. In this example, ``${SRCPV}`` does not automatically get |
205 | into ``PV``. Consequently, you need to change ``PV`` in your recipe | 205 | into ``PV``. Consequently, you need to change ``PV`` in your recipe |
206 | so that it does contain ``${SRCPV}``. | 206 | so that it does contain ``${SRCPV}``. |
@@ -212,8 +212,8 @@ system and gives an overview of their function and contents. | |||
212 | 212 | ||
213 | AVAILABLE_LICENSES | 213 | AVAILABLE_LICENSES |
214 | List of licenses found in the directories specified by | 214 | List of licenses found in the directories specified by |
215 | ```COMMON_LICENSE_DIR`` <#var-COMMON_LICENSE_DIR>`__ and | 215 | :term:`COMMON_LICENSE_DIR` and |
216 | ```LICENSE_PATH`` <#var-LICENSE_PATH>`__. | 216 | :term:`LICENSE_PATH`. |
217 | 217 | ||
218 | .. note:: | 218 | .. note:: |
219 | 219 | ||
@@ -245,10 +245,10 @@ system and gives an overview of their function and contents. | |||
245 | User Manual for more information. | 245 | User Manual for more information. |
246 | 246 | ||
247 | B | 247 | B |
248 | The directory within the `Build Directory <#build-directory>`__ in | 248 | The directory within the :term:`Build Directory` in |
249 | which the OpenEmbedded build system places generated objects during a | 249 | which the OpenEmbedded build system places generated objects during a |
250 | recipe's build process. By default, this directory is the same as the | 250 | recipe's build process. By default, this directory is the same as the |
251 | ```S`` <#var-S>`__ directory, which is defined as: S = | 251 | :term:`S` directory, which is defined as: S = |
252 | "${WORKDIR}/${BP}" | 252 | "${WORKDIR}/${BP}" |
253 | 253 | ||
254 | You can separate the (``S``) directory and the directory pointed to | 254 | You can separate the (``S``) directory and the directory pointed to |
@@ -259,7 +259,7 @@ system and gives an overview of their function and contents. | |||
259 | BAD_RECOMMENDATIONS | 259 | BAD_RECOMMENDATIONS |
260 | Lists "recommended-only" packages to not install. Recommended-only | 260 | Lists "recommended-only" packages to not install. Recommended-only |
261 | packages are packages installed only through the | 261 | packages are packages installed only through the |
262 | ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ variable. You can prevent any | 262 | :term:`RRECOMMENDS` variable. You can prevent any |
263 | of these "recommended" packages from being installed by listing them | 263 | of these "recommended" packages from being installed by listing them |
264 | with the ``BAD_RECOMMENDATIONS`` variable: BAD_RECOMMENDATIONS = | 264 | with the ``BAD_RECOMMENDATIONS`` variable: BAD_RECOMMENDATIONS = |
265 | "package_name package_name package_name ..." | 265 | "package_name package_name package_name ..." |
@@ -270,15 +270,15 @@ system and gives an overview of their function and contents. | |||
270 | 270 | ||
271 | It is important to realize that if you choose to not install packages | 271 | It is important to realize that if you choose to not install packages |
272 | using this variable and some other packages are dependent on them | 272 | using this variable and some other packages are dependent on them |
273 | (i.e. listed in a recipe's ```RDEPENDS`` <#var-RDEPENDS>`__ | 273 | (i.e. listed in a recipe's :term:`RDEPENDS` |
274 | variable), the OpenEmbedded build system ignores your request and | 274 | variable), the OpenEmbedded build system ignores your request and |
275 | will install the packages to avoid dependency errors. | 275 | will install the packages to avoid dependency errors. |
276 | 276 | ||
277 | Support for this variable exists only when using the IPK and RPM | 277 | Support for this variable exists only when using the IPK and RPM |
278 | packaging backend. Support does not exist for DEB. | 278 | packaging backend. Support does not exist for DEB. |
279 | 279 | ||
280 | See the ```NO_RECOMMENDATIONS`` <#var-NO_RECOMMENDATIONS>`__ and the | 280 | See the :term:`NO_RECOMMENDATIONS` and the |
281 | ```PACKAGE_EXCLUDE`` <#var-PACKAGE_EXCLUDE>`__ variables for related | 281 | :term:`PACKAGE_EXCLUDE` variables for related |
282 | information. | 282 | information. |
283 | 283 | ||
284 | BASE_LIB | 284 | BASE_LIB |
@@ -291,7 +291,7 @@ system and gives an overview of their function and contents. | |||
291 | on Multilib. | 291 | on Multilib. |
292 | 292 | ||
293 | The ``BASE_LIB`` variable is defined in the machine include files in | 293 | The ``BASE_LIB`` variable is defined in the machine include files in |
294 | the `Source Directory <#source-directory>`__. If Multilib is not | 294 | the :term:`Source Directory`. If Multilib is not |
295 | being used, the value defaults to "lib". | 295 | being used, the value defaults to "lib". |
296 | 296 | ||
297 | BASE_WORKDIR | 297 | BASE_WORKDIR |
@@ -327,10 +327,10 @@ system and gives an overview of their function and contents. | |||
327 | - Attempts to access networks not in the host list cause a failure. | 327 | - Attempts to access networks not in the host list cause a failure. |
328 | 328 | ||
329 | Using ``BB_ALLOWED_NETWORKS`` in conjunction with | 329 | Using ``BB_ALLOWED_NETWORKS`` in conjunction with |
330 | ```PREMIRRORS`` <#var-PREMIRRORS>`__ is very useful. Adding the host | 330 | :term:`PREMIRRORS` is very useful. Adding the host |
331 | you want to use to ``PREMIRRORS`` results in the source code being | 331 | you want to use to ``PREMIRRORS`` results in the source code being |
332 | fetched from an allowed location and avoids raising an error when a | 332 | fetched from an allowed location and avoids raising an error when a |
333 | host that is not allowed is in a ```SRC_URI`` <#var-SRC_URI>`__ | 333 | host that is not allowed is in a :term:`SRC_URI` |
334 | statement. This is because the fetcher does not attempt to use the | 334 | statement. This is because the fetcher does not attempt to use the |
335 | host listed in ``SRC_URI`` after a successful fetch from the | 335 | host listed in ``SRC_URI`` after a successful fetch from the |
336 | ``PREMIRRORS`` occurs. | 336 | ``PREMIRRORS`` occurs. |
@@ -349,7 +349,7 @@ system and gives an overview of their function and contents. | |||
349 | 349 | ||
350 | You can change the default behavior by setting this variable to "1", | 350 | You can change the default behavior by setting this variable to "1", |
351 | "yes", or "true" in your ``local.conf`` file, which is located in the | 351 | "yes", or "true" in your ``local.conf`` file, which is located in the |
352 | `Build Directory <#build-directory>`__: Here is an example: | 352 | :term:`Build Directory`: Here is an example: |
353 | BB_DANGLINGAPPENDS_WARNONLY = "1" | 353 | BB_DANGLINGAPPENDS_WARNONLY = "1" |
354 | 354 | ||
355 | BB_DISKMON_DIRS | 355 | BB_DISKMON_DIRS |
@@ -358,7 +358,7 @@ system and gives an overview of their function and contents. | |||
358 | 358 | ||
359 | Disk space monitoring is disabled by default. To enable monitoring, | 359 | Disk space monitoring is disabled by default. To enable monitoring, |
360 | add the ``BB_DISKMON_DIRS`` variable to your ``conf/local.conf`` file | 360 | add the ``BB_DISKMON_DIRS`` variable to your ``conf/local.conf`` file |
361 | found in the `Build Directory <#build-directory>`__. Use the | 361 | found in the :term:`Build Directory`. Use the |
362 | following form: BB_DISKMON_DIRS = "action,dir,threshold [...]" where: | 362 | following form: BB_DISKMON_DIRS = "action,dir,threshold [...]" where: |
363 | action is: ABORT: Immediately abort the build when a threshold is | 363 | action is: ABORT: Immediately abort the build when a threshold is |
364 | broken. STOPTASKS: Stop the build after the currently executing tasks | 364 | broken. STOPTASKS: Stop the build after the currently executing tasks |
@@ -379,7 +379,7 @@ system and gives an overview of their function and contents. | |||
379 | WARN,${SSTATE_DIR},1G,100K" BB_DISKMON_DIRS = | 379 | WARN,${SSTATE_DIR},1G,100K" BB_DISKMON_DIRS = |
380 | "STOPTASKS,${TMPDIR},1G" BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" | 380 | "STOPTASKS,${TMPDIR},1G" BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" |
381 | The first example works only if you also provide the | 381 | The first example works only if you also provide the |
382 | ```BB_DISKMON_WARNINTERVAL`` <#var-BB_DISKMON_WARNINTERVAL>`__ | 382 | :term:`BB_DISKMON_WARNINTERVAL` |
383 | variable in the ``conf/local.conf``. This example causes the build | 383 | variable in the ``conf/local.conf``. This example causes the build |
384 | system to immediately abort when either the disk space in | 384 | system to immediately abort when either the disk space in |
385 | ``${TMPDIR}`` drops below 1 Gbyte or the available free inodes drops | 385 | ``${TMPDIR}`` drops below 1 Gbyte or the available free inodes drops |
@@ -402,10 +402,10 @@ system and gives an overview of their function and contents. | |||
402 | BB_DISKMON_WARNINTERVAL | 402 | BB_DISKMON_WARNINTERVAL |
403 | Defines the disk space and free inode warning intervals. To set these | 403 | Defines the disk space and free inode warning intervals. To set these |
404 | intervals, define the variable in your ``conf/local.conf`` file in | 404 | intervals, define the variable in your ``conf/local.conf`` file in |
405 | the `Build Directory <#build-directory>`__. | 405 | the :term:`Build Directory`. |
406 | 406 | ||
407 | If you are going to use the ``BB_DISKMON_WARNINTERVAL`` variable, you | 407 | If you are going to use the ``BB_DISKMON_WARNINTERVAL`` variable, you |
408 | must also use the ```BB_DISKMON_DIRS`` <#var-BB_DISKMON_DIRS>`__ | 408 | must also use the :term:`BB_DISKMON_DIRS` |
409 | variable and define its action as "WARN". During the build, | 409 | variable and define its action as "WARN". During the build, |
410 | subsequent warnings are issued each time disk space or number of free | 410 | subsequent warnings are issued each time disk space or number of free |
411 | inodes further reduces by the respective interval. | 411 | inodes further reduces by the respective interval. |
@@ -436,12 +436,12 @@ system and gives an overview of their function and contents. | |||
436 | BB_GENERATE_MIRROR_TARBALLS | 436 | BB_GENERATE_MIRROR_TARBALLS |
437 | Causes tarballs of the source control repositories (e.g. Git | 437 | Causes tarballs of the source control repositories (e.g. Git |
438 | repositories), including metadata, to be placed in the | 438 | repositories), including metadata, to be placed in the |
439 | ```DL_DIR`` <#var-DL_DIR>`__ directory. | 439 | :term:`DL_DIR` directory. |
440 | 440 | ||
441 | For performance reasons, creating and placing tarballs of these | 441 | For performance reasons, creating and placing tarballs of these |
442 | repositories is not the default action by the OpenEmbedded build | 442 | repositories is not the default action by the OpenEmbedded build |
443 | system. BB_GENERATE_MIRROR_TARBALLS = "1" Set this variable in your | 443 | system. BB_GENERATE_MIRROR_TARBALLS = "1" Set this variable in your |
444 | ``local.conf`` file in the `Build Directory <#build-directory>`__. | 444 | ``local.conf`` file in the :term:`Build Directory`. |
445 | 445 | ||
446 | Once you have the tarballs containing your source files, you can | 446 | Once you have the tarballs containing your source files, you can |
447 | clean up your ``DL_DIR`` directory by deleting any Git or other | 447 | clean up your ``DL_DIR`` directory by deleting any Git or other |
@@ -481,7 +481,7 @@ system and gives an overview of their function and contents. | |||
481 | ``quilt-native``, which is a copy of Quilt built to run on the build | 481 | ``quilt-native``, which is a copy of Quilt built to run on the build |
482 | system; "crosses" such as ``gcc-cross``, which is a compiler built to | 482 | system; "crosses" such as ``gcc-cross``, which is a compiler built to |
483 | run on the build machine but produces binaries that run on the target | 483 | run on the build machine but produces binaries that run on the target |
484 | ```MACHINE`` <#var-MACHINE>`__; "nativesdk", which targets the SDK | 484 | :term:`MACHINE`; "nativesdk", which targets the SDK |
485 | machine instead of ``MACHINE``; and "mulitlibs" in the form | 485 | machine instead of ``MACHINE``; and "mulitlibs" in the form |
486 | "``multilib:``\ multilib_name". | 486 | "``multilib:``\ multilib_name". |
487 | 487 | ||
@@ -495,7 +495,7 @@ system and gives an overview of their function and contents. | |||
495 | Internally, the ``BBCLASSEXTEND`` mechanism generates recipe | 495 | Internally, the ``BBCLASSEXTEND`` mechanism generates recipe |
496 | variants by rewriting variable values and applying overrides such | 496 | variants by rewriting variable values and applying overrides such |
497 | as ``_class-native``. For example, to generate a native version of | 497 | as ``_class-native``. For example, to generate a native version of |
498 | a recipe, a ```DEPENDS`` <#var-DEPENDS>`__ on "foo" is rewritten | 498 | a recipe, a :term:`DEPENDS` on "foo" is rewritten |
499 | to a ``DEPENDS`` on "foo-native". | 499 | to a ``DEPENDS`` on "foo-native". |
500 | 500 | ||
501 | Even when using ``BBCLASSEXTEND``, the recipe is only parsed once. | 501 | Even when using ``BBCLASSEXTEND``, the recipe is only parsed once. |
@@ -511,7 +511,7 @@ system and gives an overview of their function and contents. | |||
511 | 511 | ||
512 | BBFILE_PATTERN | 512 | BBFILE_PATTERN |
513 | Variable that expands to match files from | 513 | Variable that expands to match files from |
514 | ```BBFILES`` <#var-BBFILES>`__ in a particular layer. This variable | 514 | :term:`BBFILES` in a particular layer. This variable |
515 | is used in the ``conf/layer.conf`` file and must be suffixed with the | 515 | is used in the ``conf/layer.conf`` file and must be suffixed with the |
516 | name of the specific layer (e.g. ``BBFILE_PATTERN_emenlow``). | 516 | name of the specific layer (e.g. ``BBFILE_PATTERN_emenlow``). |
517 | 517 | ||
@@ -523,7 +523,7 @@ system and gives an overview of their function and contents. | |||
523 | prioritize a layer against other layers that contain the same recipe | 523 | prioritize a layer against other layers that contain the same recipe |
524 | - effectively letting you control the precedence for the multiple | 524 | - effectively letting you control the precedence for the multiple |
525 | layers. The precedence established through this variable stands | 525 | layers. The precedence established through this variable stands |
526 | regardless of a recipe's version (```PV`` <#var-PV>`__ variable). For | 526 | regardless of a recipe's version (:term:`PV` variable). For |
527 | example, a layer that has a recipe with a higher ``PV`` value but for | 527 | example, a layer that has a recipe with a higher ``PV`` value but for |
528 | which the ``BBFILE_PRIORITY`` is set to have a lower precedence still | 528 | which the ``BBFILE_PRIORITY`` is set to have a lower precedence still |
529 | has a lower precedence. | 529 | has a lower precedence. |
@@ -576,7 +576,7 @@ system and gives an overview of their function and contents. | |||
576 | Variable that controls how BitBake displays logs on build failure. | 576 | Variable that controls how BitBake displays logs on build failure. |
577 | 577 | ||
578 | BBINCLUDELOGS_LINES | 578 | BBINCLUDELOGS_LINES |
579 | If ```BBINCLUDELOGS`` <#var-BBINCLUDELOGS>`__ is set, specifies the | 579 | If :term:`BBINCLUDELOGS` is set, specifies the |
580 | maximum number of lines from the task log file to print when | 580 | maximum number of lines from the task log file to print when |
581 | reporting a failed task. If you do not set ``BBINCLUDELOGS_LINES``, | 581 | reporting a failed task. If you do not set ``BBINCLUDELOGS_LINES``, |
582 | the entire log is printed. | 582 | the entire log is printed. |
@@ -629,7 +629,7 @@ system and gives an overview of their function and contents. | |||
629 | multiconfigname for each configuration file you are using. For | 629 | multiconfigname for each configuration file you are using. For |
630 | example, the following line specifies three configuration files: | 630 | example, the following line specifies three configuration files: |
631 | BBMULTICONFIG = "configA configB configC" Each configuration file you | 631 | BBMULTICONFIG = "configA configB configC" Each configuration file you |
632 | use must reside in the `Build Directory <#build-directory>`__ | 632 | use must reside in the :term:`Build Directory` |
633 | ``conf/multiconfig`` directory (e.g. | 633 | ``conf/multiconfig`` directory (e.g. |
634 | build_directory\ ``/conf/multiconfig/configA.conf``). | 634 | build_directory\ ``/conf/multiconfig/configA.conf``). |
635 | 635 | ||
@@ -672,7 +672,7 @@ system and gives an overview of their function and contents. | |||
672 | 672 | ||
673 | BINCONFIG | 673 | BINCONFIG |
674 | When inheriting the | 674 | When inheriting the |
675 | ```binconfig-disabled`` <#ref-classes-binconfig-disabled>`__ class, | 675 | :ref:`binconfig-disabled <ref-classes-binconfig-disabled>` class, |
676 | this variable specifies binary configuration scripts to disable in | 676 | this variable specifies binary configuration scripts to disable in |
677 | favor of using ``pkg-config`` to query the information. The | 677 | favor of using ``pkg-config`` to query the information. The |
678 | ``binconfig-disabled`` class will modify the specified scripts to | 678 | ``binconfig-disabled`` class will modify the specified scripts to |
@@ -684,7 +684,7 @@ system and gives an overview of their function and contents. | |||
684 | ${bindir}/libpng16-config" | 684 | ${bindir}/libpng16-config" |
685 | 685 | ||
686 | BINCONFIG_GLOB | 686 | BINCONFIG_GLOB |
687 | When inheriting the ```binconfig`` <#ref-classes-binconfig>`__ class, | 687 | When inheriting the :ref:`binconfig <ref-classes-binconfig>` class, |
688 | this variable specifies a wildcard for configuration scripts that | 688 | this variable specifies a wildcard for configuration scripts that |
689 | need editing. The scripts are edited to correct any paths that have | 689 | need editing. The scripts are edited to correct any paths that have |
690 | been set up during compilation so that they are correct for use when | 690 | been set up during compilation so that they are correct for use when |
@@ -708,7 +708,7 @@ system and gives an overview of their function and contents. | |||
708 | ``meta/classes/binconfig.bbclass`` in the `Source | 708 | ``meta/classes/binconfig.bbclass`` in the `Source |
709 | Directory <#source-directory>`__. You can also find general | 709 | Directory <#source-directory>`__. You can also find general |
710 | information on the class in the | 710 | information on the class in the |
711 | "```binconfig.bbclass`` <#ref-classes-binconfig>`__" section. | 711 | ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section. |
712 | 712 | ||
713 | BP | 713 | BP |
714 | The base recipe name and version but without any special recipe name | 714 | The base recipe name and version but without any special recipe name |
@@ -716,12 +716,12 @@ system and gives an overview of their function and contents. | |||
716 | comprised of the following: ${BPN}-${PV} | 716 | comprised of the following: ${BPN}-${PV} |
717 | 717 | ||
718 | BPN | 718 | BPN |
719 | This variable is a version of the ```PN`` <#var-PN>`__ variable with | 719 | This variable is a version of the :term:`PN` variable with |
720 | common prefixes and suffixes removed, such as ``nativesdk-``, | 720 | common prefixes and suffixes removed, such as ``nativesdk-``, |
721 | ``-cross``, ``-native``, and multilib's ``lib64-`` and ``lib32-``. | 721 | ``-cross``, ``-native``, and multilib's ``lib64-`` and ``lib32-``. |
722 | The exact lists of prefixes and suffixes removed are specified by the | 722 | The exact lists of prefixes and suffixes removed are specified by the |
723 | ```MLPREFIX`` <#var-MLPREFIX>`__ and | 723 | :term:`MLPREFIX` and |
724 | ```SPECIAL_PKGSUFFIX`` <#var-SPECIAL_PKGSUFFIX>`__ variables, | 724 | :term:`SPECIAL_PKGSUFFIX` variables, |
725 | respectively. | 725 | respectively. |
726 | 726 | ||
727 | BUGTRACKER | 727 | BUGTRACKER |
@@ -747,37 +747,37 @@ system and gives an overview of their function and contents. | |||
747 | Specifies the linker command to be used for the build host when the C | 747 | Specifies the linker command to be used for the build host when the C |
748 | compiler is being used as the linker. By default, ``BUILD_CCLD`` | 748 | compiler is being used as the linker. By default, ``BUILD_CCLD`` |
749 | points to GCC and passes as arguments the value of | 749 | points to GCC and passes as arguments the value of |
750 | ```BUILD_CC_ARCH`` <#var-BUILD_CC_ARCH>`__, assuming | 750 | :term:`BUILD_CC_ARCH`, assuming |
751 | ``BUILD_CC_ARCH`` is set. | 751 | ``BUILD_CC_ARCH`` is set. |
752 | 752 | ||
753 | BUILD_CFLAGS | 753 | BUILD_CFLAGS |
754 | Specifies the flags to pass to the C compiler when building for the | 754 | Specifies the flags to pass to the C compiler when building for the |
755 | build host. When building in the ``-native`` context, | 755 | build host. When building in the ``-native`` context, |
756 | ```CFLAGS`` <#var-CFLAGS>`__ is set to the value of this variable by | 756 | :term:`CFLAGS` is set to the value of this variable by |
757 | default. | 757 | default. |
758 | 758 | ||
759 | BUILD_CPPFLAGS | 759 | BUILD_CPPFLAGS |
760 | Specifies the flags to pass to the C preprocessor (i.e. to both the C | 760 | Specifies the flags to pass to the C preprocessor (i.e. to both the C |
761 | and the C++ compilers) when building for the build host. When | 761 | and the C++ compilers) when building for the build host. When |
762 | building in the ``-native`` context, ```CPPFLAGS`` <#var-CPPFLAGS>`__ | 762 | building in the ``-native`` context, :term:`CPPFLAGS` |
763 | is set to the value of this variable by default. | 763 | is set to the value of this variable by default. |
764 | 764 | ||
765 | BUILD_CXXFLAGS | 765 | BUILD_CXXFLAGS |
766 | Specifies the flags to pass to the C++ compiler when building for the | 766 | Specifies the flags to pass to the C++ compiler when building for the |
767 | build host. When building in the ``-native`` context, | 767 | build host. When building in the ``-native`` context, |
768 | ```CXXFLAGS`` <#var-CXXFLAGS>`__ is set to the value of this variable | 768 | :term:`CXXFLAGS` is set to the value of this variable |
769 | by default. | 769 | by default. |
770 | 770 | ||
771 | BUILD_FC | 771 | BUILD_FC |
772 | Specifies the Fortran compiler command for the build host. By | 772 | Specifies the Fortran compiler command for the build host. By |
773 | default, ``BUILD_FC`` points to Gfortran and passes as arguments the | 773 | default, ``BUILD_FC`` points to Gfortran and passes as arguments the |
774 | value of ```BUILD_CC_ARCH`` <#var-BUILD_CC_ARCH>`__, assuming | 774 | value of :term:`BUILD_CC_ARCH`, assuming |
775 | ``BUILD_CC_ARCH`` is set. | 775 | ``BUILD_CC_ARCH`` is set. |
776 | 776 | ||
777 | BUILD_LD | 777 | BUILD_LD |
778 | Specifies the linker command for the build host. By default, | 778 | Specifies the linker command for the build host. By default, |
779 | ``BUILD_LD`` points to the GNU linker (ld) and passes as arguments | 779 | ``BUILD_LD`` points to the GNU linker (ld) and passes as arguments |
780 | the value of ```BUILD_LD_ARCH`` <#var-BUILD_LD_ARCH>`__, assuming | 780 | the value of :term:`BUILD_LD_ARCH`, assuming |
781 | ``BUILD_LD_ARCH`` is set. | 781 | ``BUILD_LD_ARCH`` is set. |
782 | 782 | ||
783 | BUILD_LD_ARCH | 783 | BUILD_LD_ARCH |
@@ -787,14 +787,14 @@ system and gives an overview of their function and contents. | |||
787 | BUILD_LDFLAGS | 787 | BUILD_LDFLAGS |
788 | Specifies the flags to pass to the linker when building for the build | 788 | Specifies the flags to pass to the linker when building for the build |
789 | host. When building in the ``-native`` context, | 789 | host. When building in the ``-native`` context, |
790 | ```LDFLAGS`` <#var-LDFLAGS>`__ is set to the value of this variable | 790 | :term:`LDFLAGS` is set to the value of this variable |
791 | by default. | 791 | by default. |
792 | 792 | ||
793 | BUILD_OPTIMIZATION | 793 | BUILD_OPTIMIZATION |
794 | Specifies the optimization flags passed to the C compiler when | 794 | Specifies the optimization flags passed to the C compiler when |
795 | building for the build host or the SDK. The flags are passed through | 795 | building for the build host or the SDK. The flags are passed through |
796 | the ```BUILD_CFLAGS`` <#var-BUILD_CFLAGS>`__ and | 796 | the :term:`BUILD_CFLAGS` and |
797 | ```BUILDSDK_CFLAGS`` <#var-BUILDSDK_CFLAGS>`__ default values. | 797 | :term:`BUILDSDK_CFLAGS` default values. |
798 | 798 | ||
799 | The default value of the ``BUILD_OPTIMIZATION`` variable is "-O2 | 799 | The default value of the ``BUILD_OPTIMIZATION`` variable is "-O2 |
800 | -pipe". | 800 | -pipe". |
@@ -808,14 +808,14 @@ system and gives an overview of their function and contents. | |||
808 | BUILD_PREFIX | 808 | BUILD_PREFIX |
809 | The toolchain binary prefix used for native recipes. The OpenEmbedded | 809 | The toolchain binary prefix used for native recipes. The OpenEmbedded |
810 | build system uses the ``BUILD_PREFIX`` value to set the | 810 | build system uses the ``BUILD_PREFIX`` value to set the |
811 | ```TARGET_PREFIX`` <#var-TARGET_PREFIX>`__ when building for | 811 | :term:`TARGET_PREFIX` when building for |
812 | ``native`` recipes. | 812 | ``native`` recipes. |
813 | 813 | ||
814 | BUILD_STRIP | 814 | BUILD_STRIP |
815 | Specifies the command to be used to strip debugging symbols from | 815 | Specifies the command to be used to strip debugging symbols from |
816 | binaries produced for the build host. By default, ``BUILD_STRIP`` | 816 | binaries produced for the build host. By default, ``BUILD_STRIP`` |
817 | points to | 817 | points to |
818 | ``${``\ ```BUILD_PREFIX`` <#var-BUILD_PREFIX>`__\ ``}strip``. | 818 | ``${``\ :term:`BUILD_PREFIX`\ ``}strip``. |
819 | 819 | ||
820 | BUILD_SYS | 820 | BUILD_SYS |
821 | Specifies the system, including the architecture and the operating | 821 | Specifies the system, including the architecture and the operating |
@@ -823,9 +823,9 @@ system and gives an overview of their function and contents. | |||
823 | ``native`` recipes). | 823 | ``native`` recipes). |
824 | 824 | ||
825 | The OpenEmbedded build system automatically sets this variable based | 825 | The OpenEmbedded build system automatically sets this variable based |
826 | on ```BUILD_ARCH`` <#var-BUILD_ARCH>`__, | 826 | on :term:`BUILD_ARCH`, |
827 | ```BUILD_VENDOR`` <#var-BUILD_VENDOR>`__, and | 827 | :term:`BUILD_VENDOR`, and |
828 | ```BUILD_OS`` <#var-BUILD_OS>`__. You do not need to set the | 828 | :term:`BUILD_OS`. You do not need to set the |
829 | ``BUILD_SYS`` variable yourself. | 829 | ``BUILD_SYS`` variable yourself. |
830 | 830 | ||
831 | BUILD_VENDOR | 831 | BUILD_VENDOR |
@@ -833,7 +833,7 @@ system and gives an overview of their function and contents. | |||
833 | The default value is an empty string (""). | 833 | The default value is an empty string (""). |
834 | 834 | ||
835 | BUILDDIR | 835 | BUILDDIR |
836 | Points to the location of the `Build Directory <#build-directory>`__. | 836 | Points to the location of the :term:`Build Directory`. |
837 | You can define this directory indirectly through the | 837 | You can define this directory indirectly through the |
838 | ````` <#structure-core-script>`__ script by passing in a Build | 838 | ````` <#structure-core-script>`__ script by passing in a Build |
839 | Directory path when you run the script. If you run the script and do | 839 | Directory path when you run the script. If you run the script and do |
@@ -841,7 +841,7 @@ system and gives an overview of their function and contents. | |||
841 | ``build`` in the current directory. | 841 | ``build`` in the current directory. |
842 | 842 | ||
843 | BUILDHISTORY_COMMIT | 843 | BUILDHISTORY_COMMIT |
844 | When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__ | 844 | When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` |
845 | class, this variable specifies whether or not to commit the build | 845 | class, this variable specifies whether or not to commit the build |
846 | history output in a local Git repository. If set to "1", this local | 846 | history output in a local Git repository. If set to "1", this local |
847 | repository will be maintained automatically by the ``buildhistory`` | 847 | repository will be maintained automatically by the ``buildhistory`` |
@@ -854,10 +854,10 @@ system and gives an overview of their function and contents. | |||
854 | history output in a local Git repository: BUILDHISTORY_COMMIT ?= "0" | 854 | history output in a local Git repository: BUILDHISTORY_COMMIT ?= "0" |
855 | 855 | ||
856 | BUILDHISTORY_COMMIT_AUTHOR | 856 | BUILDHISTORY_COMMIT_AUTHOR |
857 | When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__ | 857 | When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` |
858 | class, this variable specifies the author to use for each Git commit. | 858 | class, this variable specifies the author to use for each Git commit. |
859 | In order for the ``BUILDHISTORY_COMMIT_AUTHOR`` variable to work, the | 859 | In order for the ``BUILDHISTORY_COMMIT_AUTHOR`` variable to work, the |
860 | ```BUILDHISTORY_COMMIT`` <#var-BUILDHISTORY_COMMIT>`__ variable must | 860 | :term:`BUILDHISTORY_COMMIT` variable must |
861 | be set to "1". | 861 | be set to "1". |
862 | 862 | ||
863 | Git requires that the value you provide for the | 863 | Git requires that the value you provide for the |
@@ -869,7 +869,7 @@ system and gives an overview of their function and contents. | |||
869 | BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>" | 869 | BUILDHISTORY_COMMIT_AUTHOR ?= "buildhistory <buildhistory@${DISTRO}>" |
870 | 870 | ||
871 | BUILDHISTORY_DIR | 871 | BUILDHISTORY_DIR |
872 | When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__ | 872 | When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` |
873 | class, this variable specifies the directory in which build history | 873 | class, this variable specifies the directory in which build history |
874 | information is kept. For more information on how the variable works, | 874 | information is kept. For more information on how the variable works, |
875 | see the ``buildhistory.class``. | 875 | see the ``buildhistory.class``. |
@@ -878,7 +878,7 @@ system and gives an overview of their function and contents. | |||
878 | BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory" | 878 | BUILDHISTORY_DIR ?= "${TOPDIR}/buildhistory" |
879 | 879 | ||
880 | BUILDHISTORY_FEATURES | 880 | BUILDHISTORY_FEATURES |
881 | When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__ | 881 | When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` |
882 | class, this variable specifies the build history features to be | 882 | class, this variable specifies the build history features to be |
883 | enabled. For more information on how build history works, see the | 883 | enabled. For more information on how build history works, see the |
884 | "`Maintaining Build Output | 884 | "`Maintaining Build Output |
@@ -904,7 +904,7 @@ system and gives an overview of their function and contents. | |||
904 | features: BUILDHISTORY_FEATURES ?= "image package sdk" | 904 | features: BUILDHISTORY_FEATURES ?= "image package sdk" |
905 | 905 | ||
906 | BUILDHISTORY_IMAGE_FILES | 906 | BUILDHISTORY_IMAGE_FILES |
907 | When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__ | 907 | When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` |
908 | class, this variable specifies a list of paths to files copied from | 908 | class, this variable specifies a list of paths to files copied from |
909 | the image contents into the build history directory under an | 909 | the image contents into the build history directory under an |
910 | "image-files" directory in the directory for the image, so that you | 910 | "image-files" directory in the directory for the image, so that you |
@@ -918,11 +918,11 @@ system and gives an overview of their function and contents. | |||
918 | following files: BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group" | 918 | following files: BUILDHISTORY_IMAGE_FILES ?= "/etc/passwd /etc/group" |
919 | 919 | ||
920 | BUILDHISTORY_PUSH_REPO | 920 | BUILDHISTORY_PUSH_REPO |
921 | When inheriting the ```buildhistory`` <#ref-classes-buildhistory>`__ | 921 | When inheriting the :ref:`buildhistory <ref-classes-buildhistory>` |
922 | class, this variable optionally specifies a remote repository to | 922 | class, this variable optionally specifies a remote repository to |
923 | which build history pushes Git changes. In order for | 923 | which build history pushes Git changes. In order for |
924 | ``BUILDHISTORY_PUSH_REPO`` to work, | 924 | ``BUILDHISTORY_PUSH_REPO`` to work, |
925 | ```BUILDHISTORY_COMMIT`` <#var-BUILDHISTORY_COMMIT>`__ must be set to | 925 | :term:`BUILDHISTORY_COMMIT` must be set to |
926 | "1". | 926 | "1". |
927 | 927 | ||
928 | The repository should correspond to a remote address that specifies a | 928 | The repository should correspond to a remote address that specifies a |
@@ -936,33 +936,33 @@ system and gives an overview of their function and contents. | |||
936 | BUILDSDK_CFLAGS | 936 | BUILDSDK_CFLAGS |
937 | Specifies the flags to pass to the C compiler when building for the | 937 | Specifies the flags to pass to the C compiler when building for the |
938 | SDK. When building in the ``nativesdk-`` context, | 938 | SDK. When building in the ``nativesdk-`` context, |
939 | ```CFLAGS`` <#var-CFLAGS>`__ is set to the value of this variable by | 939 | :term:`CFLAGS` is set to the value of this variable by |
940 | default. | 940 | default. |
941 | 941 | ||
942 | BUILDSDK_CPPFLAGS | 942 | BUILDSDK_CPPFLAGS |
943 | Specifies the flags to pass to the C pre-processor (i.e. to both the | 943 | Specifies the flags to pass to the C pre-processor (i.e. to both the |
944 | C and the C++ compilers) when building for the SDK. When building in | 944 | C and the C++ compilers) when building for the SDK. When building in |
945 | the ``nativesdk-`` context, ```CPPFLAGS`` <#var-CPPFLAGS>`__ is set | 945 | the ``nativesdk-`` context, :term:`CPPFLAGS` is set |
946 | to the value of this variable by default. | 946 | to the value of this variable by default. |
947 | 947 | ||
948 | BUILDSDK_CXXFLAGS | 948 | BUILDSDK_CXXFLAGS |
949 | Specifies the flags to pass to the C++ compiler when building for the | 949 | Specifies the flags to pass to the C++ compiler when building for the |
950 | SDK. When building in the ``nativesdk-`` context, | 950 | SDK. When building in the ``nativesdk-`` context, |
951 | ```CXXFLAGS`` <#var-CXXFLAGS>`__ is set to the value of this variable | 951 | :term:`CXXFLAGS` is set to the value of this variable |
952 | by default. | 952 | by default. |
953 | 953 | ||
954 | BUILDSDK_LDFLAGS | 954 | BUILDSDK_LDFLAGS |
955 | Specifies the flags to pass to the linker when building for the SDK. | 955 | Specifies the flags to pass to the linker when building for the SDK. |
956 | When building in the ``nativesdk-`` context, | 956 | When building in the ``nativesdk-`` context, |
957 | ```LDFLAGS`` <#var-LDFLAGS>`__ is set to the value of this variable | 957 | :term:`LDFLAGS` is set to the value of this variable |
958 | by default. | 958 | by default. |
959 | 959 | ||
960 | BUILDSTATS_BASE | 960 | BUILDSTATS_BASE |
961 | Points to the location of the directory that holds build statistics | 961 | Points to the location of the directory that holds build statistics |
962 | when you use and enable the | 962 | when you use and enable the |
963 | ```buildstats`` <#ref-classes-buildstats>`__ class. The | 963 | :ref:`buildstats <ref-classes-buildstats>` class. The |
964 | ``BUILDSTATS_BASE`` directory defaults to | 964 | ``BUILDSTATS_BASE`` directory defaults to |
965 | ``${``\ ```TMPDIR`` <#var-TMPDIR>`__\ ``}/buildstats/``. | 965 | ``${``\ :term:`TMPDIR`\ ``}/buildstats/``. |
966 | 966 | ||
967 | BUSYBOX_SPLIT_SUID | 967 | BUSYBOX_SPLIT_SUID |
968 | For the BusyBox recipe, specifies whether to split the output | 968 | For the BusyBox recipe, specifies whether to split the output |
@@ -976,7 +976,7 @@ system and gives an overview of their function and contents. | |||
976 | 976 | ||
977 | CACHE | 977 | CACHE |
978 | Specifies the directory BitBake uses to store a cache of the | 978 | Specifies the directory BitBake uses to store a cache of the |
979 | `Metadata <#metadata>`__ so it does not need to be parsed every time | 979 | :term:`Metadata` so it does not need to be parsed every time |
980 | BitBake is started. | 980 | BitBake is started. |
981 | 981 | ||
982 | CC | 982 | CC |
@@ -990,21 +990,21 @@ system and gives an overview of their function and contents. | |||
990 | Default initialization for ``CFLAGS`` varies depending on what is | 990 | Default initialization for ``CFLAGS`` varies depending on what is |
991 | being built: | 991 | being built: |
992 | 992 | ||
993 | - ```TARGET_CFLAGS`` <#var-TARGET_CFLAGS>`__ when building for the | 993 | - :term:`TARGET_CFLAGS` when building for the |
994 | target | 994 | target |
995 | 995 | ||
996 | - ```BUILD_CFLAGS`` <#var-BUILD_CFLAGS>`__ when building for the | 996 | - :term:`BUILD_CFLAGS` when building for the |
997 | build host (i.e. ``-native``) | 997 | build host (i.e. ``-native``) |
998 | 998 | ||
999 | - ```BUILDSDK_CFLAGS`` <#var-BUILDSDK_CFLAGS>`__ when building for | 999 | - :term:`BUILDSDK_CFLAGS` when building for |
1000 | an SDK (i.e. ``nativesdk-``) | 1000 | an SDK (i.e. ``nativesdk-``) |
1001 | 1001 | ||
1002 | CLASSOVERRIDE | 1002 | CLASSOVERRIDE |
1003 | An internal variable specifying the special class override that | 1003 | An internal variable specifying the special class override that |
1004 | should currently apply (e.g. "class-target", "class-native", and so | 1004 | should currently apply (e.g. "class-target", "class-native", and so |
1005 | forth). The classes that use this variable (e.g. | 1005 | forth). The classes that use this variable (e.g. |
1006 | ```native`` <#ref-classes-native>`__, | 1006 | :ref:`native <ref-classes-native>`, |
1007 | ```nativesdk`` <#ref-classes-nativesdk>`__, and so forth) set the | 1007 | :ref:`nativesdk <ref-classes-nativesdk>`, and so forth) set the |
1008 | variable to appropriate values. | 1008 | variable to appropriate values. |
1009 | 1009 | ||
1010 | .. note:: | 1010 | .. note:: |
@@ -1022,19 +1022,19 @@ system and gives an overview of their function and contents. | |||
1022 | building for the build host: FOO_class-native = "native" FOO = | 1022 | building for the build host: FOO_class-native = "native" FOO = |
1023 | "other" The underlying mechanism behind ``CLASSOVERRIDE`` is simply | 1023 | "other" The underlying mechanism behind ``CLASSOVERRIDE`` is simply |
1024 | that it is included in the default value of | 1024 | that it is included in the default value of |
1025 | ```OVERRIDES`` <#var-OVERRIDES>`__. | 1025 | :term:`OVERRIDES`. |
1026 | 1026 | ||
1027 | CLEANBROKEN | 1027 | CLEANBROKEN |
1028 | If set to "1" within a recipe, ``CLEANBROKEN`` specifies that the | 1028 | If set to "1" within a recipe, ``CLEANBROKEN`` specifies that the |
1029 | ``make clean`` command does not work for the software being built. | 1029 | ``make clean`` command does not work for the software being built. |
1030 | Consequently, the OpenEmbedded build system will not try to run | 1030 | Consequently, the OpenEmbedded build system will not try to run |
1031 | ``make clean`` during the ```do_configure`` <#ref-tasks-configure>`__ | 1031 | ``make clean`` during the :ref:`ref-tasks-configure` |
1032 | task, which is the default behavior. | 1032 | task, which is the default behavior. |
1033 | 1033 | ||
1034 | COMBINED_FEATURES | 1034 | COMBINED_FEATURES |
1035 | Provides a list of hardware features that are enabled in both | 1035 | Provides a list of hardware features that are enabled in both |
1036 | ```MACHINE_FEATURES`` <#var-MACHINE_FEATURES>`__ and | 1036 | :term:`MACHINE_FEATURES` and |
1037 | ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__. This select list of | 1037 | :term:`DISTRO_FEATURES`. This select list of |
1038 | features contains features that make sense to be controlled both at | 1038 | features contains features that make sense to be controlled both at |
1039 | the machine and distribution configuration level. For example, the | 1039 | the machine and distribution configuration level. For example, the |
1040 | "bluetooth" feature requires hardware support but should also be | 1040 | "bluetooth" feature requires hardware support but should also be |
@@ -1050,7 +1050,7 @@ system and gives an overview of their function and contents. | |||
1050 | A regular expression that resolves to one or more hosts (when the | 1050 | A regular expression that resolves to one or more hosts (when the |
1051 | recipe is native) or one or more targets (when the recipe is | 1051 | recipe is native) or one or more targets (when the recipe is |
1052 | non-native) with which a recipe is compatible. The regular expression | 1052 | non-native) with which a recipe is compatible. The regular expression |
1053 | is matched against ```HOST_SYS`` <#var-HOST_SYS>`__. You can use the | 1053 | is matched against :term:`HOST_SYS`. You can use the |
1054 | variable to stop recipes from being built for classes of systems with | 1054 | variable to stop recipes from being built for classes of systems with |
1055 | which the recipes are not compatible. Stopping these builds is | 1055 | which the recipes are not compatible. Stopping these builds is |
1056 | particularly useful with kernels. The variable also helps to increase | 1056 | particularly useful with kernels. The variable also helps to increase |
@@ -1060,7 +1060,7 @@ system and gives an overview of their function and contents. | |||
1060 | COMPATIBLE_MACHINE | 1060 | COMPATIBLE_MACHINE |
1061 | A regular expression that resolves to one or more target machines | 1061 | A regular expression that resolves to one or more target machines |
1062 | with which a recipe is compatible. The regular expression is matched | 1062 | with which a recipe is compatible. The regular expression is matched |
1063 | against ```MACHINEOVERRIDES`` <#var-MACHINEOVERRIDES>`__. You can use | 1063 | against :term:`MACHINEOVERRIDES`. You can use |
1064 | the variable to stop recipes from being built for machines with which | 1064 | the variable to stop recipes from being built for machines with which |
1065 | the recipes are not compatible. Stopping these builds is particularly | 1065 | the recipes are not compatible. Stopping these builds is particularly |
1066 | useful with kernels. The variable also helps to increase parsing | 1066 | useful with kernels. The variable also helps to increase parsing |
@@ -1084,7 +1084,7 @@ system and gives an overview of their function and contents. | |||
1084 | 1084 | ||
1085 | The resulting list of complementary packages is associated with an | 1085 | The resulting list of complementary packages is associated with an |
1086 | item that can be added to | 1086 | item that can be added to |
1087 | ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__. An example usage of | 1087 | :term:`IMAGE_FEATURES`. An example usage of |
1088 | this is the "dev-pkgs" item that when added to ``IMAGE_FEATURES`` | 1088 | this is the "dev-pkgs" item that when added to ``IMAGE_FEATURES`` |
1089 | will install -dev packages (containing headers and other development | 1089 | will install -dev packages (containing headers and other development |
1090 | files) for every package in the image. | 1090 | files) for every package in the image. |
@@ -1099,9 +1099,9 @@ system and gives an overview of their function and contents. | |||
1099 | sysroots for other recipes. | 1099 | sysroots for other recipes. |
1100 | 1100 | ||
1101 | The default is | 1101 | The default is |
1102 | "``${``\ ```STAGING_DIR`` <#var-STAGING_DIR>`__\ ``}-components``." | 1102 | "``${``\ :term:`STAGING_DIR`\ ``}-components``." |
1103 | (i.e. | 1103 | (i.e. |
1104 | "``${``\ ```TMPDIR`` <#var-TMPDIR>`__\ ``}/sysroots-components``"). | 1104 | "``${``\ :term:`TMPDIR`\ ``}/sysroots-components``"). |
1105 | 1105 | ||
1106 | CONF_VERSION | 1106 | CONF_VERSION |
1107 | Tracks the version of the local configuration file (i.e. | 1107 | Tracks the version of the local configuration file (i.e. |
@@ -1183,7 +1183,7 @@ system and gives an overview of their function and contents. | |||
1183 | 1183 | ||
1184 | CONFLICT_DISTRO_FEATURES | 1184 | CONFLICT_DISTRO_FEATURES |
1185 | When inheriting the | 1185 | When inheriting the |
1186 | ```distro_features_check`` <#ref-classes-distro_features_check>`__ | 1186 | :ref:`distro_features_check <ref-classes-distro_features_check>` |
1187 | class, this variable identifies distribution features that would be | 1187 | class, this variable identifies distribution features that would be |
1188 | in conflict should the recipe be built. In other words, if the | 1188 | in conflict should the recipe be built. In other words, if the |
1189 | ``CONFLICT_DISTRO_FEATURES`` variable lists a feature that also | 1189 | ``CONFLICT_DISTRO_FEATURES`` variable lists a feature that also |
@@ -1192,9 +1192,9 @@ system and gives an overview of their function and contents. | |||
1192 | 1192 | ||
1193 | COPYLEFT_LICENSE_EXCLUDE | 1193 | COPYLEFT_LICENSE_EXCLUDE |
1194 | A space-separated list of licenses to exclude from the source | 1194 | A space-separated list of licenses to exclude from the source |
1195 | archived by the ```archiver`` <#ref-classes-archiver>`__ class. In | 1195 | archived by the :ref:`archiver <ref-classes-archiver>` class. In |
1196 | other words, if a license in a recipe's | 1196 | other words, if a license in a recipe's |
1197 | ```LICENSE`` <#var-LICENSE>`__ value is in the value of | 1197 | :term:`LICENSE` value is in the value of |
1198 | ``COPYLEFT_LICENSE_EXCLUDE``, then its source is not archived by the | 1198 | ``COPYLEFT_LICENSE_EXCLUDE``, then its source is not archived by the |
1199 | class. | 1199 | class. |
1200 | 1200 | ||
@@ -1208,62 +1208,62 @@ system and gives an overview of their function and contents. | |||
1208 | 1208 | ||
1209 | The default value, which is "CLOSED Proprietary", for | 1209 | The default value, which is "CLOSED Proprietary", for |
1210 | ``COPYLEFT_LICENSE_EXCLUDE`` is set by the | 1210 | ``COPYLEFT_LICENSE_EXCLUDE`` is set by the |
1211 | ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ class, which | 1211 | :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which |
1212 | is inherited by the ``archiver`` class. | 1212 | is inherited by the ``archiver`` class. |
1213 | 1213 | ||
1214 | COPYLEFT_LICENSE_INCLUDE | 1214 | COPYLEFT_LICENSE_INCLUDE |
1215 | A space-separated list of licenses to include in the source archived | 1215 | A space-separated list of licenses to include in the source archived |
1216 | by the ```archiver`` <#ref-classes-archiver>`__ class. In other | 1216 | by the :ref:`archiver <ref-classes-archiver>` class. In other |
1217 | words, if a license in a recipe's ```LICENSE`` <#var-LICENSE>`__ | 1217 | words, if a license in a recipe's :term:`LICENSE` |
1218 | value is in the value of ``COPYLEFT_LICENSE_INCLUDE``, then its | 1218 | value is in the value of ``COPYLEFT_LICENSE_INCLUDE``, then its |
1219 | source is archived by the class. | 1219 | source is archived by the class. |
1220 | 1220 | ||
1221 | The default value is set by the | 1221 | The default value is set by the |
1222 | ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ class, which | 1222 | :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which |
1223 | is inherited by the ``archiver`` class. The default value includes | 1223 | is inherited by the ``archiver`` class. The default value includes |
1224 | "GPL*", "LGPL*", and "AGPL*". | 1224 | "GPL*", "LGPL*", and "AGPL*". |
1225 | 1225 | ||
1226 | COPYLEFT_PN_EXCLUDE | 1226 | COPYLEFT_PN_EXCLUDE |
1227 | A list of recipes to exclude in the source archived by the | 1227 | A list of recipes to exclude in the source archived by the |
1228 | ```archiver`` <#ref-classes-archiver>`__ class. The | 1228 | :ref:`archiver <ref-classes-archiver>` class. The |
1229 | ``COPYLEFT_PN_EXCLUDE`` variable overrides the license inclusion and | 1229 | ``COPYLEFT_PN_EXCLUDE`` variable overrides the license inclusion and |
1230 | exclusion caused through the | 1230 | exclusion caused through the |
1231 | ```COPYLEFT_LICENSE_INCLUDE`` <#var-COPYLEFT_LICENSE_INCLUDE>`__ and | 1231 | :term:`COPYLEFT_LICENSE_INCLUDE` and |
1232 | ```COPYLEFT_LICENSE_EXCLUDE`` <#var-COPYLEFT_LICENSE_EXCLUDE>`__ | 1232 | :term:`COPYLEFT_LICENSE_EXCLUDE` |
1233 | variables, respectively. | 1233 | variables, respectively. |
1234 | 1234 | ||
1235 | The default value, which is "" indicating to not explicitly exclude | 1235 | The default value, which is "" indicating to not explicitly exclude |
1236 | any recipes by name, for ``COPYLEFT_PN_EXCLUDE`` is set by the | 1236 | any recipes by name, for ``COPYLEFT_PN_EXCLUDE`` is set by the |
1237 | ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ class, which | 1237 | :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which |
1238 | is inherited by the ``archiver`` class. | 1238 | is inherited by the ``archiver`` class. |
1239 | 1239 | ||
1240 | COPYLEFT_PN_INCLUDE | 1240 | COPYLEFT_PN_INCLUDE |
1241 | A list of recipes to include in the source archived by the | 1241 | A list of recipes to include in the source archived by the |
1242 | ```archiver`` <#ref-classes-archiver>`__ class. The | 1242 | :ref:`archiver <ref-classes-archiver>` class. The |
1243 | ``COPYLEFT_PN_INCLUDE`` variable overrides the license inclusion and | 1243 | ``COPYLEFT_PN_INCLUDE`` variable overrides the license inclusion and |
1244 | exclusion caused through the | 1244 | exclusion caused through the |
1245 | ```COPYLEFT_LICENSE_INCLUDE`` <#var-COPYLEFT_LICENSE_INCLUDE>`__ and | 1245 | :term:`COPYLEFT_LICENSE_INCLUDE` and |
1246 | ```COPYLEFT_LICENSE_EXCLUDE`` <#var-COPYLEFT_LICENSE_EXCLUDE>`__ | 1246 | :term:`COPYLEFT_LICENSE_EXCLUDE` |
1247 | variables, respectively. | 1247 | variables, respectively. |
1248 | 1248 | ||
1249 | The default value, which is "" indicating to not explicitly include | 1249 | The default value, which is "" indicating to not explicitly include |
1250 | any recipes by name, for ``COPYLEFT_PN_INCLUDE`` is set by the | 1250 | any recipes by name, for ``COPYLEFT_PN_INCLUDE`` is set by the |
1251 | ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ class, which | 1251 | :ref:`copyleft_filter <ref-classes-copyleft_filter>` class, which |
1252 | is inherited by the ``archiver`` class. | 1252 | is inherited by the ``archiver`` class. |
1253 | 1253 | ||
1254 | COPYLEFT_RECIPE_TYPES | 1254 | COPYLEFT_RECIPE_TYPES |
1255 | A space-separated list of recipe types to include in the source | 1255 | A space-separated list of recipe types to include in the source |
1256 | archived by the ```archiver`` <#ref-classes-archiver>`__ class. | 1256 | archived by the :ref:`archiver <ref-classes-archiver>` class. |
1257 | Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``, | 1257 | Recipe types are ``target``, ``native``, ``nativesdk``, ``cross``, |
1258 | ``crosssdk``, and ``cross-canadian``. | 1258 | ``crosssdk``, and ``cross-canadian``. |
1259 | 1259 | ||
1260 | The default value, which is "target*", for ``COPYLEFT_RECIPE_TYPES`` | 1260 | The default value, which is "target*", for ``COPYLEFT_RECIPE_TYPES`` |
1261 | is set by the ```copyleft_filter`` <#ref-classes-copyleft_filter>`__ | 1261 | is set by the :ref:`copyleft_filter <ref-classes-copyleft_filter>` |
1262 | class, which is inherited by the ``archiver`` class. | 1262 | class, which is inherited by the ``archiver`` class. |
1263 | 1263 | ||
1264 | COPY_LIC_DIRS | 1264 | COPY_LIC_DIRS |
1265 | If set to "1" along with the | 1265 | If set to "1" along with the |
1266 | ```COPY_LIC_MANIFEST`` <#var-COPY_LIC_MANIFEST>`__ variable, the | 1266 | :term:`COPY_LIC_MANIFEST` variable, the |
1267 | OpenEmbedded build system copies into the image the license files, | 1267 | OpenEmbedded build system copies into the image the license files, |
1268 | which are located in ``/usr/share/common-licenses``, for each | 1268 | which are located in ``/usr/share/common-licenses``, for each |
1269 | package. The license files are placed in directories within the image | 1269 | package. The license files are placed in directories within the image |
@@ -1304,7 +1304,7 @@ system and gives an overview of their function and contents. | |||
1304 | CORE_IMAGE_EXTRA_INSTALL | 1304 | CORE_IMAGE_EXTRA_INSTALL |
1305 | Specifies the list of packages to be added to the image. You should | 1305 | Specifies the list of packages to be added to the image. You should |
1306 | only set this variable in the ``local.conf`` configuration file found | 1306 | only set this variable in the ``local.conf`` configuration file found |
1307 | in the `Build Directory <#build-directory>`__. | 1307 | in the :term:`Build Directory`. |
1308 | 1308 | ||
1309 | This variable replaces ``POKY_EXTRA_INSTALL``, which is no longer | 1309 | This variable replaces ``POKY_EXTRA_INSTALL``, which is no longer |
1310 | supported. | 1310 | supported. |
@@ -1321,7 +1321,7 @@ system and gives an overview of their function and contents. | |||
1321 | the ``poky/meta`` layer. | 1321 | the ``poky/meta`` layer. |
1322 | 1322 | ||
1323 | COREBASE_FILES | 1323 | COREBASE_FILES |
1324 | Lists files from the ```COREBASE`` <#var-COREBASE>`__ directory that | 1324 | Lists files from the :term:`COREBASE` directory that |
1325 | should be copied other than the layers listed in the | 1325 | should be copied other than the layers listed in the |
1326 | ``bblayers.conf`` file. The ``COREBASE_FILES`` variable exists for | 1326 | ``bblayers.conf`` file. The ``COREBASE_FILES`` variable exists for |
1327 | the purpose of copying metadata from the OpenEmbedded build system | 1327 | the purpose of copying metadata from the OpenEmbedded build system |
@@ -1345,19 +1345,19 @@ system and gives an overview of their function and contents. | |||
1345 | Default initialization for ``CPPFLAGS`` varies depending on what is | 1345 | Default initialization for ``CPPFLAGS`` varies depending on what is |
1346 | being built: | 1346 | being built: |
1347 | 1347 | ||
1348 | - ```TARGET_CPPFLAGS`` <#var-TARGET_CPPFLAGS>`__ when building for | 1348 | - :term:`TARGET_CPPFLAGS` when building for |
1349 | the target | 1349 | the target |
1350 | 1350 | ||
1351 | - ```BUILD_CPPFLAGS`` <#var-BUILD_CPPFLAGS>`__ when building for the | 1351 | - :term:`BUILD_CPPFLAGS` when building for the |
1352 | build host (i.e. ``-native``) | 1352 | build host (i.e. ``-native``) |
1353 | 1353 | ||
1354 | - ```BUILDSDK_CPPFLAGS`` <#var-BUILDSDK_CPPFLAGS>`__ when building | 1354 | - :term:`BUILDSDK_CPPFLAGS` when building |
1355 | for an SDK (i.e. ``nativesdk-``) | 1355 | for an SDK (i.e. ``nativesdk-``) |
1356 | 1356 | ||
1357 | CROSS_COMPILE | 1357 | CROSS_COMPILE |
1358 | The toolchain binary prefix for the target tools. The | 1358 | The toolchain binary prefix for the target tools. The |
1359 | ``CROSS_COMPILE`` variable is the same as the | 1359 | ``CROSS_COMPILE`` variable is the same as the |
1360 | ```TARGET_PREFIX`` <#var-TARGET_PREFIX>`__ variable. | 1360 | :term:`TARGET_PREFIX` variable. |
1361 | 1361 | ||
1362 | .. note:: | 1362 | .. note:: |
1363 | 1363 | ||
@@ -1381,19 +1381,19 @@ system and gives an overview of their function and contents. | |||
1381 | Default initialization for ``CXXFLAGS`` varies depending on what is | 1381 | Default initialization for ``CXXFLAGS`` varies depending on what is |
1382 | being built: | 1382 | being built: |
1383 | 1383 | ||
1384 | - ```TARGET_CXXFLAGS`` <#var-TARGET_CXXFLAGS>`__ when building for | 1384 | - :term:`TARGET_CXXFLAGS` when building for |
1385 | the target | 1385 | the target |
1386 | 1386 | ||
1387 | - ```BUILD_CXXFLAGS`` <#var-BUILD_CXXFLAGS>`__ when building for the | 1387 | - :term:`BUILD_CXXFLAGS` when building for the |
1388 | build host (i.e. ``-native``) | 1388 | build host (i.e. ``-native``) |
1389 | 1389 | ||
1390 | - ```BUILDSDK_CXXFLAGS`` <#var-BUILDSDK_CXXFLAGS>`__ when building | 1390 | - :term:`BUILDSDK_CXXFLAGS` when building |
1391 | for an SDK (i.e. ``nativesdk-``) | 1391 | for an SDK (i.e. ``nativesdk-``) |
1392 | 1392 | ||
1393 | D | 1393 | D |
1394 | The destination directory. The location in the `Build | 1394 | The destination directory. The location in the `Build |
1395 | Directory <#build-directory>`__ where components are installed by the | 1395 | Directory <#build-directory>`__ where components are installed by the |
1396 | ```do_install`` <#ref-tasks-install>`__ task. This location defaults | 1396 | :ref:`ref-tasks-install` task. This location defaults |
1397 | to: ${WORKDIR}/image | 1397 | to: ${WORKDIR}/image |
1398 | 1398 | ||
1399 | .. note:: | 1399 | .. note:: |
@@ -1411,7 +1411,7 @@ system and gives an overview of their function and contents. | |||
1411 | suitable for timestamps. | 1411 | suitable for timestamps. |
1412 | 1412 | ||
1413 | DEBIAN_NOAUTONAME | 1413 | DEBIAN_NOAUTONAME |
1414 | When the ```debian`` <#ref-classes-debian>`__ class is inherited, | 1414 | When the :ref:`debian <ref-classes-debian>` class is inherited, |
1415 | which is the default behavior, ``DEBIAN_NOAUTONAME`` specifies a | 1415 | which is the default behavior, ``DEBIAN_NOAUTONAME`` specifies a |
1416 | particular package should not be renamed according to Debian library | 1416 | particular package should not be renamed according to Debian library |
1417 | package naming. You must use the package name as an override when you | 1417 | package naming. You must use the package name as an override when you |
@@ -1419,7 +1419,7 @@ system and gives an overview of their function and contents. | |||
1419 | DEBIAN_NOAUTONAME_fontconfig-utils = "1" | 1419 | DEBIAN_NOAUTONAME_fontconfig-utils = "1" |
1420 | 1420 | ||
1421 | DEBIANNAME | 1421 | DEBIANNAME |
1422 | When the ```debian`` <#ref-classes-debian>`__ class is inherited, | 1422 | When the :ref:`debian <ref-classes-debian>` class is inherited, |
1423 | which is the default behavior, ``DEBIANNAME`` allows you to override | 1423 | which is the default behavior, ``DEBIANNAME`` allows you to override |
1424 | the library name for an individual package. Overriding the library | 1424 | the library name for an individual package. Overriding the library |
1425 | name in these cases is rare. You must use the package name as an | 1425 | name in these cases is rare. You must use the package name as an |
@@ -1457,12 +1457,12 @@ system and gives an overview of their function and contents. | |||
1457 | The default CPU and Application Binary Interface (ABI) tunings (i.e. | 1457 | The default CPU and Application Binary Interface (ABI) tunings (i.e. |
1458 | the "tune") used by the OpenEmbedded build system. The | 1458 | the "tune") used by the OpenEmbedded build system. The |
1459 | ``DEFAULTTUNE`` helps define | 1459 | ``DEFAULTTUNE`` helps define |
1460 | ```TUNE_FEATURES`` <#var-TUNE_FEATURES>`__. | 1460 | :term:`TUNE_FEATURES`. |
1461 | 1461 | ||
1462 | The default tune is either implicitly or explicitly set by the | 1462 | The default tune is either implicitly or explicitly set by the |
1463 | machine (```MACHINE`` <#var-MACHINE>`__). However, you can override | 1463 | machine (:term:`MACHINE`). However, you can override |
1464 | the setting using available tunes as defined with | 1464 | the setting using available tunes as defined with |
1465 | ```AVAILTUNES`` <#var-AVAILTUNES>`__. | 1465 | :term:`AVAILTUNES`. |
1466 | 1466 | ||
1467 | DEPENDS | 1467 | DEPENDS |
1468 | Lists a recipe's build-time dependencies. These are dependencies on | 1468 | Lists a recipe's build-time dependencies. These are dependencies on |
@@ -1474,12 +1474,12 @@ system and gives an overview of their function and contents. | |||
1474 | assignment is that all files installed by bar will be available in | 1474 | assignment is that all files installed by bar will be available in |
1475 | the appropriate staging sysroot, given by the | 1475 | the appropriate staging sysroot, given by the |
1476 | ```STAGING_DIR*`` <#var-STAGING_DIR>`__ variables, by the time the | 1476 | ```STAGING_DIR*`` <#var-STAGING_DIR>`__ variables, by the time the |
1477 | ```do_configure`` <#ref-tasks-configure>`__ task for ``foo`` runs. | 1477 | :ref:`ref-tasks-configure` task for ``foo`` runs. |
1478 | This mechanism is implemented by having ``do_configure`` depend on | 1478 | This mechanism is implemented by having ``do_configure`` depend on |
1479 | the ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task of | 1479 | the :ref:`ref-tasks-populate_sysroot` task of |
1480 | each recipe listed in ``DEPENDS``, through a | 1480 | each recipe listed in ``DEPENDS``, through a |
1481 | ``[``\ ```deptask`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` | 1481 | ``[``\ ```deptask`` <&YOCTO_DOCS_BB_URL;#variable-flags>`__\ ``]`` |
1482 | declaration in the ```base`` <#ref-classes-base>`__ class. | 1482 | declaration in the :ref:`base <ref-classes-base>` class. |
1483 | 1483 | ||
1484 | .. note:: | 1484 | .. note:: |
1485 | 1485 | ||
@@ -1492,13 +1492,13 @@ system and gives an overview of their function and contents. | |||
1492 | that run on the build machine during the build. For example, a recipe | 1492 | that run on the build machine during the build. For example, a recipe |
1493 | that makes use of a code generator built by the recipe ``codegen`` | 1493 | that makes use of a code generator built by the recipe ``codegen`` |
1494 | might have the following: DEPENDS = "codegen-native" For more | 1494 | might have the following: DEPENDS = "codegen-native" For more |
1495 | information, see the ```native`` <#ref-classes-native>`__ class and | 1495 | information, see the :ref:`native <ref-classes-native>` class and |
1496 | the ```EXTRANATIVEPATH`` <#var-EXTRANATIVEPATH>`__ variable. | 1496 | the :term:`EXTRANATIVEPATH` variable. |
1497 | 1497 | ||
1498 | .. note:: | 1498 | .. note:: |
1499 | 1499 | ||
1500 | - ``DEPENDS`` is a list of recipe names. Or, to be more precise, | 1500 | - ``DEPENDS`` is a list of recipe names. Or, to be more precise, |
1501 | it is a list of ```PROVIDES`` <#var-PROVIDES>`__ names, which | 1501 | it is a list of :term:`PROVIDES` names, which |
1502 | usually match recipe names. Putting a package name such as | 1502 | usually match recipe names. Putting a package name such as |
1503 | "foo-dev" in ``DEPENDS`` does not make sense. Use "foo" | 1503 | "foo-dev" in ``DEPENDS`` does not make sense. Use "foo" |
1504 | instead, as this will put files from all the packages that make | 1504 | instead, as this will put files from all the packages that make |
@@ -1524,7 +1524,7 @@ system and gives an overview of their function and contents. | |||
1524 | fail to link against ``libfoo``. | 1524 | fail to link against ``libfoo``. |
1525 | 1525 | ||
1526 | For information on runtime dependencies, see the | 1526 | For information on runtime dependencies, see the |
1527 | ```RDEPENDS`` <#var-RDEPENDS>`__ variable. You can also see the | 1527 | :term:`RDEPENDS` variable. You can also see the |
1528 | "`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and | 1528 | "`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and |
1529 | "`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the | 1529 | "`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the |
1530 | BitBake User Manual for additional information on tasks and | 1530 | BitBake User Manual for additional information on tasks and |
@@ -1534,7 +1534,7 @@ system and gives an overview of their function and contents. | |||
1534 | Points to the general area that the OpenEmbedded build system uses to | 1534 | Points to the general area that the OpenEmbedded build system uses to |
1535 | place images, packages, SDKs, and other output files that are ready | 1535 | place images, packages, SDKs, and other output files that are ready |
1536 | to be used outside of the build system. By default, this directory | 1536 | to be used outside of the build system. By default, this directory |
1537 | resides within the `Build Directory <#build-directory>`__ as | 1537 | resides within the :term:`Build Directory` as |
1538 | ``${TMPDIR}/deploy``. | 1538 | ``${TMPDIR}/deploy``. |
1539 | 1539 | ||
1540 | For more information on the structure of the Build Directory, see | 1540 | For more information on the structure of the Build Directory, see |
@@ -1550,17 +1550,17 @@ system and gives an overview of their function and contents. | |||
1550 | Points to the area that the OpenEmbedded build system uses to place | 1550 | Points to the area that the OpenEmbedded build system uses to place |
1551 | Debian packages that are ready to be used outside of the build | 1551 | Debian packages that are ready to be used outside of the build |
1552 | system. This variable applies only when | 1552 | system. This variable applies only when |
1553 | ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ contains | 1553 | :term:`PACKAGE_CLASSES` contains |
1554 | "package_deb". | 1554 | "package_deb". |
1555 | 1555 | ||
1556 | The BitBake configuration file initially defines the | 1556 | The BitBake configuration file initially defines the |
1557 | ``DEPLOY_DIR_DEB`` variable as a sub-folder of | 1557 | ``DEPLOY_DIR_DEB`` variable as a sub-folder of |
1558 | ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__: DEPLOY_DIR_DEB = | 1558 | :term:`DEPLOY_DIR`: DEPLOY_DIR_DEB = |
1559 | "${DEPLOY_DIR}/deb" | 1559 | "${DEPLOY_DIR}/deb" |
1560 | 1560 | ||
1561 | The ```package_deb`` <#ref-classes-package_deb>`__ class uses the | 1561 | The :ref:`package_deb <ref-classes-package_deb>` class uses the |
1562 | ``DEPLOY_DIR_DEB`` variable to make sure the | 1562 | ``DEPLOY_DIR_DEB`` variable to make sure the |
1563 | ```do_package_write_deb`` <#ref-tasks-package_write_deb>`__ task | 1563 | :ref:`ref-tasks-package_write_deb` task |
1564 | writes Debian packages into the appropriate folder. For more | 1564 | writes Debian packages into the appropriate folder. For more |
1565 | information on how packaging works, see the "`Package | 1565 | information on how packaging works, see the "`Package |
1566 | Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section | 1566 | Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section |
@@ -1571,7 +1571,7 @@ system and gives an overview of their function and contents. | |||
1571 | images and other associated output files that are ready to be | 1571 | images and other associated output files that are ready to be |
1572 | deployed onto the target machine. The directory is machine-specific | 1572 | deployed onto the target machine. The directory is machine-specific |
1573 | as it contains the ``${MACHINE}`` name. By default, this directory | 1573 | as it contains the ``${MACHINE}`` name. By default, this directory |
1574 | resides within the `Build Directory <#build-directory>`__ as | 1574 | resides within the :term:`Build Directory` as |
1575 | ``${DEPLOY_DIR}/images/${MACHINE}/``. | 1575 | ``${DEPLOY_DIR}/images/${MACHINE}/``. |
1576 | 1576 | ||
1577 | For more information on the structure of the Build Directory, see | 1577 | For more information on the structure of the Build Directory, see |
@@ -1586,16 +1586,16 @@ system and gives an overview of their function and contents. | |||
1586 | Points to the area that the OpenEmbedded build system uses to place | 1586 | Points to the area that the OpenEmbedded build system uses to place |
1587 | IPK packages that are ready to be used outside of the build system. | 1587 | IPK packages that are ready to be used outside of the build system. |
1588 | This variable applies only when | 1588 | This variable applies only when |
1589 | ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ contains | 1589 | :term:`PACKAGE_CLASSES` contains |
1590 | "package_ipk". | 1590 | "package_ipk". |
1591 | 1591 | ||
1592 | The BitBake configuration file initially defines this variable as a | 1592 | The BitBake configuration file initially defines this variable as a |
1593 | sub-folder of ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__: DEPLOY_DIR_IPK = | 1593 | sub-folder of :term:`DEPLOY_DIR`: DEPLOY_DIR_IPK = |
1594 | "${DEPLOY_DIR}/ipk" | 1594 | "${DEPLOY_DIR}/ipk" |
1595 | 1595 | ||
1596 | The ```package_ipk`` <#ref-classes-package_ipk>`__ class uses the | 1596 | The :ref:`package_ipk <ref-classes-package_ipk>` class uses the |
1597 | ``DEPLOY_DIR_IPK`` variable to make sure the | 1597 | ``DEPLOY_DIR_IPK`` variable to make sure the |
1598 | ```do_package_write_ipk`` <#ref-tasks-package_write_ipk>`__ task | 1598 | :ref:`ref-tasks-package_write_ipk` task |
1599 | writes IPK packages into the appropriate folder. For more information | 1599 | writes IPK packages into the appropriate folder. For more information |
1600 | on how packaging works, see the "`Package | 1600 | on how packaging works, see the "`Package |
1601 | Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section | 1601 | Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section |
@@ -1605,16 +1605,16 @@ system and gives an overview of their function and contents. | |||
1605 | Points to the area that the OpenEmbedded build system uses to place | 1605 | Points to the area that the OpenEmbedded build system uses to place |
1606 | RPM packages that are ready to be used outside of the build system. | 1606 | RPM packages that are ready to be used outside of the build system. |
1607 | This variable applies only when | 1607 | This variable applies only when |
1608 | ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ contains | 1608 | :term:`PACKAGE_CLASSES` contains |
1609 | "package_rpm". | 1609 | "package_rpm". |
1610 | 1610 | ||
1611 | The BitBake configuration file initially defines this variable as a | 1611 | The BitBake configuration file initially defines this variable as a |
1612 | sub-folder of ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__: DEPLOY_DIR_RPM = | 1612 | sub-folder of :term:`DEPLOY_DIR`: DEPLOY_DIR_RPM = |
1613 | "${DEPLOY_DIR}/rpm" | 1613 | "${DEPLOY_DIR}/rpm" |
1614 | 1614 | ||
1615 | The ```package_rpm`` <#ref-classes-package_rpm>`__ class uses the | 1615 | The :ref:`package_rpm <ref-classes-package_rpm>` class uses the |
1616 | ``DEPLOY_DIR_RPM`` variable to make sure the | 1616 | ``DEPLOY_DIR_RPM`` variable to make sure the |
1617 | ```do_package_write_rpm`` <#ref-tasks-package_write_rpm>`__ task | 1617 | :ref:`ref-tasks-package_write_rpm` task |
1618 | writes RPM packages into the appropriate folder. For more information | 1618 | writes RPM packages into the appropriate folder. For more information |
1619 | on how packaging works, see the "`Package | 1619 | on how packaging works, see the "`Package |
1620 | Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section | 1620 | Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section |
@@ -1624,40 +1624,40 @@ system and gives an overview of their function and contents. | |||
1624 | Points to the area that the OpenEmbedded build system uses to place | 1624 | Points to the area that the OpenEmbedded build system uses to place |
1625 | tarballs that are ready to be used outside of the build system. This | 1625 | tarballs that are ready to be used outside of the build system. This |
1626 | variable applies only when | 1626 | variable applies only when |
1627 | ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ contains | 1627 | :term:`PACKAGE_CLASSES` contains |
1628 | "package_tar". | 1628 | "package_tar". |
1629 | 1629 | ||
1630 | The BitBake configuration file initially defines this variable as a | 1630 | The BitBake configuration file initially defines this variable as a |
1631 | sub-folder of ```DEPLOY_DIR`` <#var-DEPLOY_DIR>`__: DEPLOY_DIR_TAR = | 1631 | sub-folder of :term:`DEPLOY_DIR`: DEPLOY_DIR_TAR = |
1632 | "${DEPLOY_DIR}/tar" | 1632 | "${DEPLOY_DIR}/tar" |
1633 | 1633 | ||
1634 | The ```package_tar`` <#ref-classes-package_tar>`__ class uses the | 1634 | The :ref:`package_tar <ref-classes-package_tar>` class uses the |
1635 | ``DEPLOY_DIR_TAR`` variable to make sure the | 1635 | ``DEPLOY_DIR_TAR`` variable to make sure the |
1636 | ```do_package_write_tar`` <#ref-tasks-package_write_tar>`__ task | 1636 | :ref:`ref-tasks-package_write_tar` task |
1637 | writes TAR packages into the appropriate folder. For more information | 1637 | writes TAR packages into the appropriate folder. For more information |
1638 | on how packaging works, see the "`Package | 1638 | on how packaging works, see the "`Package |
1639 | Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section | 1639 | Feeds <&YOCTO_DOCS_OM_URL;#package-feeds-dev-environment>`__" section |
1640 | in the Yocto Project Overview and Concepts Manual. | 1640 | in the Yocto Project Overview and Concepts Manual. |
1641 | 1641 | ||
1642 | DEPLOYDIR | 1642 | DEPLOYDIR |
1643 | When inheriting the ```deploy`` <#ref-classes-deploy>`__ class, the | 1643 | When inheriting the :ref:`deploy <ref-classes-deploy>` class, the |
1644 | ``DEPLOYDIR`` points to a temporary work area for deployed files that | 1644 | ``DEPLOYDIR`` points to a temporary work area for deployed files that |
1645 | is set in the ``deploy`` class as follows: DEPLOYDIR = | 1645 | is set in the ``deploy`` class as follows: DEPLOYDIR = |
1646 | "${WORKDIR}/deploy-${```PN`` <#var-PN>`__}" | 1646 | "${WORKDIR}/deploy-${:term:`PN`}" |
1647 | 1647 | ||
1648 | Recipes inheriting the ``deploy`` class should copy files to be | 1648 | Recipes inheriting the ``deploy`` class should copy files to be |
1649 | deployed into ``DEPLOYDIR``, and the class will take care of copying | 1649 | deployed into ``DEPLOYDIR``, and the class will take care of copying |
1650 | them into ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__ | 1650 | them into :term:`DEPLOY_DIR_IMAGE` |
1651 | afterwards. | 1651 | afterwards. |
1652 | 1652 | ||
1653 | DESCRIPTION | 1653 | DESCRIPTION |
1654 | The package description used by package managers. If not set, | 1654 | The package description used by package managers. If not set, |
1655 | ``DESCRIPTION`` takes the value of the ```SUMMARY`` <#var-SUMMARY>`__ | 1655 | ``DESCRIPTION`` takes the value of the :term:`SUMMARY` |
1656 | variable. | 1656 | variable. |
1657 | 1657 | ||
1658 | DISTRO | 1658 | DISTRO |
1659 | The short name of the distribution. For information on the long name | 1659 | The short name of the distribution. For information on the long name |
1660 | of the distribution, see the ```DISTRO_NAME`` <#var-DISTRO_NAME>`__ | 1660 | of the distribution, see the :term:`DISTRO_NAME` |
1661 | variable. | 1661 | variable. |
1662 | 1662 | ||
1663 | The ``DISTRO`` variable corresponds to a distribution configuration | 1663 | The ``DISTRO`` variable corresponds to a distribution configuration |
@@ -1671,7 +1671,7 @@ system and gives an overview of their function and contents. | |||
1671 | follows: DISTRO = "poky" | 1671 | follows: DISTRO = "poky" |
1672 | 1672 | ||
1673 | Distribution configuration files are located in a ``conf/distro`` | 1673 | Distribution configuration files are located in a ``conf/distro`` |
1674 | directory within the `Metadata <#metadata>`__ that contains the | 1674 | directory within the :term:`Metadata` that contains the |
1675 | distribution configuration. The value for ``DISTRO`` must not contain | 1675 | distribution configuration. The value for ``DISTRO`` must not contain |
1676 | spaces, and is typically all lower-case. | 1676 | spaces, and is typically all lower-case. |
1677 | 1677 | ||
@@ -1709,7 +1709,7 @@ system and gives an overview of their function and contents. | |||
1709 | In most cases, the presence or absence of a feature in | 1709 | In most cases, the presence or absence of a feature in |
1710 | ``DISTRO_FEATURES`` is translated to the appropriate option supplied | 1710 | ``DISTRO_FEATURES`` is translated to the appropriate option supplied |
1711 | to the configure script during the | 1711 | to the configure script during the |
1712 | ```do_configure`` <#ref-tasks-configure>`__ task for recipes that | 1712 | :ref:`ref-tasks-configure` task for recipes that |
1713 | optionally support the feature. For example, specifying "x11" in | 1713 | optionally support the feature. For example, specifying "x11" in |
1714 | ``DISTRO_FEATURES``, causes every piece of software built for the | 1714 | ``DISTRO_FEATURES``, causes every piece of software built for the |
1715 | target that can optionally support X11 to have its X11 support | 1715 | target that can optionally support X11 to have its X11 support |
@@ -1744,59 +1744,59 @@ system and gives an overview of their function and contents. | |||
1744 | 1744 | ||
1745 | When creating a custom distribution, you might find it useful to be | 1745 | When creating a custom distribution, you might find it useful to be |
1746 | able to reuse the default | 1746 | able to reuse the default |
1747 | ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ options without the | 1747 | :term:`DISTRO_FEATURES` options without the |
1748 | need to write out the full set. Here is an example that uses | 1748 | need to write out the full set. Here is an example that uses |
1749 | ``DISTRO_FEATURES_DEFAULT`` from a custom distro configuration file: | 1749 | ``DISTRO_FEATURES_DEFAULT`` from a custom distro configuration file: |
1750 | DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} myfeature" | 1750 | DISTRO_FEATURES ?= "${DISTRO_FEATURES_DEFAULT} myfeature" |
1751 | 1751 | ||
1752 | DISTRO_FEATURES_FILTER_NATIVE | 1752 | DISTRO_FEATURES_FILTER_NATIVE |
1753 | Specifies a list of features that if present in the target | 1753 | Specifies a list of features that if present in the target |
1754 | ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ value should be | 1754 | :term:`DISTRO_FEATURES` value should be |
1755 | included in ``DISTRO_FEATURES`` when building native recipes. This | 1755 | included in ``DISTRO_FEATURES`` when building native recipes. This |
1756 | variable is used in addition to the features filtered using the | 1756 | variable is used in addition to the features filtered using the |
1757 | ```DISTRO_FEATURES_NATIVE`` <#var-DISTRO_FEATURES_NATIVE>`__ | 1757 | :term:`DISTRO_FEATURES_NATIVE` |
1758 | variable. | 1758 | variable. |
1759 | 1759 | ||
1760 | DISTRO_FEATURES_FILTER_NATIVESDK | 1760 | DISTRO_FEATURES_FILTER_NATIVESDK |
1761 | Specifies a list of features that if present in the target | 1761 | Specifies a list of features that if present in the target |
1762 | ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ value should be | 1762 | :term:`DISTRO_FEATURES` value should be |
1763 | included in ``DISTRO_FEATURES`` when building nativesdk recipes. This | 1763 | included in ``DISTRO_FEATURES`` when building nativesdk recipes. This |
1764 | variable is used in addition to the features filtered using the | 1764 | variable is used in addition to the features filtered using the |
1765 | ```DISTRO_FEATURES_NATIVESDK`` <#var-DISTRO_FEATURES_NATIVESDK>`__ | 1765 | :term:`DISTRO_FEATURES_NATIVESDK` |
1766 | variable. | 1766 | variable. |
1767 | 1767 | ||
1768 | DISTRO_FEATURES_NATIVE | 1768 | DISTRO_FEATURES_NATIVE |
1769 | Specifies a list of features that should be included in | 1769 | Specifies a list of features that should be included in |
1770 | ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ when building native | 1770 | :term:`DISTRO_FEATURES` when building native |
1771 | recipes. This variable is used in addition to the features filtered | 1771 | recipes. This variable is used in addition to the features filtered |
1772 | using the | 1772 | using the |
1773 | ```DISTRO_FEATURES_FILTER_NATIVE`` <#var-DISTRO_FEATURES_FILTER_NATIVE>`__ | 1773 | :term:`DISTRO_FEATURES_FILTER_NATIVE` |
1774 | variable. | 1774 | variable. |
1775 | 1775 | ||
1776 | DISTRO_FEATURES_NATIVESDK | 1776 | DISTRO_FEATURES_NATIVESDK |
1777 | Specifies a list of features that should be included in | 1777 | Specifies a list of features that should be included in |
1778 | ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__ when building | 1778 | :term:`DISTRO_FEATURES` when building |
1779 | nativesdk recipes. This variable is used in addition to the features | 1779 | nativesdk recipes. This variable is used in addition to the features |
1780 | filtered using the | 1780 | filtered using the |
1781 | ```DISTRO_FEATURES_FILTER_NATIVESDK`` <#var-DISTRO_FEATURES_FILTER_NATIVESDK>`__ | 1781 | :term:`DISTRO_FEATURES_FILTER_NATIVESDK` |
1782 | variable. | 1782 | variable. |
1783 | 1783 | ||
1784 | DISTRO_NAME | 1784 | DISTRO_NAME |
1785 | The long name of the distribution. For information on the short name | 1785 | The long name of the distribution. For information on the short name |
1786 | of the distribution, see the ```DISTRO`` <#var-DISTRO>`__ variable. | 1786 | of the distribution, see the :term:`DISTRO` variable. |
1787 | 1787 | ||
1788 | The ``DISTRO_NAME`` variable corresponds to a distribution | 1788 | The ``DISTRO_NAME`` variable corresponds to a distribution |
1789 | configuration file whose root name is the same as the variable's | 1789 | configuration file whose root name is the same as the variable's |
1790 | argument and whose filename extension is ``.conf``. For example, the | 1790 | argument and whose filename extension is ``.conf``. For example, the |
1791 | distribution configuration file for the Poky distribution is named | 1791 | distribution configuration file for the Poky distribution is named |
1792 | ``poky.conf`` and resides in the ``meta-poky/conf/distro`` directory | 1792 | ``poky.conf`` and resides in the ``meta-poky/conf/distro`` directory |
1793 | of the `Source Directory <#source-directory>`__. | 1793 | of the :term:`Source Directory`. |
1794 | 1794 | ||
1795 | Within that ``poky.conf`` file, the ``DISTRO_NAME`` variable is set | 1795 | Within that ``poky.conf`` file, the ``DISTRO_NAME`` variable is set |
1796 | as follows: DISTRO_NAME = "Poky (Yocto Project Reference Distro)" | 1796 | as follows: DISTRO_NAME = "Poky (Yocto Project Reference Distro)" |
1797 | 1797 | ||
1798 | Distribution configuration files are located in a ``conf/distro`` | 1798 | Distribution configuration files are located in a ``conf/distro`` |
1799 | directory within the `Metadata <#metadata>`__ that contains the | 1799 | directory within the :term:`Metadata` that contains the |
1800 | distribution configuration. | 1800 | distribution configuration. |
1801 | 1801 | ||
1802 | .. note:: | 1802 | .. note:: |
@@ -1814,27 +1814,27 @@ system and gives an overview of their function and contents. | |||
1814 | DISTROOVERRIDES | 1814 | DISTROOVERRIDES |
1815 | A colon-separated list of overrides specific to the current | 1815 | A colon-separated list of overrides specific to the current |
1816 | distribution. By default, this list includes the value of | 1816 | distribution. By default, this list includes the value of |
1817 | ```DISTRO`` <#var-DISTRO>`__. | 1817 | :term:`DISTRO`. |
1818 | 1818 | ||
1819 | You can extend ``DISTROOVERRIDES`` to add extra overrides that should | 1819 | You can extend ``DISTROOVERRIDES`` to add extra overrides that should |
1820 | apply to the distribution. | 1820 | apply to the distribution. |
1821 | 1821 | ||
1822 | The underlying mechanism behind ``DISTROOVERRIDES`` is simply that it | 1822 | The underlying mechanism behind ``DISTROOVERRIDES`` is simply that it |
1823 | is included in the default value of | 1823 | is included in the default value of |
1824 | ```OVERRIDES`` <#var-OVERRIDES>`__. | 1824 | :term:`OVERRIDES`. |
1825 | 1825 | ||
1826 | DL_DIR | 1826 | DL_DIR |
1827 | The central download directory used by the build process to store | 1827 | The central download directory used by the build process to store |
1828 | downloads. By default, ``DL_DIR`` gets files suitable for mirroring | 1828 | downloads. By default, ``DL_DIR`` gets files suitable for mirroring |
1829 | for everything except Git repositories. If you want tarballs of Git | 1829 | for everything except Git repositories. If you want tarballs of Git |
1830 | repositories, use the | 1830 | repositories, use the |
1831 | ```BB_GENERATE_MIRROR_TARBALLS`` <#var-BB_GENERATE_MIRROR_TARBALLS>`__ | 1831 | :term:`BB_GENERATE_MIRROR_TARBALLS` |
1832 | variable. | 1832 | variable. |
1833 | 1833 | ||
1834 | You can set this directory by defining the ``DL_DIR`` variable in the | 1834 | You can set this directory by defining the ``DL_DIR`` variable in the |
1835 | ``conf/local.conf`` file. This directory is self-maintaining and you | 1835 | ``conf/local.conf`` file. This directory is self-maintaining and you |
1836 | should not have to touch it. By default, the directory is | 1836 | should not have to touch it. By default, the directory is |
1837 | ``downloads`` in the `Build Directory <#build-directory>`__. #DL_DIR | 1837 | ``downloads`` in the :term:`Build Directory`. #DL_DIR |
1838 | ?= "${TOPDIR}/downloads" To specify a different download directory, | 1838 | ?= "${TOPDIR}/downloads" To specify a different download directory, |
1839 | simply remove the comment from the line and provide your directory. | 1839 | simply remove the comment from the line and provide your directory. |
1840 | 1840 | ||
@@ -1859,7 +1859,7 @@ system and gives an overview of their function and contents. | |||
1859 | page. | 1859 | page. |
1860 | 1860 | ||
1861 | DOC_COMPRESS | 1861 | DOC_COMPRESS |
1862 | When inheriting the ```compress_doc`` <#ref-classes-compress_doc>`__ | 1862 | When inheriting the :ref:`compress_doc <ref-classes-compress_doc>` |
1863 | class, this variable sets the compression policy used when the | 1863 | class, this variable sets the compression policy used when the |
1864 | OpenEmbedded build system compresses man pages and info pages. By | 1864 | OpenEmbedded build system compresses man pages and info pages. By |
1865 | default, the compression method used is gz (gzip). Other policies | 1865 | default, the compression method used is gz (gzip). Other policies |
@@ -1870,12 +1870,12 @@ system and gives an overview of their function and contents. | |||
1870 | 1870 | ||
1871 | EFI_PROVIDER | 1871 | EFI_PROVIDER |
1872 | When building bootable images (i.e. where ``hddimg``, ``iso``, or | 1872 | When building bootable images (i.e. where ``hddimg``, ``iso``, or |
1873 | ``wic.vmdk`` is in ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__), the | 1873 | ``wic.vmdk`` is in :term:`IMAGE_FSTYPES`), the |
1874 | ``EFI_PROVIDER`` variable specifies the EFI bootloader to use. The | 1874 | ``EFI_PROVIDER`` variable specifies the EFI bootloader to use. The |
1875 | default is "grub-efi", but "systemd-boot" can be used instead. | 1875 | default is "grub-efi", but "systemd-boot" can be used instead. |
1876 | 1876 | ||
1877 | See the ```systemd-boot`` <#ref-classes-systemd-boot>`__ and | 1877 | See the :ref:`systemd-boot <ref-classes-systemd-boot>` and |
1878 | ```image-live`` <#ref-classes-image-live>`__ classes for more | 1878 | :ref:`image-live <ref-classes-image-live>` classes for more |
1879 | information. | 1879 | information. |
1880 | 1880 | ||
1881 | ENABLE_BINARY_LOCALE_GENERATION | 1881 | ENABLE_BINARY_LOCALE_GENERATION |
@@ -1884,13 +1884,13 @@ system and gives an overview of their function and contents. | |||
1884 | less). | 1884 | less). |
1885 | 1885 | ||
1886 | ERR_REPORT_DIR | 1886 | ERR_REPORT_DIR |
1887 | When used with the ```report-error`` <#ref-classes-report-error>`__ | 1887 | When used with the :ref:`report-error <ref-classes-report-error>` |
1888 | class, specifies the path used for storing the debug files created by | 1888 | class, specifies the path used for storing the debug files created by |
1889 | the `error reporting | 1889 | the `error reporting |
1890 | tool <&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool>`__, which | 1890 | tool <&YOCTO_DOCS_DEV_URL;#using-the-error-reporting-tool>`__, which |
1891 | allows you to submit build errors you encounter to a central | 1891 | allows you to submit build errors you encounter to a central |
1892 | database. By default, the value of this variable is | 1892 | database. By default, the value of this variable is |
1893 | ``${``\ ```LOG_DIR`` <#var-LOG_DIR>`__\ ``}/error-report``. | 1893 | ``${``\ :term:`LOG_DIR`\ ``}/error-report``. |
1894 | 1894 | ||
1895 | You can set ``ERR_REPORT_DIR`` to the path you want the error | 1895 | You can set ``ERR_REPORT_DIR`` to the path you want the error |
1896 | reporting tool to store the debug files as follows in your | 1896 | reporting tool to store the debug files as follows in your |
@@ -1901,7 +1901,7 @@ system and gives an overview of their function and contents. | |||
1901 | errors by the OpenEmbedded build system. You set this variable in | 1901 | errors by the OpenEmbedded build system. You set this variable in |
1902 | your distribution configuration file. For a list of the checks you | 1902 | your distribution configuration file. For a list of the checks you |
1903 | can control with this variable, see the | 1903 | can control with this variable, see the |
1904 | "```insane.bbclass`` <#ref-classes-insane>`__" section. | 1904 | ":ref:`insane.bbclass <ref-classes-insane>`" section. |
1905 | 1905 | ||
1906 | EXCLUDE_FROM_SHLIBS | 1906 | EXCLUDE_FROM_SHLIBS |
1907 | Triggers the OpenEmbedded build system's shared libraries resolver to | 1907 | Triggers the OpenEmbedded build system's shared libraries resolver to |
@@ -1918,7 +1918,7 @@ system and gives an overview of their function and contents. | |||
1918 | implicitly define some dependencies between packages. | 1918 | implicitly define some dependencies between packages. |
1919 | 1919 | ||
1920 | The ``EXCLUDE_FROM_SHLIBS`` variable is similar to the | 1920 | The ``EXCLUDE_FROM_SHLIBS`` variable is similar to the |
1921 | ```PRIVATE_LIBS`` <#var-PRIVATE_LIBS>`__ variable, which excludes a | 1921 | :term:`PRIVATE_LIBS` variable, which excludes a |
1922 | package's particular libraries only and not the whole package. | 1922 | package's particular libraries only and not the whole package. |
1923 | 1923 | ||
1924 | Use the ``EXCLUDE_FROM_SHLIBS`` variable by setting it to "1" for a | 1924 | Use the ``EXCLUDE_FROM_SHLIBS`` variable by setting it to "1" for a |
@@ -1945,13 +1945,13 @@ system and gives an overview of their function and contents. | |||
1945 | 1945 | ||
1946 | EXTENDPE | 1946 | EXTENDPE |
1947 | Used with file and pathnames to create a prefix for a recipe's | 1947 | Used with file and pathnames to create a prefix for a recipe's |
1948 | version based on the recipe's ```PE`` <#var-PE>`__ value. If ``PE`` | 1948 | version based on the recipe's :term:`PE` value. If ``PE`` |
1949 | is set and greater than zero for a recipe, ``EXTENDPE`` becomes that | 1949 | is set and greater than zero for a recipe, ``EXTENDPE`` becomes that |
1950 | value (e.g if ``PE`` is equal to "1" then ``EXTENDPE`` becomes "1_"). | 1950 | value (e.g if ``PE`` is equal to "1" then ``EXTENDPE`` becomes "1_"). |
1951 | If a recipe's ``PE`` is not set (the default) or is equal to zero, | 1951 | If a recipe's ``PE`` is not set (the default) or is equal to zero, |
1952 | ``EXTENDPE`` becomes "". | 1952 | ``EXTENDPE`` becomes "". |
1953 | 1953 | ||
1954 | See the ```STAMP`` <#var-STAMP>`__ variable for an example. | 1954 | See the :term:`STAMP` variable for an example. |
1955 | 1955 | ||
1956 | EXTENDPKGV | 1956 | EXTENDPKGV |
1957 | The full package version specification as it appears on the final | 1957 | The full package version specification as it appears on the final |
@@ -1971,43 +1971,43 @@ system and gives an overview of their function and contents. | |||
1971 | any externally installed tools. Setting the ``EXTERNAL_KERNEL_TOOLS`` | 1971 | any externally installed tools. Setting the ``EXTERNAL_KERNEL_TOOLS`` |
1972 | variable tells the OpenEmbedded build system to prefer the installed | 1972 | variable tells the OpenEmbedded build system to prefer the installed |
1973 | external tools. See the | 1973 | external tools. See the |
1974 | ```kernel-yocto`` <#ref-classes-kernel-yocto>`__ class in | 1974 | :ref:`kernel-yocto <ref-classes-kernel-yocto>` class in |
1975 | ``meta/classes`` to see how the variable is used. | 1975 | ``meta/classes`` to see how the variable is used. |
1976 | 1976 | ||
1977 | EXTERNALSRC | 1977 | EXTERNALSRC |
1978 | When inheriting the ```externalsrc`` <#ref-classes-externalsrc>`__ | 1978 | When inheriting the :ref:`externalsrc <ref-classes-externalsrc>` |
1979 | class, this variable points to the source tree, which is outside of | 1979 | class, this variable points to the source tree, which is outside of |
1980 | the OpenEmbedded build system. When set, this variable sets the | 1980 | the OpenEmbedded build system. When set, this variable sets the |
1981 | ```S`` <#var-S>`__ variable, which is what the OpenEmbedded build | 1981 | :term:`S` variable, which is what the OpenEmbedded build |
1982 | system uses to locate unpacked recipe source code. | 1982 | system uses to locate unpacked recipe source code. |
1983 | 1983 | ||
1984 | For more information on ``externalsrc.bbclass``, see the | 1984 | For more information on ``externalsrc.bbclass``, see the |
1985 | "```externalsrc.bbclass`` <#ref-classes-externalsrc>`__" section. You | 1985 | ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You |
1986 | can also find information on how to use this variable in the | 1986 | can also find information on how to use this variable in the |
1987 | "`Building Software from an External | 1987 | "`Building Software from an External |
1988 | Source <&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source>`__" | 1988 | Source <&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source>`__" |
1989 | section in the Yocto Project Development Tasks Manual. | 1989 | section in the Yocto Project Development Tasks Manual. |
1990 | 1990 | ||
1991 | EXTERNALSRC_BUILD | 1991 | EXTERNALSRC_BUILD |
1992 | When inheriting the ```externalsrc`` <#ref-classes-externalsrc>`__ | 1992 | When inheriting the :ref:`externalsrc <ref-classes-externalsrc>` |
1993 | class, this variable points to the directory in which the recipe's | 1993 | class, this variable points to the directory in which the recipe's |
1994 | source code is built, which is outside of the OpenEmbedded build | 1994 | source code is built, which is outside of the OpenEmbedded build |
1995 | system. When set, this variable sets the ```B`` <#var-B>`__ variable, | 1995 | system. When set, this variable sets the :term:`B` variable, |
1996 | which is what the OpenEmbedded build system uses to locate the Build | 1996 | which is what the OpenEmbedded build system uses to locate the Build |
1997 | Directory. | 1997 | Directory. |
1998 | 1998 | ||
1999 | For more information on ``externalsrc.bbclass``, see the | 1999 | For more information on ``externalsrc.bbclass``, see the |
2000 | "```externalsrc.bbclass`` <#ref-classes-externalsrc>`__" section. You | 2000 | ":ref:`externalsrc.bbclass <ref-classes-externalsrc>`" section. You |
2001 | can also find information on how to use this variable in the | 2001 | can also find information on how to use this variable in the |
2002 | "`Building Software from an External | 2002 | "`Building Software from an External |
2003 | Source <&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source>`__" | 2003 | Source <&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source>`__" |
2004 | section in the Yocto Project Development Tasks Manual. | 2004 | section in the Yocto Project Development Tasks Manual. |
2005 | 2005 | ||
2006 | EXTRA_AUTORECONF | 2006 | EXTRA_AUTORECONF |
2007 | For recipes inheriting the ```autotools`` <#ref-classes-autotools>`__ | 2007 | For recipes inheriting the :ref:`autotools <ref-classes-autotools>` |
2008 | class, you can use ``EXTRA_AUTORECONF`` to specify extra options to | 2008 | class, you can use ``EXTRA_AUTORECONF`` to specify extra options to |
2009 | pass to the ``autoreconf`` command that is executed during the | 2009 | pass to the ``autoreconf`` command that is executed during the |
2010 | ```do_configure`` <#ref-tasks-configure>`__ task. | 2010 | :ref:`ref-tasks-configure` task. |
2011 | 2011 | ||
2012 | The default value is "--exclude=autopoint". | 2012 | The default value is "--exclude=autopoint". |
2013 | 2013 | ||
@@ -2016,7 +2016,7 @@ system and gives an overview of their function and contents. | |||
2016 | more than one feature, separate them with a space. | 2016 | more than one feature, separate them with a space. |
2017 | 2017 | ||
2018 | Typically, you configure this variable in your ``local.conf`` file, | 2018 | Typically, you configure this variable in your ``local.conf`` file, |
2019 | which is found in the `Build Directory <#build-directory>`__. | 2019 | which is found in the :term:`Build Directory`. |
2020 | Although you can use this variable from within a recipe, best | 2020 | Although you can use this variable from within a recipe, best |
2021 | practices dictate that you do not. | 2021 | practices dictate that you do not. |
2022 | 2022 | ||
@@ -2055,7 +2055,7 @@ system and gives an overview of their function and contents. | |||
2055 | 2055 | ||
2056 | EXTRA_IMAGECMD | 2056 | EXTRA_IMAGECMD |
2057 | Specifies additional options for the image creation command that has | 2057 | Specifies additional options for the image creation command that has |
2058 | been specified in ```IMAGE_CMD`` <#var-IMAGE_CMD>`__. When setting | 2058 | been specified in :term:`IMAGE_CMD`. When setting |
2059 | this variable, use an override for the associated image type. Here is | 2059 | this variable, use an override for the associated image type. Here is |
2060 | an example: EXTRA_IMAGECMD_ext3 ?= "-i 4096" | 2060 | an example: EXTRA_IMAGECMD_ext3 ?= "-i 4096" |
2061 | 2061 | ||
@@ -2080,7 +2080,7 @@ system and gives an overview of their function and contents. | |||
2080 | 2080 | ||
2081 | EXTRANATIVEPATH | 2081 | EXTRANATIVEPATH |
2082 | A list of subdirectories of | 2082 | A list of subdirectories of |
2083 | ``${``\ ```STAGING_BINDIR_NATIVE`` <#var-STAGING_BINDIR_NATIVE>`__\ ``}`` | 2083 | ``${``\ :term:`STAGING_BINDIR_NATIVE`\ ``}`` |
2084 | added to the beginning of the environment variable ``PATH``. As an | 2084 | added to the beginning of the environment variable ``PATH``. As an |
2085 | example, the following prepends | 2085 | example, the following prepends |
2086 | "${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" to | 2086 | "${STAGING_BINDIR_NATIVE}/foo:${STAGING_BINDIR_NATIVE}/bar:" to |
@@ -2088,11 +2088,11 @@ system and gives an overview of their function and contents. | |||
2088 | 2088 | ||
2089 | EXTRA_OECMAKE | 2089 | EXTRA_OECMAKE |
2090 | Additional `CMake <https://cmake.org/overview/>`__ options. See the | 2090 | Additional `CMake <https://cmake.org/overview/>`__ options. See the |
2091 | ```cmake`` <#ref-classes-cmake>`__ class for additional information. | 2091 | :ref:`cmake <ref-classes-cmake>` class for additional information. |
2092 | 2092 | ||
2093 | EXTRA_OECONF | 2093 | EXTRA_OECONF |
2094 | Additional ``configure`` script options. See | 2094 | Additional ``configure`` script options. See |
2095 | ```PACKAGECONFIG_CONFARGS`` <#var-PACKAGECONFIG_CONFARGS>`__ for | 2095 | :term:`PACKAGECONFIG_CONFARGS` for |
2096 | additional information on passing configure script options. | 2096 | additional information on passing configure script options. |
2097 | 2097 | ||
2098 | EXTRA_OEMAKE | 2098 | EXTRA_OEMAKE |
@@ -2101,21 +2101,21 @@ system and gives an overview of their function and contents. | |||
2101 | Because the ``EXTRA_OEMAKE`` defaults to "", you need to set the | 2101 | Because the ``EXTRA_OEMAKE`` defaults to "", you need to set the |
2102 | variable to specify any required GNU options. | 2102 | variable to specify any required GNU options. |
2103 | 2103 | ||
2104 | ```PARALLEL_MAKE`` <#var-PARALLEL_MAKE>`__ and | 2104 | :term:`PARALLEL_MAKE` and |
2105 | ```PARALLEL_MAKEINST`` <#var-PARALLEL_MAKEINST>`__ also make use of | 2105 | :term:`PARALLEL_MAKEINST` also make use of |
2106 | ``EXTRA_OEMAKE`` to pass the required flags. | 2106 | ``EXTRA_OEMAKE`` to pass the required flags. |
2107 | 2107 | ||
2108 | EXTRA_OESCONS | 2108 | EXTRA_OESCONS |
2109 | When inheriting the ```scons`` <#ref-classes-scons>`__ class, this | 2109 | When inheriting the :ref:`scons <ref-classes-scons>` class, this |
2110 | variable specifies additional configuration options you want to pass | 2110 | variable specifies additional configuration options you want to pass |
2111 | to the ``scons`` command line. | 2111 | to the ``scons`` command line. |
2112 | 2112 | ||
2113 | EXTRA_USERS_PARAMS | 2113 | EXTRA_USERS_PARAMS |
2114 | When inheriting the ```extrausers`` <#ref-classes-extrausers>`__ | 2114 | When inheriting the :ref:`extrausers <ref-classes-extrausers>` |
2115 | class, this variable provides image level user and group operations. | 2115 | class, this variable provides image level user and group operations. |
2116 | This is a more global method of providing user and group | 2116 | This is a more global method of providing user and group |
2117 | configuration as compared to using the | 2117 | configuration as compared to using the |
2118 | ```useradd`` <#ref-classes-useradd>`__ class, which ties user and | 2118 | :ref:`useradd <ref-classes-useradd>` class, which ties user and |
2119 | group configurations to a specific recipe. | 2119 | group configurations to a specific recipe. |
2120 | 2120 | ||
2121 | The set list of commands you can configure using the | 2121 | The set list of commands you can configure using the |
@@ -2127,7 +2127,7 @@ system and gives an overview of their function and contents. | |||
2127 | 2127 | ||
2128 | FEATURE_PACKAGES | 2128 | FEATURE_PACKAGES |
2129 | Defines one or more packages to include in an image when a specific | 2129 | Defines one or more packages to include in an image when a specific |
2130 | item is included in ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__. | 2130 | item is included in :term:`IMAGE_FEATURES`. |
2131 | When setting the value, ``FEATURE_PACKAGES`` should have the name of | 2131 | When setting the value, ``FEATURE_PACKAGES`` should have the name of |
2132 | the feature item as an override. Here is an example: | 2132 | the feature item as an override. Here is an example: |
2133 | FEATURE_PACKAGES_widget = "package1 package2" | 2133 | FEATURE_PACKAGES_widget = "package1 package2" |
@@ -2161,7 +2161,7 @@ system and gives an overview of their function and contents. | |||
2161 | 2161 | ||
2162 | FILES | 2162 | FILES |
2163 | The list of files and directories that are placed in a package. The | 2163 | The list of files and directories that are placed in a package. The |
2164 | ```PACKAGES`` <#var-PACKAGES>`__ variable lists the packages | 2164 | :term:`PACKAGES` variable lists the packages |
2165 | generated by a recipe. | 2165 | generated by a recipe. |
2166 | 2166 | ||
2167 | To use the ``FILES`` variable, provide a package name override that | 2167 | To use the ``FILES`` variable, provide a package name override that |
@@ -2183,7 +2183,7 @@ system and gives an overview of their function and contents. | |||
2183 | use ``${sysconfdir}`` rather than ``/etc``, or ``${bindir}`` | 2183 | use ``${sysconfdir}`` rather than ``/etc``, or ``${bindir}`` |
2184 | rather than ``/usr/bin``. You can find a list of these | 2184 | rather than ``/usr/bin``. You can find a list of these |
2185 | variables at the top of the ``meta/conf/bitbake.conf`` file in | 2185 | variables at the top of the ``meta/conf/bitbake.conf`` file in |
2186 | the `Source Directory <#source-directory>`__. You will also | 2186 | the :term:`Source Directory`. You will also |
2187 | find the default values of the various ``FILES_*`` variables in | 2187 | find the default values of the various ``FILES_*`` variables in |
2188 | this file. | 2188 | this file. |
2189 | 2189 | ||
@@ -2191,12 +2191,12 @@ system and gives an overview of their function and contents. | |||
2191 | editable and you know they should not be overwritten during the | 2191 | editable and you know they should not be overwritten during the |
2192 | package update process by the Package Management System (PMS), you | 2192 | package update process by the Package Management System (PMS), you |
2193 | can identify these files so that the PMS will not overwrite them. See | 2193 | can identify these files so that the PMS will not overwrite them. See |
2194 | the ```CONFFILES`` <#var-CONFFILES>`__ variable for information on | 2194 | the :term:`CONFFILES` variable for information on |
2195 | how to identify these files to the PMS. | 2195 | how to identify these files to the PMS. |
2196 | 2196 | ||
2197 | FILES_SOLIBSDEV | 2197 | FILES_SOLIBSDEV |
2198 | Defines the file specification to match | 2198 | Defines the file specification to match |
2199 | ```SOLIBSDEV`` <#var-SOLIBSDEV>`__. In other words, | 2199 | :term:`SOLIBSDEV`. In other words, |
2200 | ``FILES_SOLIBSDEV`` defines the full path name of the development | 2200 | ``FILES_SOLIBSDEV`` defines the full path name of the development |
2201 | symbolic link (symlink) for shared libraries on the target platform. | 2201 | symbolic link (symlink) for shared libraries on the target platform. |
2202 | 2202 | ||
@@ -2208,7 +2208,7 @@ system and gives an overview of their function and contents. | |||
2208 | Extends the search path the OpenEmbedded build system uses when | 2208 | Extends the search path the OpenEmbedded build system uses when |
2209 | looking for files and patches as it processes recipes and append | 2209 | looking for files and patches as it processes recipes and append |
2210 | files. The default directories BitBake uses when it processes recipes | 2210 | files. The default directories BitBake uses when it processes recipes |
2211 | are initially defined by the ```FILESPATH`` <#var-FILESPATH>`__ | 2211 | are initially defined by the :term:`FILESPATH` |
2212 | variable. You can extend ``FILESPATH`` variable by using | 2212 | variable. You can extend ``FILESPATH`` variable by using |
2213 | ``FILESEXTRAPATHS``. | 2213 | ``FILESEXTRAPATHS``. |
2214 | 2214 | ||
@@ -2223,7 +2223,7 @@ system and gives an overview of their function and contents. | |||
2223 | 2223 | ||
2224 | When extending ``FILESEXTRAPATHS``, be sure to use the immediate | 2224 | When extending ``FILESEXTRAPATHS``, be sure to use the immediate |
2225 | expansion (``:=``) operator. Immediate expansion makes sure that | 2225 | expansion (``:=``) operator. Immediate expansion makes sure that |
2226 | BitBake evaluates ```THISDIR`` <#var-THISDIR>`__ at the time the | 2226 | BitBake evaluates :term:`THISDIR` at the time the |
2227 | directive is encountered rather than at some later time when | 2227 | directive is encountered rather than at some later time when |
2228 | expansion might result in a directory that does not contain the | 2228 | expansion might result in a directory that does not contain the |
2229 | files you need. | 2229 | files you need. |
@@ -2242,14 +2242,14 @@ system and gives an overview of their function and contents. | |||
2242 | FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" | 2242 | FILESEXTRAPATHS_prepend := "path_1:path_2:path_3:" |
2243 | 2243 | ||
2244 | A final example shows how you can extend the search path and include | 2244 | A final example shows how you can extend the search path and include |
2245 | a ```MACHINE`` <#var-MACHINE>`__-specific override, which is useful | 2245 | a :term:`MACHINE`-specific override, which is useful |
2246 | in a BSP layer: FILESEXTRAPATHS_prepend_intel-x86-common := | 2246 | in a BSP layer: FILESEXTRAPATHS_prepend_intel-x86-common := |
2247 | "${THISDIR}/${PN}:" The previous statement appears in the | 2247 | "${THISDIR}/${PN}:" The previous statement appears in the |
2248 | ``linux-yocto-dev.bbappend`` file, which is found in the Yocto | 2248 | ``linux-yocto-dev.bbappend`` file, which is found in the Yocto |
2249 | Project `Source | 2249 | Project `Source |
2250 | Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ in | 2250 | Repositories <&YOCTO_DOCS_OM_URL;#source-repositories>`__ in |
2251 | ``meta-intel/common/recipes-kernel/linux``. Here, the machine | 2251 | ``meta-intel/common/recipes-kernel/linux``. Here, the machine |
2252 | override is a special ```PACKAGE_ARCH`` <#var-PACKAGE_ARCH>`__ | 2252 | override is a special :term:`PACKAGE_ARCH` |
2253 | definition for multiple ``meta-intel`` machines. | 2253 | definition for multiple ``meta-intel`` machines. |
2254 | 2254 | ||
2255 | .. note:: | 2255 | .. note:: |
@@ -2264,12 +2264,12 @@ system and gives an overview of their function and contents. | |||
2264 | recipe to correctly extend the path. | 2264 | recipe to correctly extend the path. |
2265 | 2265 | ||
2266 | FILESOVERRIDES | 2266 | FILESOVERRIDES |
2267 | A subset of ```OVERRIDES`` <#var-OVERRIDES>`__ used by the | 2267 | A subset of :term:`OVERRIDES` used by the |
2268 | OpenEmbedded build system for creating | 2268 | OpenEmbedded build system for creating |
2269 | ```FILESPATH`` <#var-FILESPATH>`__. The ``FILESOVERRIDES`` variable | 2269 | :term:`FILESPATH`. The ``FILESOVERRIDES`` variable |
2270 | uses overrides to automatically extend the | 2270 | uses overrides to automatically extend the |
2271 | ```FILESPATH`` <#var-FILESPATH>`__ variable. For an example of how | 2271 | :term:`FILESPATH` variable. For an example of how |
2272 | that works, see the ```FILESPATH`` <#var-FILESPATH>`__ variable | 2272 | that works, see the :term:`FILESPATH` variable |
2273 | description. Additionally, you find more information on how overrides | 2273 | description. Additionally, you find more information on how overrides |
2274 | are handled in the "`Conditional Syntax | 2274 | are handled in the "`Conditional Syntax |
2275 | (Overrides) <&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides>`__" | 2275 | (Overrides) <&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides>`__" |
@@ -2293,7 +2293,7 @@ system and gives an overview of their function and contents. | |||
2293 | During the build process, BitBake searches each directory in | 2293 | During the build process, BitBake searches each directory in |
2294 | ``FILESPATH`` in the specified order when looking for files and | 2294 | ``FILESPATH`` in the specified order when looking for files and |
2295 | patches specified by each ``file://`` URI in a recipe's | 2295 | patches specified by each ``file://`` URI in a recipe's |
2296 | ```SRC_URI`` <#var-SRC_URI>`__ statements. | 2296 | :term:`SRC_URI` statements. |
2297 | 2297 | ||
2298 | The default value for the ``FILESPATH`` variable is defined in the | 2298 | The default value for the ``FILESPATH`` variable is defined in the |
2299 | ``base.bbclass`` class found in ``meta/classes`` in the `Source | 2299 | ``base.bbclass`` class found in ``meta/classes`` in the `Source |
@@ -2301,14 +2301,14 @@ system and gives an overview of their function and contents. | |||
2301 | "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \\ | 2301 | "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \\ |
2302 | "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" The | 2302 | "${FILE_DIRNAME}/${BPN}", "${FILE_DIRNAME}/files"], d)}" The |
2303 | ``FILESPATH`` variable is automatically extended using the overrides | 2303 | ``FILESPATH`` variable is automatically extended using the overrides |
2304 | from the ```FILESOVERRIDES`` <#var-FILESOVERRIDES>`__ variable. | 2304 | from the :term:`FILESOVERRIDES` variable. |
2305 | 2305 | ||
2306 | .. note:: | 2306 | .. note:: |
2307 | 2307 | ||
2308 | - Do not hand-edit the ``FILESPATH`` variable. If you want the | 2308 | - Do not hand-edit the ``FILESPATH`` variable. If you want the |
2309 | build system to look in directories other than the defaults, | 2309 | build system to look in directories other than the defaults, |
2310 | extend the ``FILESPATH`` variable by using the | 2310 | extend the ``FILESPATH`` variable by using the |
2311 | ```FILESEXTRAPATHS`` <#var-FILESEXTRAPATHS>`__ variable. | 2311 | :term:`FILESEXTRAPATHS` variable. |
2312 | 2312 | ||
2313 | - Be aware that the default ``FILESPATH`` directories do not map | 2313 | - Be aware that the default ``FILESPATH`` directories do not map |
2314 | to directories in custom layers where append files | 2314 | to directories in custom layers where append files |
@@ -2323,7 +2323,7 @@ system and gives an overview of their function and contents. | |||
2323 | files/defconfig files/MACHINEA/defconfig files/MACHINEB/defconfig | 2323 | files/defconfig files/MACHINEA/defconfig files/MACHINEB/defconfig |
2324 | Also in the example, the ``SRC_URI`` statement contains | 2324 | Also in the example, the ``SRC_URI`` statement contains |
2325 | "file://defconfig". Given this scenario, you can set | 2325 | "file://defconfig". Given this scenario, you can set |
2326 | ```MACHINE`` <#var-MACHINE>`__ to "MACHINEA" and cause the build | 2326 | :term:`MACHINE` to "MACHINEA" and cause the build |
2327 | system to use files from ``files/MACHINEA``. Set ``MACHINE`` to | 2327 | system to use files from ``files/MACHINEA``. Set ``MACHINE`` to |
2328 | "MACHINEB" and the build system uses files from ``files/MACHINEB``. | 2328 | "MACHINEB" and the build system uses files from ``files/MACHINEB``. |
2329 | Finally, for any machine other than "MACHINEA" and "MACHINEB", the | 2329 | Finally, for any machine other than "MACHINEA" and "MACHINEB", the |
@@ -2334,7 +2334,7 @@ system and gives an overview of their function and contents. | |||
2334 | in the Yocto Project Overview and Concepts Manual and the "`Patching | 2334 | in the Yocto Project Overview and Concepts Manual and the "`Patching |
2335 | Code <&YOCTO_DOCS_DEV_URL;#new-recipe-patching-code>`__" section in | 2335 | Code <&YOCTO_DOCS_DEV_URL;#new-recipe-patching-code>`__" section in |
2336 | the Yocto Project Development Tasks Manual. See the | 2336 | the Yocto Project Development Tasks Manual. See the |
2337 | ```do_patch`` <#ref-tasks-patch>`__ task as well. | 2337 | :ref:`ref-tasks-patch` task as well. |
2338 | 2338 | ||
2339 | FILESYSTEM_PERMS_TABLES | 2339 | FILESYSTEM_PERMS_TABLES |
2340 | Allows you to define your own file permissions settings table as part | 2340 | Allows you to define your own file permissions settings table as part |
@@ -2354,7 +2354,7 @@ system and gives an overview of their function and contents. | |||
2354 | Directory <#build-directory>`__, to point to your custom | 2354 | Directory <#build-directory>`__, to point to your custom |
2355 | ``fs-perms.txt``. You can specify more than a single file permissions | 2355 | ``fs-perms.txt``. You can specify more than a single file permissions |
2356 | setting table. The paths you specify to these files must be defined | 2356 | setting table. The paths you specify to these files must be defined |
2357 | within the ```BBPATH`` <#var-BBPATH>`__ variable. | 2357 | within the :term:`BBPATH` variable. |
2358 | 2358 | ||
2359 | For guidance on how to create your own file permissions settings | 2359 | For guidance on how to create your own file permissions settings |
2360 | table file, examine the existing ``fs-perms.txt``. | 2360 | table file, examine the existing ``fs-perms.txt``. |
@@ -2367,16 +2367,16 @@ system and gives an overview of their function and contents. | |||
2367 | For e.g. rsa2048. | 2367 | For e.g. rsa2048. |
2368 | 2368 | ||
2369 | FONT_EXTRA_RDEPENDS | 2369 | FONT_EXTRA_RDEPENDS |
2370 | When inheriting the ```fontcache`` <#ref-classes-fontcache>`__ class, | 2370 | When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, |
2371 | this variable specifies the runtime dependencies for font packages. | 2371 | this variable specifies the runtime dependencies for font packages. |
2372 | By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils". | 2372 | By default, the ``FONT_EXTRA_RDEPENDS`` is set to "fontconfig-utils". |
2373 | 2373 | ||
2374 | FONT_PACKAGES | 2374 | FONT_PACKAGES |
2375 | When inheriting the ```fontcache`` <#ref-classes-fontcache>`__ class, | 2375 | When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, |
2376 | this variable identifies packages containing font files that need to | 2376 | this variable identifies packages containing font files that need to |
2377 | be cached by Fontconfig. By default, the ``fontcache`` class assumes | 2377 | be cached by Fontconfig. By default, the ``fontcache`` class assumes |
2378 | that fonts are in the recipe's main package (i.e. | 2378 | that fonts are in the recipe's main package (i.e. |
2379 | ``${``\ ```PN`` <#var-PN>`__\ ``}``). Use this variable if fonts you | 2379 | ``${``\ :term:`PN`\ ``}``). Use this variable if fonts you |
2380 | need are in a package other than that main package. | 2380 | need are in a package other than that main package. |
2381 | 2381 | ||
2382 | FORCE_RO_REMOVE | 2382 | FORCE_RO_REMOVE |
@@ -2429,7 +2429,7 @@ system and gives an overview of their function and contents. | |||
2429 | "en_GB.UTF-8 en_US.UTF-8" | 2429 | "en_GB.UTF-8 en_US.UTF-8" |
2430 | 2430 | ||
2431 | GROUPADD_PARAM | 2431 | GROUPADD_PARAM |
2432 | When inheriting the ```useradd`` <#ref-classes-useradd>`__ class, | 2432 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, |
2433 | this variable specifies for a package what parameters should be | 2433 | this variable specifies for a package what parameters should be |
2434 | passed to the ``groupadd`` command if you wish to add a group to the | 2434 | passed to the ``groupadd`` command if you wish to add a group to the |
2435 | system when the package is installed. | 2435 | system when the package is installed. |
@@ -2439,7 +2439,7 @@ system and gives an overview of their function and contents. | |||
2439 | ``groupadd``, see ` <http://linux.die.net/man/8/groupadd>`__. | 2439 | ``groupadd``, see ` <http://linux.die.net/man/8/groupadd>`__. |
2440 | 2440 | ||
2441 | GROUPMEMS_PARAM | 2441 | GROUPMEMS_PARAM |
2442 | When inheriting the ```useradd`` <#ref-classes-useradd>`__ class, | 2442 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, |
2443 | this variable specifies for a package what parameters should be | 2443 | this variable specifies for a package what parameters should be |
2444 | passed to the ``groupmems`` command if you wish to modify the members | 2444 | passed to the ``groupmems`` command if you wish to modify the members |
2445 | of a group when the package is installed. | 2445 | of a group when the package is installed. |
@@ -2453,7 +2453,7 @@ system and gives an overview of their function and contents. | |||
2453 | ``local.conf`` or distribution configuration file to enable graphics | 2453 | ``local.conf`` or distribution configuration file to enable graphics |
2454 | and serial in the menu. | 2454 | and serial in the menu. |
2455 | 2455 | ||
2456 | See the ```grub-efi`` <#ref-classes-grub-efi>`__ class for more | 2456 | See the :ref:`grub-efi <ref-classes-grub-efi>` class for more |
2457 | information on how this variable is used. | 2457 | information on how this variable is used. |
2458 | 2458 | ||
2459 | GRUB_OPTS | 2459 | GRUB_OPTS |
@@ -2462,7 +2462,7 @@ system and gives an overview of their function and contents. | |||
2462 | multiple options. | 2462 | multiple options. |
2463 | 2463 | ||
2464 | The ``GRUB_OPTS`` variable is optional. See the | 2464 | The ``GRUB_OPTS`` variable is optional. See the |
2465 | ```grub-efi`` <#ref-classes-grub-efi>`__ class for more information | 2465 | :ref:`grub-efi <ref-classes-grub-efi>` class for more information |
2466 | on how this variable is used. | 2466 | on how this variable is used. |
2467 | 2467 | ||
2468 | GRUB_TIMEOUT | 2468 | GRUB_TIMEOUT |
@@ -2470,12 +2470,12 @@ system and gives an overview of their function and contents. | |||
2470 | GNU GRand Unified Bootloader (GRUB). | 2470 | GNU GRand Unified Bootloader (GRUB). |
2471 | 2471 | ||
2472 | The ``GRUB_TIMEOUT`` variable is optional. See the | 2472 | The ``GRUB_TIMEOUT`` variable is optional. See the |
2473 | ```grub-efi`` <#ref-classes-grub-efi>`__ class for more information | 2473 | :ref:`grub-efi <ref-classes-grub-efi>` class for more information |
2474 | on how this variable is used. | 2474 | on how this variable is used. |
2475 | 2475 | ||
2476 | GTKIMMODULES_PACKAGES | 2476 | GTKIMMODULES_PACKAGES |
2477 | When inheriting the | 2477 | When inheriting the |
2478 | ```gtk-immodules-cache`` <#ref-classes-gtk-immodules-cache>`__ class, | 2478 | :ref:`gtk-immodules-cache <ref-classes-gtk-immodules-cache>` class, |
2479 | this variable specifies the packages that contain the GTK+ input | 2479 | this variable specifies the packages that contain the GTK+ input |
2480 | method modules being installed when the modules are in packages other | 2480 | method modules being installed when the modules are in packages other |
2481 | than the main package. | 2481 | than the main package. |
@@ -2486,7 +2486,7 @@ system and gives an overview of their function and contents. | |||
2486 | 2486 | ||
2487 | HOST_ARCH | 2487 | HOST_ARCH |
2488 | The name of the target architecture, which is normally the same as | 2488 | The name of the target architecture, which is normally the same as |
2489 | ```TARGET_ARCH`` <#var-TARGET_ARCH>`__. The OpenEmbedded build system | 2489 | :term:`TARGET_ARCH`. The OpenEmbedded build system |
2490 | supports many architectures. Here is an example list of architectures | 2490 | supports many architectures. Here is an example list of architectures |
2491 | supported. This list is by no means complete as the architecture is | 2491 | supported. This list is by no means complete as the architecture is |
2492 | configurable: arm i586 x86_64 powerpc powerpc64 mips mipsel | 2492 | configurable: arm i586 x86_64 powerpc powerpc64 mips mipsel |
@@ -2498,7 +2498,7 @@ system and gives an overview of their function and contents. | |||
2498 | Default initialization for ``HOST_CC_ARCH`` varies depending on what | 2498 | Default initialization for ``HOST_CC_ARCH`` varies depending on what |
2499 | is being built: | 2499 | is being built: |
2500 | 2500 | ||
2501 | - ```TARGET_CC_ARCH`` <#var-TARGET_CC_ARCH>`__ when building for the | 2501 | - :term:`TARGET_CC_ARCH` when building for the |
2502 | target | 2502 | target |
2503 | 2503 | ||
2504 | - ``BUILD_CC_ARCH`` when building for the build host (i.e. | 2504 | - ``BUILD_CC_ARCH`` when building for the build host (i.e. |
@@ -2509,14 +2509,14 @@ system and gives an overview of their function and contents. | |||
2509 | 2509 | ||
2510 | HOST_OS | 2510 | HOST_OS |
2511 | Specifies the name of the target operating system, which is normally | 2511 | Specifies the name of the target operating system, which is normally |
2512 | the same as the ```TARGET_OS`` <#var-TARGET_OS>`__. The variable can | 2512 | the same as the :term:`TARGET_OS`. The variable can |
2513 | be set to "linux" for ``glibc``-based systems and to "linux-musl" for | 2513 | be set to "linux" for ``glibc``-based systems and to "linux-musl" for |
2514 | ``musl``. For ARM/EABI targets, there are also "linux-gnueabi" and | 2514 | ``musl``. For ARM/EABI targets, there are also "linux-gnueabi" and |
2515 | "linux-musleabi" values possible. | 2515 | "linux-musleabi" values possible. |
2516 | 2516 | ||
2517 | HOST_PREFIX | 2517 | HOST_PREFIX |
2518 | Specifies the prefix for the cross-compile toolchain. ``HOST_PREFIX`` | 2518 | Specifies the prefix for the cross-compile toolchain. ``HOST_PREFIX`` |
2519 | is normally the same as ```TARGET_PREFIX`` <#var-TARGET_PREFIX>`__. | 2519 | is normally the same as :term:`TARGET_PREFIX`. |
2520 | 2520 | ||
2521 | HOST_SYS | 2521 | HOST_SYS |
2522 | Specifies the system, including the architecture and the operating | 2522 | Specifies the system, including the architecture and the operating |
@@ -2524,9 +2524,9 @@ system and gives an overview of their function and contents. | |||
2524 | current recipe. | 2524 | current recipe. |
2525 | 2525 | ||
2526 | The OpenEmbedded build system automatically sets this variable based | 2526 | The OpenEmbedded build system automatically sets this variable based |
2527 | on ```HOST_ARCH`` <#var-HOST_ARCH>`__, | 2527 | on :term:`HOST_ARCH`, |
2528 | ```HOST_VENDOR`` <#var-HOST_VENDOR>`__, and | 2528 | :term:`HOST_VENDOR`, and |
2529 | ```HOST_OS`` <#var-HOST_OS>`__ variables. | 2529 | :term:`HOST_OS` variables. |
2530 | 2530 | ||
2531 | .. note:: | 2531 | .. note:: |
2532 | 2532 | ||
@@ -2549,25 +2549,25 @@ system and gives an overview of their function and contents. | |||
2549 | is not started. | 2549 | is not started. |
2550 | 2550 | ||
2551 | For additional information, see | 2551 | For additional information, see |
2552 | ```HOSTTOOLS_NONFATAL`` <#var-HOSTTOOLS_NONFATAL>`__. | 2552 | :term:`HOSTTOOLS_NONFATAL`. |
2553 | 2553 | ||
2554 | HOSTTOOLS_NONFATAL | 2554 | HOSTTOOLS_NONFATAL |
2555 | A space-separated list (filter) of tools on the build host that | 2555 | A space-separated list (filter) of tools on the build host that |
2556 | should be allowed to be called from within build tasks. Using this | 2556 | should be allowed to be called from within build tasks. Using this |
2557 | filter helps reduce the possibility of host contamination. Unlike | 2557 | filter helps reduce the possibility of host contamination. Unlike |
2558 | ```HOSTTOOLS`` <#var-HOSTTOOLS>`__, the OpenEmbedded build system | 2558 | :term:`HOSTTOOLS`, the OpenEmbedded build system |
2559 | does not produce an error if a tool specified in the value of | 2559 | does not produce an error if a tool specified in the value of |
2560 | ``HOSTTOOLS_NONFATAL`` is not found on the build host. Thus, you can | 2560 | ``HOSTTOOLS_NONFATAL`` is not found on the build host. Thus, you can |
2561 | use ``HOSTTOOLS_NONFATAL`` to filter optional host tools. | 2561 | use ``HOSTTOOLS_NONFATAL`` to filter optional host tools. |
2562 | 2562 | ||
2563 | HOST_VENDOR | 2563 | HOST_VENDOR |
2564 | Specifies the name of the vendor. ``HOST_VENDOR`` is normally the | 2564 | Specifies the name of the vendor. ``HOST_VENDOR`` is normally the |
2565 | same as ```TARGET_VENDOR`` <#var-TARGET_VENDOR>`__. | 2565 | same as :term:`TARGET_VENDOR`. |
2566 | 2566 | ||
2567 | ICECC_DISABLED | 2567 | ICECC_DISABLED |
2568 | Disables or enables the ``icecc`` (Icecream) function. For more | 2568 | Disables or enables the ``icecc`` (Icecream) function. For more |
2569 | information on this function and best practices for using this | 2569 | information on this function and best practices for using this |
2570 | variable, see the "```icecc.bbclass`` <#ref-classes-icecc>`__" | 2570 | variable, see the ":ref:`icecc.bbclass <ref-classes-icecc>`" |
2571 | section. | 2571 | section. |
2572 | 2572 | ||
2573 | Setting this variable to "1" in your ``local.conf`` disables the | 2573 | Setting this variable to "1" in your ``local.conf`` disables the |
@@ -2576,7 +2576,7 @@ system and gives an overview of their function and contents. | |||
2576 | 2576 | ||
2577 | ICECC_ENV_EXEC | 2577 | ICECC_ENV_EXEC |
2578 | Points to the ``icecc-create-env`` script that you provide. This | 2578 | Points to the ``icecc-create-env`` script that you provide. This |
2579 | variable is used by the ```icecc`` <#ref-classes-icecc>`__ class. You | 2579 | variable is used by the :ref:`icecc <ref-classes-icecc>` class. You |
2580 | set this variable in your ``local.conf`` file. | 2580 | set this variable in your ``local.conf`` file. |
2581 | 2581 | ||
2582 | If you do not point to a script that you provide, the OpenEmbedded | 2582 | If you do not point to a script that you provide, the OpenEmbedded |
@@ -2586,7 +2586,7 @@ system and gives an overview of their function and contents. | |||
2586 | 2586 | ||
2587 | ICECC_PARALLEL_MAKE | 2587 | ICECC_PARALLEL_MAKE |
2588 | Extra options passed to the ``make`` command during the | 2588 | Extra options passed to the ``make`` command during the |
2589 | ```do_compile`` <#ref-tasks-compile>`__ task that specify parallel | 2589 | :ref:`ref-tasks-compile` task that specify parallel |
2590 | compilation. This variable usually takes the form of "-j x", where x | 2590 | compilation. This variable usually takes the form of "-j x", where x |
2591 | represents the maximum number of parallel threads ``make`` can run. | 2591 | represents the maximum number of parallel threads ``make`` can run. |
2592 | 2592 | ||
@@ -2602,7 +2602,7 @@ system and gives an overview of their function and contents. | |||
2602 | performance could take some experimentation since machine speed, | 2602 | performance could take some experimentation since machine speed, |
2603 | network lag, available memory, and existing machine loads can all | 2603 | network lag, available memory, and existing machine loads can all |
2604 | affect build time. Consequently, unlike the | 2604 | affect build time. Consequently, unlike the |
2605 | ```PARALLEL_MAKE`` <#var-PARALLEL_MAKE>`__ variable, there is no | 2605 | :term:`PARALLEL_MAKE` variable, there is no |
2606 | rule-of-thumb for setting ``ICECC_PARALLEL_MAKE`` to achieve optimal | 2606 | rule-of-thumb for setting ``ICECC_PARALLEL_MAKE`` to achieve optimal |
2607 | performance. | 2607 | performance. |
2608 | 2608 | ||
@@ -2613,13 +2613,13 @@ system and gives an overview of their function and contents. | |||
2613 | ICECC_PATH | 2613 | ICECC_PATH |
2614 | The location of the ``icecc`` binary. You can set this variable in | 2614 | The location of the ``icecc`` binary. You can set this variable in |
2615 | your ``local.conf`` file. If your ``local.conf`` file does not define | 2615 | your ``local.conf`` file. If your ``local.conf`` file does not define |
2616 | this variable, the ```icecc`` <#ref-classes-icecc>`__ class attempts | 2616 | this variable, the :ref:`icecc <ref-classes-icecc>` class attempts |
2617 | to define it by locating ``icecc`` using ``which``. | 2617 | to define it by locating ``icecc`` using ``which``. |
2618 | 2618 | ||
2619 | ICECC_USER_CLASS_BL | 2619 | ICECC_USER_CLASS_BL |
2620 | Identifies user classes that you do not want the Icecream distributed | 2620 | Identifies user classes that you do not want the Icecream distributed |
2621 | compile support to consider. This variable is used by the | 2621 | compile support to consider. This variable is used by the |
2622 | ```icecc`` <#ref-classes-icecc>`__ class. You set this variable in | 2622 | :ref:`icecc <ref-classes-icecc>` class. You set this variable in |
2623 | your ``local.conf`` file. | 2623 | your ``local.conf`` file. |
2624 | 2624 | ||
2625 | When you list classes using this variable, you are "blacklisting" | 2625 | When you list classes using this variable, you are "blacklisting" |
@@ -2629,7 +2629,7 @@ system and gives an overview of their function and contents. | |||
2629 | ICECC_USER_PACKAGE_BL | 2629 | ICECC_USER_PACKAGE_BL |
2630 | Identifies user recipes that you do not want the Icecream distributed | 2630 | Identifies user recipes that you do not want the Icecream distributed |
2631 | compile support to consider. This variable is used by the | 2631 | compile support to consider. This variable is used by the |
2632 | ```icecc`` <#ref-classes-icecc>`__ class. You set this variable in | 2632 | :ref:`icecc <ref-classes-icecc>` class. You set this variable in |
2633 | your ``local.conf`` file. | 2633 | your ``local.conf`` file. |
2634 | 2634 | ||
2635 | When you list packages using this variable, you are "blacklisting" | 2635 | When you list packages using this variable, you are "blacklisting" |
@@ -2638,15 +2638,15 @@ system and gives an overview of their function and contents. | |||
2638 | 2638 | ||
2639 | ICECC_USER_PACKAGE_WL | 2639 | ICECC_USER_PACKAGE_WL |
2640 | Identifies user recipes that use an empty | 2640 | Identifies user recipes that use an empty |
2641 | ```PARALLEL_MAKE`` <#var-PARALLEL_MAKE>`__ variable that you want to | 2641 | :term:`PARALLEL_MAKE` variable that you want to |
2642 | force remote distributed compilation on using the Icecream | 2642 | force remote distributed compilation on using the Icecream |
2643 | distributed compile support. This variable is used by the | 2643 | distributed compile support. This variable is used by the |
2644 | ```icecc`` <#ref-classes-icecc>`__ class. You set this variable in | 2644 | :ref:`icecc <ref-classes-icecc>` class. You set this variable in |
2645 | your ``local.conf`` file. | 2645 | your ``local.conf`` file. |
2646 | 2646 | ||
2647 | IMAGE_BASENAME | 2647 | IMAGE_BASENAME |
2648 | The base name of image output files. This variable defaults to the | 2648 | The base name of image output files. This variable defaults to the |
2649 | recipe name (``${``\ ```PN`` <#var-PN>`__\ ``}``). | 2649 | recipe name (``${``\ :term:`PN`\ ``}``). |
2650 | 2650 | ||
2651 | IMAGE_BOOT_FILES | 2651 | IMAGE_BOOT_FILES |
2652 | A space-separated list of files installed into the boot partition | 2652 | A space-separated list of files installed into the boot partition |
@@ -2656,7 +2656,7 @@ system and gives an overview of their function and contents. | |||
2656 | installed under the same name as the source files. To change the | 2656 | installed under the same name as the source files. To change the |
2657 | installed name, separate it from the original name with a semi-colon | 2657 | installed name, separate it from the original name with a semi-colon |
2658 | (;). Source files need to be located in | 2658 | (;). Source files need to be located in |
2659 | ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__. Here are two | 2659 | :term:`DEPLOY_DIR_IMAGE`. Here are two |
2660 | examples: IMAGE_BOOT_FILES = "u-boot.img uImage;kernel" | 2660 | examples: IMAGE_BOOT_FILES = "u-boot.img uImage;kernel" |
2661 | IMAGE_BOOT_FILES = "u-boot.${UBOOT_SUFFIX} ${KERNEL_IMAGETYPE}" | 2661 | IMAGE_BOOT_FILES = "u-boot.${UBOOT_SUFFIX} ${KERNEL_IMAGETYPE}" |
2662 | 2662 | ||
@@ -2687,12 +2687,12 @@ system and gives an overview of their function and contents. | |||
2687 | configuration file. | 2687 | configuration file. |
2688 | 2688 | ||
2689 | For more information, see ``meta/classes/image_types.bbclass`` in the | 2689 | For more information, see ``meta/classes/image_types.bbclass`` in the |
2690 | `Source Directory <#source-directory>`__. | 2690 | :term:`Source Directory`. |
2691 | 2691 | ||
2692 | IMAGE_CMD | 2692 | IMAGE_CMD |
2693 | Specifies the command to create the image file for a specific image | 2693 | Specifies the command to create the image file for a specific image |
2694 | type, which corresponds to the value set set in | 2694 | type, which corresponds to the value set set in |
2695 | ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__, (e.g. ``ext3``, | 2695 | :term:`IMAGE_FSTYPES`, (e.g. ``ext3``, |
2696 | ``btrfs``, and so forth). When setting this variable, you should use | 2696 | ``btrfs``, and so forth). When setting this variable, you should use |
2697 | an override for the associated type. Here is an example: | 2697 | an override for the associated type. Here is an example: |
2698 | IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \\ --faketime | 2698 | IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} \\ --faketime |
@@ -2701,7 +2701,7 @@ system and gives an overview of their function and contents. | |||
2701 | 2701 | ||
2702 | You typically do not need to set this variable unless you are adding | 2702 | You typically do not need to set this variable unless you are adding |
2703 | support for a new image type. For more examples on how to set this | 2703 | support for a new image type. For more examples on how to set this |
2704 | variable, see the ```image_types`` <#ref-classes-image_types>`__ | 2704 | variable, see the :ref:`image_types <ref-classes-image_types>` |
2705 | class file, which is ``meta/classes/image_types.bbclass``. | 2705 | class file, which is ``meta/classes/image_types.bbclass``. |
2706 | 2706 | ||
2707 | IMAGE_DEVICE_TABLES | 2707 | IMAGE_DEVICE_TABLES |
@@ -2710,7 +2710,7 @@ system and gives an overview of their function and contents. | |||
2710 | These files list basic device nodes that should be created under | 2710 | These files list basic device nodes that should be created under |
2711 | ``/dev`` within the image. If ``IMAGE_DEVICE_TABLES`` is not set, | 2711 | ``/dev`` within the image. If ``IMAGE_DEVICE_TABLES`` is not set, |
2712 | ``files/device_table-minimal.txt`` is used, which is located by | 2712 | ``files/device_table-minimal.txt`` is used, which is located by |
2713 | ```BBPATH`` <#var-BBPATH>`__. For details on how you should write | 2713 | :term:`BBPATH`. For details on how you should write |
2714 | device table files, see ``meta/files/device_table-minimal.txt`` as an | 2714 | device table files, see ``meta/files/device_table-minimal.txt`` as an |
2715 | example. | 2715 | example. |
2716 | 2716 | ||
@@ -2744,7 +2744,7 @@ system and gives an overview of their function and contents. | |||
2744 | IMAGE_FSTYPES = "ext3 tar.bz2" | 2744 | IMAGE_FSTYPES = "ext3 tar.bz2" |
2745 | 2745 | ||
2746 | For the complete list of supported image formats from which you can | 2746 | For the complete list of supported image formats from which you can |
2747 | choose, see ```IMAGE_TYPES`` <#var-IMAGE_TYPES>`__. | 2747 | choose, see :term:`IMAGE_TYPES`. |
2748 | 2748 | ||
2749 | .. note:: | 2749 | .. note:: |
2750 | 2750 | ||
@@ -2759,13 +2759,13 @@ system and gives an overview of their function and contents. | |||
2759 | 2759 | ||
2760 | IMAGE_INSTALL | 2760 | IMAGE_INSTALL |
2761 | Used by recipes to specify the packages to install into an image | 2761 | Used by recipes to specify the packages to install into an image |
2762 | through the ```image`` <#ref-classes-image>`__ class. Use the | 2762 | through the :ref:`image <ref-classes-image>` class. Use the |
2763 | ``IMAGE_INSTALL`` variable with care to avoid ordering issues. | 2763 | ``IMAGE_INSTALL`` variable with care to avoid ordering issues. |
2764 | 2764 | ||
2765 | Image recipes set ``IMAGE_INSTALL`` to specify the packages to | 2765 | Image recipes set ``IMAGE_INSTALL`` to specify the packages to |
2766 | install into an image through ``image.bbclass``. Additionally, | 2766 | install into an image through ``image.bbclass``. Additionally, |
2767 | "helper" classes such as the | 2767 | "helper" classes such as the |
2768 | ```core-image`` <#ref-classes-core-image>`__ class exist that can | 2768 | :ref:`core-image <ref-classes-core-image>` class exist that can |
2769 | take lists used with ``IMAGE_FEATURES`` and turn them into | 2769 | take lists used with ``IMAGE_FEATURES`` and turn them into |
2770 | auto-generated entries in ``IMAGE_INSTALL`` in addition to its | 2770 | auto-generated entries in ``IMAGE_INSTALL`` in addition to its |
2771 | default contents. | 2771 | default contents. |
@@ -2781,7 +2781,7 @@ system and gives an overview of their function and contents. | |||
2781 | ```core-image-minimal-initramfs`` <#images-core-image-minimal-initramfs>`__ | 2781 | ```core-image-minimal-initramfs`` <#images-core-image-minimal-initramfs>`__ |
2782 | image, do not use the ``IMAGE_INSTALL`` variable to specify | 2782 | image, do not use the ``IMAGE_INSTALL`` variable to specify |
2783 | packages for installation. Instead, use the | 2783 | packages for installation. Instead, use the |
2784 | ```PACKAGE_INSTALL`` <#var-PACKAGE_INSTALL>`__ variable, which | 2784 | :term:`PACKAGE_INSTALL` variable, which |
2785 | allows the initial RAM filesystem (initramfs) recipe to use a | 2785 | allows the initial RAM filesystem (initramfs) recipe to use a |
2786 | fixed set of packages and not be affected by ``IMAGE_INSTALL``. | 2786 | fixed set of packages and not be affected by ``IMAGE_INSTALL``. |
2787 | For information on creating an initramfs, see the "`Building an | 2787 | For information on creating an initramfs, see the "`Building an |
@@ -2820,7 +2820,7 @@ system and gives an overview of their function and contents. | |||
2820 | only provide locale files by language and not by country-specific | 2820 | only provide locale files by language and not by country-specific |
2821 | language). | 2821 | language). |
2822 | 2822 | ||
2823 | See the ```GLIBC_GENERATE_LOCALES`` <#var-GLIBC_GENERATE_LOCALES>`__ | 2823 | See the :term:`GLIBC_GENERATE_LOCALES` |
2824 | variable for information on generating GLIBC locales. | 2824 | variable for information on generating GLIBC locales. |
2825 | 2825 | ||
2826 | IMAGE_MANIFEST | 2826 | IMAGE_MANIFEST |
@@ -2829,19 +2829,19 @@ system and gives an overview of their function and contents. | |||
2829 | information on a line-per-package basis as follows: packagename | 2829 | information on a line-per-package basis as follows: packagename |
2830 | packagearch version | 2830 | packagearch version |
2831 | 2831 | ||
2832 | The ```image`` <#ref-classes-image>`__ class defines the manifest | 2832 | The :ref:`image <ref-classes-image>` class defines the manifest |
2833 | file as follows: IMAGE_MANIFEST = | 2833 | file as follows: IMAGE_MANIFEST = |
2834 | "${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest" The location is | 2834 | "${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}.rootfs.manifest" The location is |
2835 | derived using the ```DEPLOY_DIR_IMAGE`` <#var-DEPLOY_DIR_IMAGE>`__ | 2835 | derived using the :term:`DEPLOY_DIR_IMAGE` |
2836 | and ```IMAGE_NAME`` <#var-IMAGE_NAME>`__ variables. You can find | 2836 | and :term:`IMAGE_NAME` variables. You can find |
2837 | information on how the image is created in the "`Image | 2837 | information on how the image is created in the "`Image |
2838 | Generation <&YOCTO_DOCS_OM_URL;#image-generation-dev-environment>`__" | 2838 | Generation <&YOCTO_DOCS_OM_URL;#image-generation-dev-environment>`__" |
2839 | section in the Yocto Project Overview and Concepts Manual. | 2839 | section in the Yocto Project Overview and Concepts Manual. |
2840 | 2840 | ||
2841 | IMAGE_NAME | 2841 | IMAGE_NAME |
2842 | The name of the output image files minus the extension. This variable | 2842 | The name of the output image files minus the extension. This variable |
2843 | is derived using the ```IMAGE_BASENAME`` <#var-IMAGE_BASENAME>`__, | 2843 | is derived using the :term:`IMAGE_BASENAME`, |
2844 | ```MACHINE`` <#var-MACHINE>`__, and ```DATETIME`` <#var-DATETIME>`__ | 2844 | :term:`MACHINE`, and :term:`DATETIME` |
2845 | variables: IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}" | 2845 | variables: IMAGE_NAME = "${IMAGE_BASENAME}-${MACHINE}-${DATETIME}" |
2846 | 2846 | ||
2847 | IMAGE_OVERHEAD_FACTOR | 2847 | IMAGE_OVERHEAD_FACTOR |
@@ -2874,10 +2874,10 @@ system and gives an overview of their function and contents. | |||
2874 | IMAGE_PKGTYPE | 2874 | IMAGE_PKGTYPE |
2875 | Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the | 2875 | Defines the package type (i.e. DEB, RPM, IPK, or TAR) used by the |
2876 | OpenEmbedded build system. The variable is defined appropriately by | 2876 | OpenEmbedded build system. The variable is defined appropriately by |
2877 | the ```package_deb`` <#ref-classes-package_deb>`__, | 2877 | the :ref:`package_deb <ref-classes-package_deb>`, |
2878 | ```package_rpm`` <#ref-classes-package_rpm>`__, | 2878 | :ref:`package_rpm <ref-classes-package_rpm>`, |
2879 | ```package_ipk`` <#ref-classes-package_ipk>`__, or | 2879 | :ref:`package_ipk <ref-classes-package_ipk>`, or |
2880 | ```package_tar`` <#ref-classes-package_tar>`__ class. | 2880 | :ref:`package_tar <ref-classes-package_tar>` class. |
2881 | 2881 | ||
2882 | .. note:: | 2882 | .. note:: |
2883 | 2883 | ||
@@ -2887,13 +2887,13 @@ system and gives an overview of their function and contents. | |||
2887 | do not use it. | 2887 | do not use it. |
2888 | 2888 | ||
2889 | The ```populate_sdk_*`` <#ref-classes-populate-sdk-*>`__ and | 2889 | The ```populate_sdk_*`` <#ref-classes-populate-sdk-*>`__ and |
2890 | ```image`` <#ref-classes-image>`__ classes use the ``IMAGE_PKGTYPE`` | 2890 | :ref:`image <ref-classes-image>` classes use the ``IMAGE_PKGTYPE`` |
2891 | for packaging up images and SDKs. | 2891 | for packaging up images and SDKs. |
2892 | 2892 | ||
2893 | You should not set the ``IMAGE_PKGTYPE`` manually. Rather, the | 2893 | You should not set the ``IMAGE_PKGTYPE`` manually. Rather, the |
2894 | variable is set indirectly through the appropriate | 2894 | variable is set indirectly through the appropriate |
2895 | ```package_*`` <#ref-classes-package>`__ class using the | 2895 | ```package_*`` <#ref-classes-package>`__ class using the |
2896 | ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__ variable. The | 2896 | :term:`PACKAGE_CLASSES` variable. The |
2897 | OpenEmbedded build system uses the first package type (e.g. DEB, RPM, | 2897 | OpenEmbedded build system uses the first package type (e.g. DEB, RPM, |
2898 | or IPK) that appears with the variable | 2898 | or IPK) that appears with the variable |
2899 | 2899 | ||
@@ -2913,7 +2913,7 @@ system and gives an overview of their function and contents. | |||
2913 | If you need to pass the root filesystem path to a command within the | 2913 | If you need to pass the root filesystem path to a command within the |
2914 | function, you can use ``${IMAGE_ROOTFS}``, which points to the | 2914 | function, you can use ``${IMAGE_ROOTFS}``, which points to the |
2915 | directory that becomes the root filesystem image. See the | 2915 | directory that becomes the root filesystem image. See the |
2916 | ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more | 2916 | :term:`IMAGE_ROOTFS` variable for more |
2917 | information. | 2917 | information. |
2918 | 2918 | ||
2919 | IMAGE_PREPROCESS_COMMAND | 2919 | IMAGE_PREPROCESS_COMMAND |
@@ -2925,19 +2925,19 @@ system and gives an overview of their function and contents. | |||
2925 | If you need to pass the root filesystem path to a command within the | 2925 | If you need to pass the root filesystem path to a command within the |
2926 | function, you can use ``${IMAGE_ROOTFS}``, which points to the | 2926 | function, you can use ``${IMAGE_ROOTFS}``, which points to the |
2927 | directory that becomes the root filesystem image. See the | 2927 | directory that becomes the root filesystem image. See the |
2928 | ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more | 2928 | :term:`IMAGE_ROOTFS` variable for more |
2929 | information. | 2929 | information. |
2930 | 2930 | ||
2931 | IMAGE_ROOTFS | 2931 | IMAGE_ROOTFS |
2932 | The location of the root filesystem while it is under construction | 2932 | The location of the root filesystem while it is under construction |
2933 | (i.e. during the ```do_rootfs`` <#ref-tasks-rootfs>`__ task). This | 2933 | (i.e. during the :ref:`ref-tasks-rootfs` task). This |
2934 | variable is not configurable. Do not change it. | 2934 | variable is not configurable. Do not change it. |
2935 | 2935 | ||
2936 | IMAGE_ROOTFS_ALIGNMENT | 2936 | IMAGE_ROOTFS_ALIGNMENT |
2937 | Specifies the alignment for the output image file in Kbytes. If the | 2937 | Specifies the alignment for the output image file in Kbytes. If the |
2938 | size of the image is not a multiple of this value, then the size is | 2938 | size of the image is not a multiple of this value, then the size is |
2939 | rounded up to the nearest multiple of the value. The default value is | 2939 | rounded up to the nearest multiple of the value. The default value is |
2940 | "1". See ```IMAGE_ROOTFS_SIZE`` <#var-IMAGE_ROOTFS_SIZE>`__ for | 2940 | "1". See :term:`IMAGE_ROOTFS_SIZE` for |
2941 | additional information. | 2941 | additional information. |
2942 | 2942 | ||
2943 | IMAGE_ROOTFS_EXTRA_SPACE | 2943 | IMAGE_ROOTFS_EXTRA_SPACE |
@@ -2971,17 +2971,17 @@ system and gives an overview of their function and contents. | |||
2971 | internal-rootfs-size = Initial root filesystem size before any | 2971 | internal-rootfs-size = Initial root filesystem size before any |
2972 | modifications. xspace = IMAGE_ROOTFS_EXTRA_SPACE | 2972 | modifications. xspace = IMAGE_ROOTFS_EXTRA_SPACE |
2973 | 2973 | ||
2974 | See the ```IMAGE_OVERHEAD_FACTOR`` <#var-IMAGE_OVERHEAD_FACTOR>`__ | 2974 | See the :term:`IMAGE_OVERHEAD_FACTOR` |
2975 | and ```IMAGE_ROOTFS_EXTRA_SPACE`` <#var-IMAGE_ROOTFS_EXTRA_SPACE>`__ | 2975 | and :term:`IMAGE_ROOTFS_EXTRA_SPACE` |
2976 | variables for related information. | 2976 | variables for related information. |
2977 | 2977 | ||
2978 | IMAGE_TYPEDEP | 2978 | IMAGE_TYPEDEP |
2979 | Specifies a dependency from one image type on another. Here is an | 2979 | Specifies a dependency from one image type on another. Here is an |
2980 | example from the ```image-live`` <#ref-classes-image-live>`__ class: | 2980 | example from the :ref:`image-live <ref-classes-image-live>` class: |
2981 | IMAGE_TYPEDEP_live = "ext3" | 2981 | IMAGE_TYPEDEP_live = "ext3" |
2982 | 2982 | ||
2983 | In the previous example, the variable ensures that when "live" is | 2983 | In the previous example, the variable ensures that when "live" is |
2984 | listed with the ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable, | 2984 | listed with the :term:`IMAGE_FSTYPES` variable, |
2985 | the OpenEmbedded build system produces an ``ext3`` image first since | 2985 | the OpenEmbedded build system produces an ``ext3`` image first since |
2986 | one of the components of the live image is an ``ext3`` formatted | 2986 | one of the components of the live image is an ``ext3`` formatted |
2987 | partition containing the root filesystem. | 2987 | partition containing the root filesystem. |
@@ -3005,7 +3005,7 @@ system and gives an overview of their function and contents. | |||
3005 | 3005 | ||
3006 | Suppose, for example, you have a set of recipes that are used across | 3006 | Suppose, for example, you have a set of recipes that are used across |
3007 | several projects. And, within each of those recipes the revision (its | 3007 | several projects. And, within each of those recipes the revision (its |
3008 | ```PR`` <#var-PR>`__ value) is set accordingly. In this case, when | 3008 | :term:`PR` value) is set accordingly. In this case, when |
3009 | the revision of those recipes changes, the burden is on you to find | 3009 | the revision of those recipes changes, the burden is on you to find |
3010 | all those recipes and be sure that they get changed to reflect the | 3010 | all those recipes and be sure that they get changed to reflect the |
3011 | updated version of the recipe. In this scenario, it can get | 3011 | updated version of the recipe. In this scenario, it can get |
@@ -3034,7 +3034,7 @@ system and gives an overview of their function and contents. | |||
3034 | 3034 | ||
3035 | INCOMPATIBLE_LICENSE | 3035 | INCOMPATIBLE_LICENSE |
3036 | Specifies a space-separated list of license names (as they would | 3036 | Specifies a space-separated list of license names (as they would |
3037 | appear in ```LICENSE`` <#var-LICENSE>`__) that should be excluded | 3037 | appear in :term:`LICENSE`) that should be excluded |
3038 | from the build. Recipes that provide no alternatives to listed | 3038 | from the build. Recipes that provide no alternatives to listed |
3039 | incompatible licenses are not built. Packages that are individually | 3039 | incompatible licenses are not built. Packages that are individually |
3040 | licensed with the specified incompatible licenses will be deleted. | 3040 | licensed with the specified incompatible licenses will be deleted. |
@@ -3095,7 +3095,7 @@ system and gives an overview of their function and contents. | |||
3095 | 3095 | ||
3096 | INHIBIT_DEFAULT_DEPS | 3096 | INHIBIT_DEFAULT_DEPS |
3097 | Prevents the default dependencies, namely the C compiler and standard | 3097 | Prevents the default dependencies, namely the C compiler and standard |
3098 | C library (libc), from being added to ```DEPENDS`` <#var-DEPENDS>`__. | 3098 | C library (libc), from being added to :term:`DEPENDS`. |
3099 | This variable is usually used within recipes that do not require any | 3099 | This variable is usually used within recipes that do not require any |
3100 | compilation using the C compiler. | 3100 | compilation using the C compiler. |
3101 | 3101 | ||
@@ -3106,9 +3106,9 @@ system and gives an overview of their function and contents. | |||
3106 | Prevents the OpenEmbedded build system from splitting out debug | 3106 | Prevents the OpenEmbedded build system from splitting out debug |
3107 | information during packaging. By default, the build system splits out | 3107 | information during packaging. By default, the build system splits out |
3108 | debugging information during the | 3108 | debugging information during the |
3109 | ```do_package`` <#ref-tasks-package>`__ task. For more information on | 3109 | :ref:`ref-tasks-package` task. For more information on |
3110 | how debug information is split out, see the | 3110 | how debug information is split out, see the |
3111 | ```PACKAGE_DEBUG_SPLIT_STYLE`` <#var-PACKAGE_DEBUG_SPLIT_STYLE>`__ | 3111 | :term:`PACKAGE_DEBUG_SPLIT_STYLE` |
3112 | variable. | 3112 | variable. |
3113 | 3113 | ||
3114 | To prevent the build system from splitting out debug information | 3114 | To prevent the build system from splitting out debug information |
@@ -3121,7 +3121,7 @@ system and gives an overview of their function and contents. | |||
3121 | files. | 3121 | files. |
3122 | 3122 | ||
3123 | By default, the OpenEmbedded build system strips binaries and puts | 3123 | By default, the OpenEmbedded build system strips binaries and puts |
3124 | the debugging symbols into ``${``\ ```PN`` <#var-PN>`__\ ``}-dbg``. | 3124 | the debugging symbols into ``${``\ :term:`PN`\ ``}-dbg``. |
3125 | Consequently, you should not set ``INHIBIT_PACKAGE_STRIP`` when you | 3125 | Consequently, you should not set ``INHIBIT_PACKAGE_STRIP`` when you |
3126 | plan to debug in general. | 3126 | plan to debug in general. |
3127 | 3127 | ||
@@ -3135,7 +3135,7 @@ system and gives an overview of their function and contents. | |||
3135 | this stripping. | 3135 | this stripping. |
3136 | 3136 | ||
3137 | If you want to use this variable, include the | 3137 | If you want to use this variable, include the |
3138 | ```staging`` <#ref-classes-staging>`__ class. This class uses a | 3138 | :ref:`staging <ref-classes-staging>` class. This class uses a |
3139 | ``sys_strip()`` function to test for the variable and acts | 3139 | ``sys_strip()`` function to test for the variable and acts |
3140 | accordingly. | 3140 | accordingly. |
3141 | 3141 | ||
@@ -3153,7 +3153,7 @@ system and gives an overview of their function and contents. | |||
3153 | Defines the format for the output image of an initial RAM filesystem | 3153 | Defines the format for the output image of an initial RAM filesystem |
3154 | (initramfs), which is used during boot. Supported formats are the | 3154 | (initramfs), which is used during boot. Supported formats are the |
3155 | same as those supported by the | 3155 | same as those supported by the |
3156 | ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ variable. | 3156 | :term:`IMAGE_FSTYPES` variable. |
3157 | 3157 | ||
3158 | The default value of this variable, which is set in the | 3158 | The default value of this variable, which is set in the |
3159 | ``meta/conf/bitbake.conf`` configuration file in the `Source | 3159 | ``meta/conf/bitbake.conf`` configuration file in the `Source |
@@ -3163,14 +3163,14 @@ system and gives an overview of their function and contents. | |||
3163 | an optionally compressed cpio archive. | 3163 | an optionally compressed cpio archive. |
3164 | 3164 | ||
3165 | INITRAMFS_IMAGE | 3165 | INITRAMFS_IMAGE |
3166 | Specifies the ```PROVIDES`` <#var-PROVIDES>`__ name of an image | 3166 | Specifies the :term:`PROVIDES` name of an image |
3167 | recipe that is used to build an initial RAM filesystem (initramfs) | 3167 | recipe that is used to build an initial RAM filesystem (initramfs) |
3168 | image. In other words, the ``INITRAMFS_IMAGE`` variable causes an | 3168 | image. In other words, the ``INITRAMFS_IMAGE`` variable causes an |
3169 | additional recipe to be built as a dependency to whatever root | 3169 | additional recipe to be built as a dependency to whatever root |
3170 | filesystem recipe you might be using (e.g. ``core-image-sato``). The | 3170 | filesystem recipe you might be using (e.g. ``core-image-sato``). The |
3171 | initramfs image recipe you provide should set | 3171 | initramfs image recipe you provide should set |
3172 | ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ to | 3172 | :term:`IMAGE_FSTYPES` to |
3173 | ```INITRAMFS_FSTYPES`` <#var-INITRAMFS_FSTYPES>`__. | 3173 | :term:`INITRAMFS_FSTYPES`. |
3174 | 3174 | ||
3175 | An initramfs image provides a temporary root filesystem used for | 3175 | An initramfs image provides a temporary root filesystem used for |
3176 | early system initialization (e.g. loading of modules needed to locate | 3176 | early system initialization (e.g. loading of modules needed to locate |
@@ -3189,15 +3189,15 @@ system and gives an overview of their function and contents. | |||
3189 | 3189 | ||
3190 | You can also find more information by referencing the | 3190 | You can also find more information by referencing the |
3191 | ``meta-poky/conf/local.conf.sample.extended`` configuration file in | 3191 | ``meta-poky/conf/local.conf.sample.extended`` configuration file in |
3192 | the Source Directory, the ```image`` <#ref-classes-image>`__ class, | 3192 | the Source Directory, the :ref:`image <ref-classes-image>` class, |
3193 | and the ```kernel`` <#ref-classes-kernel>`__ class to see how to use | 3193 | and the :ref:`kernel <ref-classes-kernel>` class to see how to use |
3194 | the ``INITRAMFS_IMAGE`` variable. | 3194 | the ``INITRAMFS_IMAGE`` variable. |
3195 | 3195 | ||
3196 | If ``INITRAMFS_IMAGE`` is empty, which is the default, then no | 3196 | If ``INITRAMFS_IMAGE`` is empty, which is the default, then no |
3197 | initramfs image is built. | 3197 | initramfs image is built. |
3198 | 3198 | ||
3199 | For more information, you can also see the | 3199 | For more information, you can also see the |
3200 | ```INITRAMFS_IMAGE_BUNDLE`` <#var-INITRAMFS_IMAGE_BUNDLE>`__ | 3200 | :term:`INITRAMFS_IMAGE_BUNDLE` |
3201 | variable, which allows the generated image to be bundled inside the | 3201 | variable, which allows the generated image to be bundled inside the |
3202 | kernel image. Additionally, for information on creating an initramfs | 3202 | kernel image. Additionally, for information on creating an initramfs |
3203 | image, see the "`Building an Initial RAM Filesystem (initramfs) | 3203 | image, see the "`Building an Initial RAM Filesystem (initramfs) |
@@ -3206,13 +3206,13 @@ system and gives an overview of their function and contents. | |||
3206 | 3206 | ||
3207 | INITRAMFS_IMAGE_BUNDLE | 3207 | INITRAMFS_IMAGE_BUNDLE |
3208 | Controls whether or not the image recipe specified by | 3208 | Controls whether or not the image recipe specified by |
3209 | ```INITRAMFS_IMAGE`` <#var-INITRAMFS_IMAGE>`__ is run through an | 3209 | :term:`INITRAMFS_IMAGE` is run through an |
3210 | extra pass | 3210 | extra pass |
3211 | (```do_bundle_initramfs`` <#ref-tasks-bundle_initramfs>`__) during | 3211 | (:ref:`ref-tasks-bundle_initramfs`) during |
3212 | kernel compilation in order to build a single binary that contains | 3212 | kernel compilation in order to build a single binary that contains |
3213 | both the kernel image and the initial RAM filesystem (initramfs) | 3213 | both the kernel image and the initial RAM filesystem (initramfs) |
3214 | image. This makes use of the | 3214 | image. This makes use of the |
3215 | ```CONFIG_INITRAMFS_SOURCE`` <#var-CONFIG_INITRAMFS_SOURCE>`__ kernel | 3215 | :term:`CONFIG_INITRAMFS_SOURCE` kernel |
3216 | feature. | 3216 | feature. |
3217 | 3217 | ||
3218 | .. note:: | 3218 | .. note:: |
@@ -3225,13 +3225,13 @@ system and gives an overview of their function and contents. | |||
3225 | since the initramfs is bundled inside the kernel image. | 3225 | since the initramfs is bundled inside the kernel image. |
3226 | 3226 | ||
3227 | The combined binary is deposited into the ``tmp/deploy`` directory, | 3227 | The combined binary is deposited into the ``tmp/deploy`` directory, |
3228 | which is part of the `Build Directory <#build-directory>`__. | 3228 | which is part of the :term:`Build Directory`. |
3229 | 3229 | ||
3230 | Setting the variable to "1" in a configuration file causes the | 3230 | Setting the variable to "1" in a configuration file causes the |
3231 | OpenEmbedded build system to generate a kernel image with the | 3231 | OpenEmbedded build system to generate a kernel image with the |
3232 | initramfs specified in ``INITRAMFS_IMAGE`` bundled within: | 3232 | initramfs specified in ``INITRAMFS_IMAGE`` bundled within: |
3233 | INITRAMFS_IMAGE_BUNDLE = "1" By default, the | 3233 | INITRAMFS_IMAGE_BUNDLE = "1" By default, the |
3234 | ```kernel`` <#ref-classes-kernel>`__ class sets this variable to a | 3234 | :ref:`kernel <ref-classes-kernel>` class sets this variable to a |
3235 | null string as follows: INITRAMFS_IMAGE_BUNDLE ?= "" | 3235 | null string as follows: INITRAMFS_IMAGE_BUNDLE ?= "" |
3236 | 3236 | ||
3237 | .. note:: | 3237 | .. note:: |
@@ -3257,14 +3257,14 @@ system and gives an overview of their function and contents. | |||
3257 | file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= | 3257 | file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= |
3258 | "${MACHINE}" | 3258 | "${MACHINE}" |
3259 | 3259 | ||
3260 | See the ```MACHINE`` <#var-MACHINE>`__ variable for additional | 3260 | See the :term:`MACHINE` variable for additional |
3261 | information. | 3261 | information. |
3262 | 3262 | ||
3263 | INITRAMFS_NAME | 3263 | INITRAMFS_NAME |
3264 | The base name of the initial RAM filesystem image. This variable is | 3264 | The base name of the initial RAM filesystem image. This variable is |
3265 | set in the ``meta/classes/kernel-artifact-names.bbclass`` file as | 3265 | set in the ``meta/classes/kernel-artifact-names.bbclass`` file as |
3266 | follows: INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" The | 3266 | follows: INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}" The |
3267 | value of the ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__ | 3267 | value of the :term:`KERNEL_ARTIFACT_NAME` |
3268 | variable, which is set in the same file, has the following value: | 3268 | variable, which is set in the same file, has the following value: |
3269 | KERNEL_ARTIFACT_NAME ?= | 3269 | KERNEL_ARTIFACT_NAME ?= |
3270 | "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 3270 | "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
@@ -3274,16 +3274,16 @@ system and gives an overview of their function and contents. | |||
3274 | initial RAM disk (``initrd``). | 3274 | initial RAM disk (``initrd``). |
3275 | 3275 | ||
3276 | The ``INITRD`` variable is an optional variable used with the | 3276 | The ``INITRD`` variable is an optional variable used with the |
3277 | ```image-live`` <#ref-classes-image-live>`__ class. | 3277 | :ref:`image-live <ref-classes-image-live>` class. |
3278 | 3278 | ||
3279 | INITRD_IMAGE | 3279 | INITRD_IMAGE |
3280 | When building a "live" bootable image (i.e. when | 3280 | When building a "live" bootable image (i.e. when |
3281 | ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ contains "live"), | 3281 | :term:`IMAGE_FSTYPES` contains "live"), |
3282 | ``INITRD_IMAGE`` specifies the image recipe that should be built to | 3282 | ``INITRD_IMAGE`` specifies the image recipe that should be built to |
3283 | provide the initial RAM disk image. The default value is | 3283 | provide the initial RAM disk image. The default value is |
3284 | "core-image-minimal-initramfs". | 3284 | "core-image-minimal-initramfs". |
3285 | 3285 | ||
3286 | See the ```image-live`` <#ref-classes-image-live>`__ class for more | 3286 | See the :ref:`image-live <ref-classes-image-live>` class for more |
3287 | information. | 3287 | information. |
3288 | 3288 | ||
3289 | INITSCRIPT_NAME | 3289 | INITSCRIPT_NAME |
@@ -3299,7 +3299,7 @@ system and gives an overview of their function and contents. | |||
3299 | ``INITSCRIPT_*`` as an override. | 3299 | ``INITSCRIPT_*`` as an override. |
3300 | 3300 | ||
3301 | This variable is used in recipes when using ``update-rc.d.bbclass``. | 3301 | This variable is used in recipes when using ``update-rc.d.bbclass``. |
3302 | The variable is optional and defaults to the ```PN`` <#var-PN>`__ | 3302 | The variable is optional and defaults to the :term:`PN` |
3303 | variable. | 3303 | variable. |
3304 | 3304 | ||
3305 | INITSCRIPT_PARAMS | 3305 | INITSCRIPT_PARAMS |
@@ -3310,7 +3310,7 @@ system and gives an overview of their function and contents. | |||
3310 | in initlevels 2 and 5, and stops the script in levels 0, 1 and 6. | 3310 | in initlevels 2 and 5, and stops the script in levels 0, 1 and 6. |
3311 | 3311 | ||
3312 | The variable's default value is "defaults", which is set in the | 3312 | The variable's default value is "defaults", which is set in the |
3313 | ```update-rc.d`` <#ref-classes-update-rc.d>`__ class. | 3313 | :ref:`update-rc.d <ref-classes-update-rc.d>` class. |
3314 | 3314 | ||
3315 | The value in ``INITSCRIPT_PARAMS`` is passed through to the | 3315 | The value in ``INITSCRIPT_PARAMS`` is passed through to the |
3316 | ``update-rc.d`` command. For more information on valid parameters, | 3316 | ``update-rc.d`` command. For more information on valid parameters, |
@@ -3324,7 +3324,7 @@ system and gives an overview of their function and contents. | |||
3324 | recipe. The package name override must be used, which in this example | 3324 | recipe. The package name override must be used, which in this example |
3325 | is ``${PN}``: INSANE_SKIP_${PN} += "dev-so" | 3325 | is ``${PN}``: INSANE_SKIP_${PN} += "dev-so" |
3326 | 3326 | ||
3327 | See the "```insane.bbclass`` <#ref-classes-insane>`__" section for a | 3327 | See the ":ref:`insane.bbclass <ref-classes-insane>`" section for a |
3328 | list of the valid QA checks you can specify using this variable. | 3328 | list of the valid QA checks you can specify using this variable. |
3329 | 3329 | ||
3330 | INSTALL_TIMEZONE_FILE | 3330 | INSTALL_TIMEZONE_FILE |
@@ -3376,7 +3376,7 @@ system and gives an overview of their function and contents. | |||
3376 | BSP. | 3376 | BSP. |
3377 | 3377 | ||
3378 | KBUILD_DEFCONFIG | 3378 | KBUILD_DEFCONFIG |
3379 | When used with the ```kernel-yocto`` <#ref-classes-kernel-yocto>`__ | 3379 | When used with the :ref:`kernel-yocto <ref-classes-kernel-yocto>` |
3380 | class, specifies an "in-tree" kernel configuration file for use | 3380 | class, specifies an "in-tree" kernel configuration file for use |
3381 | during a kernel build. | 3381 | during a kernel build. |
3382 | 3382 | ||
@@ -3386,7 +3386,7 @@ system and gives an overview of their function and contents. | |||
3386 | "out-of-tree"). However, if you want to use a ``defconfig`` file that | 3386 | "out-of-tree"). However, if you want to use a ``defconfig`` file that |
3387 | is part of the kernel tree (i.e. "in-tree"), you can use the | 3387 | is part of the kernel tree (i.e. "in-tree"), you can use the |
3388 | ``KBUILD_DEFCONFIG`` variable and append the | 3388 | ``KBUILD_DEFCONFIG`` variable and append the |
3389 | ```KMACHINE`` <#var-KMACHINE>`__ variable to point to the | 3389 | :term:`KMACHINE` variable to point to the |
3390 | ``defconfig`` file. | 3390 | ``defconfig`` file. |
3391 | 3391 | ||
3392 | To use the variable, set it in the append file for your kernel recipe | 3392 | To use the variable, set it in the append file for your kernel recipe |
@@ -3404,7 +3404,7 @@ system and gives an overview of their function and contents. | |||
3404 | KERNEL_ALT_IMAGETYPE | 3404 | KERNEL_ALT_IMAGETYPE |
3405 | Specifies an alternate kernel image type for creation in addition to | 3405 | Specifies an alternate kernel image type for creation in addition to |
3406 | the kernel image type specified using the | 3406 | the kernel image type specified using the |
3407 | ```KERNEL_IMAGETYPE`` <#var-KERNEL_IMAGETYPE>`__ variable. | 3407 | :term:`KERNEL_IMAGETYPE` variable. |
3408 | 3408 | ||
3409 | KERNEL_ARTIFACT_NAME | 3409 | KERNEL_ARTIFACT_NAME |
3410 | Specifies the name of all of the build artifacts. You can change the | 3410 | Specifies the name of all of the build artifacts. You can change the |
@@ -3416,8 +3416,8 @@ system and gives an overview of their function and contents. | |||
3416 | following default value: KERNEL_ARTIFACT_NAME ?= | 3416 | following default value: KERNEL_ARTIFACT_NAME ?= |
3417 | "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 3417 | "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
3418 | 3418 | ||
3419 | See the ```PKGE`` <#var-PKGE>`__, ```PKGV`` <#var-PKGV>`__, | 3419 | See the :term:`PKGE`, :term:`PKGV`, |
3420 | ```PKGR`` <#var-PKGR>`__, and ```MACHINE`` <#var-MACHINE>`__ | 3420 | :term:`PKGR`, and :term:`MACHINE` |
3421 | variables for additional information. | 3421 | variables for additional information. |
3422 | 3422 | ||
3423 | .. note:: | 3423 | .. note:: |
@@ -3430,7 +3430,7 @@ system and gives an overview of their function and contents. | |||
3430 | 3430 | ||
3431 | KERNEL_CLASSES | 3431 | KERNEL_CLASSES |
3432 | A list of classes defining kernel image types that the | 3432 | A list of classes defining kernel image types that the |
3433 | ```kernel`` <#ref-classes-kernel>`__ class should inherit. You | 3433 | :ref:`kernel <ref-classes-kernel>` class should inherit. You |
3434 | typically append this variable to enable extended image types. An | 3434 | typically append this variable to enable extended image types. An |
3435 | example is the "kernel-fitimage", which enables fitImage support and | 3435 | example is the "kernel-fitimage", which enables fitImage support and |
3436 | resides in ``meta/classes/kernel-fitimage.bbclass``. You can register | 3436 | resides in ``meta/classes/kernel-fitimage.bbclass``. You can register |
@@ -3449,7 +3449,7 @@ system and gives an overview of their function and contents. | |||
3449 | file is preferred. | 3449 | file is preferred. |
3450 | 3450 | ||
3451 | In order to use this variable, the | 3451 | In order to use this variable, the |
3452 | ```kernel-devicetree`` <#ref-classes-kernel-devicetree>`__ class must | 3452 | :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class must |
3453 | be inherited. | 3453 | be inherited. |
3454 | 3454 | ||
3455 | KERNEL_DTB_LINK_NAME | 3455 | KERNEL_DTB_LINK_NAME |
@@ -3460,14 +3460,14 @@ system and gives an overview of their function and contents. | |||
3460 | the same file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= | 3460 | the same file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= |
3461 | "${MACHINE}" | 3461 | "${MACHINE}" |
3462 | 3462 | ||
3463 | See the ```MACHINE`` <#var-MACHINE>`__ variable for additional | 3463 | See the :term:`MACHINE` variable for additional |
3464 | information. | 3464 | information. |
3465 | 3465 | ||
3466 | KERNEL_DTB_NAME | 3466 | KERNEL_DTB_NAME |
3467 | The base name of the kernel device tree binary (DTB). This variable | 3467 | The base name of the kernel device tree binary (DTB). This variable |
3468 | is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as | 3468 | is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as |
3469 | follows: KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" The value of | 3469 | follows: KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}" The value of |
3470 | the ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__ | 3470 | the :term:`KERNEL_ARTIFACT_NAME` |
3471 | variable, which is set in the same file, has the following value: | 3471 | variable, which is set in the same file, has the following value: |
3472 | KERNEL_ARTIFACT_NAME ?= | 3472 | KERNEL_ARTIFACT_NAME ?= |
3473 | "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 3473 | "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
@@ -3479,8 +3479,8 @@ system and gives an overview of their function and contents. | |||
3479 | KERNEL_FEATURES | 3479 | KERNEL_FEATURES |
3480 | Includes additional kernel metadata. In the OpenEmbedded build | 3480 | Includes additional kernel metadata. In the OpenEmbedded build |
3481 | system, the default Board Support Packages (BSPs) | 3481 | system, the default Board Support Packages (BSPs) |
3482 | `Metadata <#metadata>`__ is provided through the | 3482 | :term:`Metadata` is provided through the |
3483 | ```KMACHINE`` <#var-KMACHINE>`__ and ```KBRANCH`` <#var-KBRANCH>`__ | 3483 | :term:`KMACHINE` and :term:`KBRANCH` |
3484 | variables. You can use the ``KERNEL_FEATURES`` variable from within | 3484 | variables. You can use the ``KERNEL_FEATURES`` variable from within |
3485 | the kernel recipe or kernel append file to further add metadata for | 3485 | the kernel recipe or kernel append file to further add metadata for |
3486 | all BSPs or specific BSPs. | 3486 | all BSPs or specific BSPs. |
@@ -3511,14 +3511,14 @@ system and gives an overview of their function and contents. | |||
3511 | file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= | 3511 | file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= |
3512 | "${MACHINE}" | 3512 | "${MACHINE}" |
3513 | 3513 | ||
3514 | See the ```MACHINE`` <#var-MACHINE>`__ variable for additional | 3514 | See the :term:`MACHINE` variable for additional |
3515 | information. | 3515 | information. |
3516 | 3516 | ||
3517 | KERNEL_FIT_NAME | 3517 | KERNEL_FIT_NAME |
3518 | The base name of the kernel flattened image tree (FIT) image. This | 3518 | The base name of the kernel flattened image tree (FIT) image. This |
3519 | variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` | 3519 | variable is set in the ``meta/classes/kernel-artifact-names.bbclass`` |
3520 | file as follows: KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" The | 3520 | file as follows: KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}" The |
3521 | value of the ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__ | 3521 | value of the :term:`KERNEL_ARTIFACT_NAME` |
3522 | variable, which is set in the same file, has the following value: | 3522 | variable, which is set in the same file, has the following value: |
3523 | KERNEL_ARTIFACT_NAME ?= | 3523 | KERNEL_ARTIFACT_NAME ?= |
3524 | "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 3524 | "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
@@ -3531,14 +3531,14 @@ system and gives an overview of their function and contents. | |||
3531 | file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= | 3531 | file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= |
3532 | "${MACHINE}" | 3532 | "${MACHINE}" |
3533 | 3533 | ||
3534 | See the ```MACHINE`` <#var-MACHINE>`__ variable for additional | 3534 | See the :term:`MACHINE` variable for additional |
3535 | information. | 3535 | information. |
3536 | 3536 | ||
3537 | KERNEL_IMAGE_MAXSIZE | 3537 | KERNEL_IMAGE_MAXSIZE |
3538 | Specifies the maximum size of the kernel image file in kilobytes. If | 3538 | Specifies the maximum size of the kernel image file in kilobytes. If |
3539 | ``KERNEL_IMAGE_MAXSIZE`` is set, the size of the kernel image file is | 3539 | ``KERNEL_IMAGE_MAXSIZE`` is set, the size of the kernel image file is |
3540 | checked against the set value during the | 3540 | checked against the set value during the |
3541 | ```do_sizecheck`` <#ref-tasks-sizecheck>`__ task. The task fails if | 3541 | :ref:`ref-tasks-sizecheck` task. The task fails if |
3542 | the kernel image file is larger than the setting. | 3542 | the kernel image file is larger than the setting. |
3543 | 3543 | ||
3544 | ``KERNEL_IMAGE_MAXSIZE`` is useful for target devices that have a | 3544 | ``KERNEL_IMAGE_MAXSIZE`` is useful for target devices that have a |
@@ -3551,7 +3551,7 @@ system and gives an overview of their function and contents. | |||
3551 | The base name of the kernel image. This variable is set in the | 3551 | The base name of the kernel image. This variable is set in the |
3552 | ``meta/classes/kernel-artifact-names.bbclass`` file as follows: | 3552 | ``meta/classes/kernel-artifact-names.bbclass`` file as follows: |
3553 | KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}" The value of the | 3553 | KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}" The value of the |
3554 | ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__ variable, | 3554 | :term:`KERNEL_ARTIFACT_NAME` variable, |
3555 | which is set in the same file, has the following value: | 3555 | which is set in the same file, has the following value: |
3556 | KERNEL_ARTIFACT_NAME ?= | 3556 | KERNEL_ARTIFACT_NAME ?= |
3557 | "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 3557 | "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
@@ -3563,7 +3563,7 @@ system and gives an overview of their function and contents. | |||
3563 | build. | 3563 | build. |
3564 | 3564 | ||
3565 | If you want to build an alternate kernel image type, use the | 3565 | If you want to build an alternate kernel image type, use the |
3566 | ```KERNEL_ALT_IMAGETYPE`` <#var-KERNEL_ALT_IMAGETYPE>`__ variable. | 3566 | :term:`KERNEL_ALT_IMAGETYPE` variable. |
3567 | 3567 | ||
3568 | KERNEL_MODULE_AUTOLOAD | 3568 | KERNEL_MODULE_AUTOLOAD |
3569 | Lists kernel modules that need to be auto-loaded during boot. | 3569 | Lists kernel modules that need to be auto-loaded during boot. |
@@ -3591,7 +3591,7 @@ system and gives an overview of their function and contents. | |||
3591 | 3591 | ||
3592 | For information on how to populate the ``modname.conf`` file with | 3592 | For information on how to populate the ``modname.conf`` file with |
3593 | ``modprobe.d`` syntax lines, see the | 3593 | ``modprobe.d`` syntax lines, see the |
3594 | ```KERNEL_MODULE_PROBECONF`` <#var-KERNEL_MODULE_PROBECONF>`__ | 3594 | :term:`KERNEL_MODULE_PROBECONF` |
3595 | variable. | 3595 | variable. |
3596 | 3596 | ||
3597 | KERNEL_MODULE_PROBECONF | 3597 | KERNEL_MODULE_PROBECONF |
@@ -3603,29 +3603,29 @@ system and gives an overview of their function and contents. | |||
3603 | 3603 | ||
3604 | KERNEL_PATH | 3604 | KERNEL_PATH |
3605 | The location of the kernel sources. This variable is set to the value | 3605 | The location of the kernel sources. This variable is set to the value |
3606 | of the ```STAGING_KERNEL_DIR`` <#var-STAGING_KERNEL_DIR>`__ within | 3606 | of the :term:`STAGING_KERNEL_DIR` within |
3607 | the ```module`` <#ref-classes-module>`__ class. For information on | 3607 | the :ref:`module <ref-classes-module>` class. For information on |
3608 | how this variable is used, see the "`Incorporating Out-of-Tree | 3608 | how this variable is used, see the "`Incorporating Out-of-Tree |
3609 | Modules <&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules>`__" | 3609 | Modules <&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules>`__" |
3610 | section in the Yocto Project Linux Kernel Development Manual. | 3610 | section in the Yocto Project Linux Kernel Development Manual. |
3611 | 3611 | ||
3612 | To help maximize compatibility with out-of-tree drivers used to build | 3612 | To help maximize compatibility with out-of-tree drivers used to build |
3613 | modules, the OpenEmbedded build system also recognizes and uses the | 3613 | modules, the OpenEmbedded build system also recognizes and uses the |
3614 | ```KERNEL_SRC`` <#var-KERNEL_SRC>`__ variable, which is identical to | 3614 | :term:`KERNEL_SRC` variable, which is identical to |
3615 | the ``KERNEL_PATH`` variable. Both variables are common variables | 3615 | the ``KERNEL_PATH`` variable. Both variables are common variables |
3616 | used by external Makefiles to point to the kernel source directory. | 3616 | used by external Makefiles to point to the kernel source directory. |
3617 | 3617 | ||
3618 | KERNEL_SRC | 3618 | KERNEL_SRC |
3619 | The location of the kernel sources. This variable is set to the value | 3619 | The location of the kernel sources. This variable is set to the value |
3620 | of the ```STAGING_KERNEL_DIR`` <#var-STAGING_KERNEL_DIR>`__ within | 3620 | of the :term:`STAGING_KERNEL_DIR` within |
3621 | the ```module`` <#ref-classes-module>`__ class. For information on | 3621 | the :ref:`module <ref-classes-module>` class. For information on |
3622 | how this variable is used, see the "`Incorporating Out-of-Tree | 3622 | how this variable is used, see the "`Incorporating Out-of-Tree |
3623 | Modules <&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules>`__" | 3623 | Modules <&YOCTO_DOCS_KERNEL_DEV_URL;#incorporating-out-of-tree-modules>`__" |
3624 | section in the Yocto Project Linux Kernel Development Manual. | 3624 | section in the Yocto Project Linux Kernel Development Manual. |
3625 | 3625 | ||
3626 | To help maximize compatibility with out-of-tree drivers used to build | 3626 | To help maximize compatibility with out-of-tree drivers used to build |
3627 | modules, the OpenEmbedded build system also recognizes and uses the | 3627 | modules, the OpenEmbedded build system also recognizes and uses the |
3628 | ```KERNEL_PATH`` <#var-KERNEL_PATH>`__ variable, which is identical | 3628 | :term:`KERNEL_PATH` variable, which is identical |
3629 | to the ``KERNEL_SRC`` variable. Both variables are common variables | 3629 | to the ``KERNEL_SRC`` variable. Both variables are common variables |
3630 | used by external Makefiles to point to the kernel source directory. | 3630 | used by external Makefiles to point to the kernel source directory. |
3631 | 3631 | ||
@@ -3638,7 +3638,7 @@ system and gives an overview of their function and contents. | |||
3638 | 3638 | ||
3639 | KERNELDEPMODDEPEND | 3639 | KERNELDEPMODDEPEND |
3640 | Specifies whether the data referenced through | 3640 | Specifies whether the data referenced through |
3641 | ```PKGDATA_DIR`` <#var-PKGDATA_DIR>`__ is needed or not. The | 3641 | :term:`PKGDATA_DIR` is needed or not. The |
3642 | ``KERNELDEPMODDEPEND`` does not control whether or not that data | 3642 | ``KERNELDEPMODDEPEND`` does not control whether or not that data |
3643 | exists, but simply whether or not it is used. If you do not need to | 3643 | exists, but simply whether or not it is used. If you do not need to |
3644 | use the data, set the ``KERNELDEPMODDEPEND`` variable in your | 3644 | use the data, set the ``KERNELDEPMODDEPEND`` variable in your |
@@ -3690,13 +3690,13 @@ system and gives an overview of their function and contents. | |||
3690 | You define the ``KTYPE`` variable in the `BSP | 3690 | You define the ``KTYPE`` variable in the `BSP |
3691 | Descriptions <&YOCTO_DOCS_KERNEL_DEV_URL;#bsp-descriptions>`__. The | 3691 | Descriptions <&YOCTO_DOCS_KERNEL_DEV_URL;#bsp-descriptions>`__. The |
3692 | value you use must match the value used for the | 3692 | value you use must match the value used for the |
3693 | ```LINUX_KERNEL_TYPE`` <#var-LINUX_KERNEL_TYPE>`__ value used by the | 3693 | :term:`LINUX_KERNEL_TYPE` value used by the |
3694 | kernel recipe. | 3694 | kernel recipe. |
3695 | 3695 | ||
3696 | LABELS | 3696 | LABELS |
3697 | Provides a list of targets for automatic configuration. | 3697 | Provides a list of targets for automatic configuration. |
3698 | 3698 | ||
3699 | See the ```grub-efi`` <#ref-classes-grub-efi>`__ class for more | 3699 | See the :ref:`grub-efi <ref-classes-grub-efi>` class for more |
3700 | information on how this variable is used. | 3700 | information on how this variable is used. |
3701 | 3701 | ||
3702 | LAYERDEPENDS | 3702 | LAYERDEPENDS |
@@ -3705,7 +3705,7 @@ system and gives an overview of their function and contents. | |||
3705 | by adding it to the end of the layer name. Here is an example: | 3705 | by adding it to the end of the layer name. Here is an example: |
3706 | LAYERDEPENDS_mylayer = "anotherlayer (=3)" In this previous example, | 3706 | LAYERDEPENDS_mylayer = "anotherlayer (=3)" In this previous example, |
3707 | version 3 of "anotherlayer" is compared against | 3707 | version 3 of "anotherlayer" is compared against |
3708 | ```LAYERVERSION`` <#var-LAYERVERSION>`__\ ``_anotherlayer``. | 3708 | :term:`LAYERVERSION`\ ``_anotherlayer``. |
3709 | 3709 | ||
3710 | An error is produced if any dependency is missing or the version | 3710 | An error is produced if any dependency is missing or the version |
3711 | numbers (if specified) do not match exactly. This variable is used in | 3711 | numbers (if specified) do not match exactly. This variable is used in |
@@ -3733,7 +3733,7 @@ system and gives an overview of their function and contents. | |||
3733 | ``LAYERRECOMMENDS_mylayer``). | 3733 | ``LAYERRECOMMENDS_mylayer``). |
3734 | 3734 | ||
3735 | LAYERSERIES_COMPAT | 3735 | LAYERSERIES_COMPAT |
3736 | Lists the versions of the `OpenEmbedded-Core <#oe-core>`__ for which | 3736 | Lists the versions of the :term:`OpenEmbedded-Core (OE-Core)` for which |
3737 | a layer is compatible. Using the ``LAYERSERIES_COMPAT`` variable | 3737 | a layer is compatible. Using the ``LAYERSERIES_COMPAT`` variable |
3738 | allows the layer maintainer to indicate which combinations of the | 3738 | allows the layer maintainer to indicate which combinations of the |
3739 | layer and OE-Core can be expected to work. The variable gives the | 3739 | layer and OE-Core can be expected to work. The variable gives the |
@@ -3762,7 +3762,7 @@ system and gives an overview of their function and contents. | |||
3762 | 3762 | ||
3763 | LAYERVERSION | 3763 | LAYERVERSION |
3764 | Optionally specifies the version of a layer as a single number. You | 3764 | Optionally specifies the version of a layer as a single number. You |
3765 | can use this within ```LAYERDEPENDS`` <#var-LAYERDEPENDS>`__ for | 3765 | can use this within :term:`LAYERDEPENDS` for |
3766 | another layer in order to depend on a specific version of the layer. | 3766 | another layer in order to depend on a specific version of the layer. |
3767 | This variable is used in the ``conf/layer.conf`` file and must be | 3767 | This variable is used in the ``conf/layer.conf`` file and must be |
3768 | suffixed with the name of the specific layer (e.g. | 3768 | suffixed with the name of the specific layer (e.g. |
@@ -3779,18 +3779,18 @@ system and gives an overview of their function and contents. | |||
3779 | Default initialization for ``LDFLAGS`` varies depending on what is | 3779 | Default initialization for ``LDFLAGS`` varies depending on what is |
3780 | being built: | 3780 | being built: |
3781 | 3781 | ||
3782 | - ```TARGET_LDFLAGS`` <#var-TARGET_LDFLAGS>`__ when building for the | 3782 | - :term:`TARGET_LDFLAGS` when building for the |
3783 | target | 3783 | target |
3784 | 3784 | ||
3785 | - ```BUILD_LDFLAGS`` <#var-BUILD_LDFLAGS>`__ when building for the | 3785 | - :term:`BUILD_LDFLAGS` when building for the |
3786 | build host (i.e. ``-native``) | 3786 | build host (i.e. ``-native``) |
3787 | 3787 | ||
3788 | - ```BUILDSDK_LDFLAGS`` <#var-BUILDSDK_LDFLAGS>`__ when building for | 3788 | - :term:`BUILDSDK_LDFLAGS` when building for |
3789 | an SDK (i.e. ``nativesdk-``) | 3789 | an SDK (i.e. ``nativesdk-``) |
3790 | 3790 | ||
3791 | LEAD_SONAME | 3791 | LEAD_SONAME |
3792 | Specifies the lead (or primary) compiled library file (i.e. ``.so``) | 3792 | Specifies the lead (or primary) compiled library file (i.e. ``.so``) |
3793 | that the ```debian`` <#ref-classes-debian>`__ class applies its | 3793 | that the :ref:`debian <ref-classes-debian>` class applies its |
3794 | naming policy to given a recipe that packages multiple libraries. | 3794 | naming policy to given a recipe that packages multiple libraries. |
3795 | 3795 | ||
3796 | This variable works in conjunction with the ``debian`` class. | 3796 | This variable works in conjunction with the ``debian`` class. |
@@ -3804,7 +3804,7 @@ system and gives an overview of their function and contents. | |||
3804 | license change. | 3804 | license change. |
3805 | 3805 | ||
3806 | This variable must be defined for all recipes (unless | 3806 | This variable must be defined for all recipes (unless |
3807 | ```LICENSE`` <#var-LICENSE>`__ is set to "CLOSED"). | 3807 | :term:`LICENSE` is set to "CLOSED"). |
3808 | 3808 | ||
3809 | For more information, see the "`Tracking License | 3809 | For more information, see the "`Tracking License |
3810 | Changes <&YOCTO_DOCS_DEV_URL;#usingpoky-configuring-LIC_FILES_CHKSUM>`__" | 3810 | Changes <&YOCTO_DOCS_DEV_URL;#usingpoky-configuring-LIC_FILES_CHKSUM>`__" |
@@ -3825,7 +3825,7 @@ system and gives an overview of their function and contents. | |||
3825 | 3825 | ||
3826 | - For standard licenses, use the names of the files in | 3826 | - For standard licenses, use the names of the files in |
3827 | ``meta/files/common-licenses/`` or the | 3827 | ``meta/files/common-licenses/`` or the |
3828 | ```SPDXLICENSEMAP`` <#var-SPDXLICENSEMAP>`__ flag names defined in | 3828 | :term:`SPDXLICENSEMAP` flag names defined in |
3829 | ``meta/conf/licenses.conf``. | 3829 | ``meta/conf/licenses.conf``. |
3830 | 3830 | ||
3831 | Here are some examples: LICENSE = "LGPLv2.1 \| GPLv3" LICENSE = | 3831 | Here are some examples: LICENSE = "LGPLv2.1 \| GPLv3" LICENSE = |
@@ -3847,34 +3847,34 @@ system and gives an overview of their function and contents. | |||
3847 | LICENSE_CREATE_PACKAGE | 3847 | LICENSE_CREATE_PACKAGE |
3848 | Setting ``LICENSE_CREATE_PACKAGE`` to "1" causes the OpenEmbedded | 3848 | Setting ``LICENSE_CREATE_PACKAGE`` to "1" causes the OpenEmbedded |
3849 | build system to create an extra package (i.e. | 3849 | build system to create an extra package (i.e. |
3850 | ``${``\ ```PN`` <#var-PN>`__\ ``}-lic``) for each recipe and to add | 3850 | ``${``\ :term:`PN`\ ``}-lic``) for each recipe and to add |
3851 | those packages to the | 3851 | those packages to the |
3852 | ```RRECOMMENDS`` <#var-RRECOMMENDS>`__\ ``_${PN}``. | 3852 | :term:`RRECOMMENDS`\ ``_${PN}``. |
3853 | 3853 | ||
3854 | The ``${PN}-lic`` package installs a directory in | 3854 | The ``${PN}-lic`` package installs a directory in |
3855 | ``/usr/share/licenses`` named ``${PN}``, which is the recipe's base | 3855 | ``/usr/share/licenses`` named ``${PN}``, which is the recipe's base |
3856 | name, and installs files in that directory that contain license and | 3856 | name, and installs files in that directory that contain license and |
3857 | copyright information (i.e. copies of the appropriate license files | 3857 | copyright information (i.e. copies of the appropriate license files |
3858 | from ``meta/common-licenses`` that match the licenses specified in | 3858 | from ``meta/common-licenses`` that match the licenses specified in |
3859 | the ```LICENSE`` <#var-LICENSE>`__ variable of the recipe metadata | 3859 | the :term:`LICENSE` variable of the recipe metadata |
3860 | and copies of files marked in | 3860 | and copies of files marked in |
3861 | ```LIC_FILES_CHKSUM`` <#var-LIC_FILES_CHKSUM>`__ as containing | 3861 | :term:`LIC_FILES_CHKSUM` as containing |
3862 | license text). | 3862 | license text). |
3863 | 3863 | ||
3864 | For related information on providing license text, see the | 3864 | For related information on providing license text, see the |
3865 | ```COPY_LIC_DIRS`` <#var-COPY_LIC_DIRS>`__ variable, the | 3865 | :term:`COPY_LIC_DIRS` variable, the |
3866 | ```COPY_LIC_MANIFEST`` <#var-COPY_LIC_MANIFEST>`__ variable, and the | 3866 | :term:`COPY_LIC_MANIFEST` variable, and the |
3867 | "`Providing License | 3867 | "`Providing License |
3868 | Text <&YOCTO_DOCS_DEV_URL;#providing-license-text>`__" section in the | 3868 | Text <&YOCTO_DOCS_DEV_URL;#providing-license-text>`__" section in the |
3869 | Yocto Project Development Tasks Manual. | 3869 | Yocto Project Development Tasks Manual. |
3870 | 3870 | ||
3871 | LICENSE_FLAGS | 3871 | LICENSE_FLAGS |
3872 | Specifies additional flags for a recipe you must whitelist through | 3872 | Specifies additional flags for a recipe you must whitelist through |
3873 | ```LICENSE_FLAGS_WHITELIST`` <#var-LICENSE_FLAGS_WHITELIST>`__ in | 3873 | :term:`LICENSE_FLAGS_WHITELIST` in |
3874 | order to allow the recipe to be built. When providing multiple flags, | 3874 | order to allow the recipe to be built. When providing multiple flags, |
3875 | separate them with spaces. | 3875 | separate them with spaces. |
3876 | 3876 | ||
3877 | This value is independent of ```LICENSE`` <#var-LICENSE>`__ and is | 3877 | This value is independent of :term:`LICENSE` and is |
3878 | typically used to mark recipes that might require additional licenses | 3878 | typically used to mark recipes that might require additional licenses |
3879 | in order to be used in a commercial product. For more information, | 3879 | in order to be used in a commercial product. For more information, |
3880 | see the "`Enabling Commercially Licensed | 3880 | see the "`Enabling Commercially Licensed |
@@ -3883,7 +3883,7 @@ system and gives an overview of their function and contents. | |||
3883 | 3883 | ||
3884 | LICENSE_FLAGS_WHITELIST | 3884 | LICENSE_FLAGS_WHITELIST |
3885 | Lists license flags that when specified in | 3885 | Lists license flags that when specified in |
3886 | ```LICENSE_FLAGS`` <#var-LICENSE_FLAGS>`__ within a recipe should not | 3886 | :term:`LICENSE_FLAGS` within a recipe should not |
3887 | prevent that recipe from being built. This practice is otherwise | 3887 | prevent that recipe from being built. This practice is otherwise |
3888 | known as "whitelisting" license flags. For more information, see the | 3888 | known as "whitelisting" license flags. For more information, see the |
3889 | "`Enabling Commercially Licensed | 3889 | "`Enabling Commercially Licensed |
@@ -3907,10 +3907,10 @@ system and gives an overview of their function and contents. | |||
3907 | kernel types. | 3907 | kernel types. |
3908 | 3908 | ||
3909 | If you do not specify a ``LINUX_KERNEL_TYPE``, it defaults to | 3909 | If you do not specify a ``LINUX_KERNEL_TYPE``, it defaults to |
3910 | "standard". Together with ```KMACHINE`` <#var-KMACHINE>`__, the | 3910 | "standard". Together with :term:`KMACHINE`, the |
3911 | ``LINUX_KERNEL_TYPE`` variable defines the search arguments used by | 3911 | ``LINUX_KERNEL_TYPE`` variable defines the search arguments used by |
3912 | the kernel tools to find the appropriate description within the | 3912 | the kernel tools to find the appropriate description within the |
3913 | kernel `Metadata <#metadata>`__ with which to build out the sources | 3913 | kernel :term:`Metadata` with which to build out the sources |
3914 | and configuration. | 3914 | and configuration. |
3915 | 3915 | ||
3916 | LINUX_VERSION | 3916 | LINUX_VERSION |
@@ -3921,7 +3921,7 @@ system and gives an overview of their function and contents. | |||
3921 | ``meta/recipes-kernel/linux`` defines the variables as follows: | 3921 | ``meta/recipes-kernel/linux`` defines the variables as follows: |
3922 | LINUX_VERSION ?= "3.4.24" | 3922 | LINUX_VERSION ?= "3.4.24" |
3923 | 3923 | ||
3924 | The ``LINUX_VERSION`` variable is used to define ```PV`` <#var-PV>`__ | 3924 | The ``LINUX_VERSION`` variable is used to define :term:`PV` |
3925 | for the recipe: PV = "${LINUX_VERSION}+git${SRCPV}" | 3925 | for the recipe: PV = "${LINUX_VERSION}+git${SRCPV}" |
3926 | 3926 | ||
3927 | LINUX_VERSION_EXTENSION | 3927 | LINUX_VERSION_EXTENSION |
@@ -3929,7 +3929,7 @@ system and gives an overview of their function and contents. | |||
3929 | kernel built with the OpenEmbedded build system. You define this | 3929 | kernel built with the OpenEmbedded build system. You define this |
3930 | variable in the kernel recipe. For example, the linux-yocto kernel | 3930 | variable in the kernel recipe. For example, the linux-yocto kernel |
3931 | recipes all define the variable as follows: LINUX_VERSION_EXTENSION | 3931 | recipes all define the variable as follows: LINUX_VERSION_EXTENSION |
3932 | ?= "-yocto-${`LINUX_KERNEL_TYPE <#var-LINUX_KERNEL_TYPE>`__}" | 3932 | ?= "-yocto-${:term:`LINUX_KERNEL_TYPE`}" |
3933 | 3933 | ||
3934 | Defining this variable essentially sets the Linux kernel | 3934 | Defining this variable essentially sets the Linux kernel |
3935 | configuration item ``CONFIG_LOCALVERSION``, which is visible through | 3935 | configuration item ``CONFIG_LOCALVERSION``, which is visible through |
@@ -3941,7 +3941,7 @@ system and gives an overview of their function and contents. | |||
3941 | overall log files. The default directory is ``${TMPDIR}/log``. | 3941 | overall log files. The default directory is ``${TMPDIR}/log``. |
3942 | 3942 | ||
3943 | For the directory containing logs specific to each task, see the | 3943 | For the directory containing logs specific to each task, see the |
3944 | ```T`` <#var-T>`__ variable. | 3944 | :term:`T` variable. |
3945 | 3945 | ||
3946 | MACHINE | 3946 | MACHINE |
3947 | Specifies the target device for which the image is built. You define | 3947 | Specifies the target device for which the image is built. You define |
@@ -3954,7 +3954,7 @@ system and gives an overview of their function and contents. | |||
3954 | name, through which machine-specific configurations are set. Thus, | 3954 | name, through which machine-specific configurations are set. Thus, |
3955 | when ``MACHINE`` is set to "qemux86" there exists the corresponding | 3955 | when ``MACHINE`` is set to "qemux86" there exists the corresponding |
3956 | ``qemux86.conf`` machine configuration file, which can be found in | 3956 | ``qemux86.conf`` machine configuration file, which can be found in |
3957 | the `Source Directory <#source-directory>`__ in | 3957 | the :term:`Source Directory` in |
3958 | ``meta/conf/machine``. | 3958 | ``meta/conf/machine``. |
3959 | 3959 | ||
3960 | The list of machines supported by the Yocto Project as shipped | 3960 | The list of machines supported by the Yocto Project as shipped |
@@ -3974,8 +3974,8 @@ system and gives an overview of their function and contents. | |||
3974 | 3974 | ||
3975 | MACHINE_ARCH | 3975 | MACHINE_ARCH |
3976 | Specifies the name of the machine-specific architecture. This | 3976 | Specifies the name of the machine-specific architecture. This |
3977 | variable is set automatically from ```MACHINE`` <#var-MACHINE>`__ or | 3977 | variable is set automatically from :term:`MACHINE` or |
3978 | ```TUNE_PKGARCH`` <#var-TUNE_PKGARCH>`__. You should not hand-edit | 3978 | :term:`TUNE_PKGARCH`. You should not hand-edit |
3979 | the ``MACHINE_ARCH`` variable. | 3979 | the ``MACHINE_ARCH`` variable. |
3980 | 3980 | ||
3981 | MACHINE_ESSENTIAL_EXTRA_RDEPENDS | 3981 | MACHINE_ESSENTIAL_EXTRA_RDEPENDS |
@@ -4094,11 +4094,11 @@ system and gives an overview of their function and contents. | |||
4094 | 4094 | ||
4095 | MACHINE_FEATURES | 4095 | MACHINE_FEATURES |
4096 | Specifies the list of hardware features the | 4096 | Specifies the list of hardware features the |
4097 | ```MACHINE`` <#var-MACHINE>`__ is capable of supporting. For related | 4097 | :term:`MACHINE` is capable of supporting. For related |
4098 | information on enabling features, see the | 4098 | information on enabling features, see the |
4099 | ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__, | 4099 | :term:`DISTRO_FEATURES`, |
4100 | ```COMBINED_FEATURES`` <#var-COMBINED_FEATURES>`__, and | 4100 | :term:`COMBINED_FEATURES`, and |
4101 | ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ variables. | 4101 | :term:`IMAGE_FEATURES` variables. |
4102 | 4102 | ||
4103 | For a list of hardware features supported by the Yocto Project as | 4103 | For a list of hardware features supported by the Yocto Project as |
4104 | shipped, see the "`Machine Features <#ref-features-machine>`__" | 4104 | shipped, see the "`Machine Features <#ref-features-machine>`__" |
@@ -4124,7 +4124,7 @@ system and gives an overview of their function and contents. | |||
4124 | MACHINEOVERRIDES | 4124 | MACHINEOVERRIDES |
4125 | A colon-separated list of overrides that apply to the current | 4125 | A colon-separated list of overrides that apply to the current |
4126 | machine. By default, this list includes the value of | 4126 | machine. By default, this list includes the value of |
4127 | ```MACHINE`` <#var-MACHINE>`__. | 4127 | :term:`MACHINE`. |
4128 | 4128 | ||
4129 | You can extend ``MACHINEOVERRIDES`` to add extra overrides that | 4129 | You can extend ``MACHINEOVERRIDES`` to add extra overrides that |
4130 | should apply to a machine. For example, all machines emulated in QEMU | 4130 | should apply to a machine. For example, all machines emulated in QEMU |
@@ -4136,7 +4136,7 @@ system and gives an overview of their function and contents. | |||
4136 | recipe: SRC_URI_append_qemuall = "file://wired.config \\ | 4136 | recipe: SRC_URI_append_qemuall = "file://wired.config \\ |
4137 | file://wired-setup \\ " The underlying mechanism behind | 4137 | file://wired-setup \\ " The underlying mechanism behind |
4138 | ``MACHINEOVERRIDES`` is simply that it is included in the default | 4138 | ``MACHINEOVERRIDES`` is simply that it is included in the default |
4139 | value of ```OVERRIDES`` <#var-OVERRIDES>`__. | 4139 | value of :term:`OVERRIDES`. |
4140 | 4140 | ||
4141 | MAINTAINER | 4141 | MAINTAINER |
4142 | The email address of the distribution maintainer. | 4142 | The email address of the distribution maintainer. |
@@ -4146,18 +4146,18 @@ system and gives an overview of their function and contents. | |||
4146 | gets source code. When the build system searches for source code, it | 4146 | gets source code. When the build system searches for source code, it |
4147 | first tries the local download directory. If that location fails, the | 4147 | first tries the local download directory. If that location fails, the |
4148 | build system tries locations defined by | 4148 | build system tries locations defined by |
4149 | ```PREMIRRORS`` <#var-PREMIRRORS>`__, the upstream source, and then | 4149 | :term:`PREMIRRORS`, the upstream source, and then |
4150 | locations specified by ``MIRRORS`` in that order. | 4150 | locations specified by ``MIRRORS`` in that order. |
4151 | 4151 | ||
4152 | Assuming your distribution (```DISTRO`` <#var-DISTRO>`__) is "poky", | 4152 | Assuming your distribution (:term:`DISTRO`) is "poky", |
4153 | the default value for ``MIRRORS`` is defined in the | 4153 | the default value for ``MIRRORS`` is defined in the |
4154 | ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. | 4154 | ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. |
4155 | 4155 | ||
4156 | MLPREFIX | 4156 | MLPREFIX |
4157 | Specifies a prefix has been added to ```PN`` <#var-PN>`__ to create a | 4157 | Specifies a prefix has been added to :term:`PN` to create a |
4158 | special version of a recipe or package (i.e. a Multilib version). The | 4158 | special version of a recipe or package (i.e. a Multilib version). The |
4159 | variable is used in places where the prefix needs to be added to or | 4159 | variable is used in places where the prefix needs to be added to or |
4160 | removed from a the name (e.g. the ```BPN`` <#var-BPN>`__ variable). | 4160 | removed from a the name (e.g. the :term:`BPN` variable). |
4161 | ``MLPREFIX`` gets set when a prefix has been added to ``PN``. | 4161 | ``MLPREFIX`` gets set when a prefix has been added to ``PN``. |
4162 | 4162 | ||
4163 | .. note:: | 4163 | .. note:: |
@@ -4174,10 +4174,10 @@ system and gives an overview of their function and contents. | |||
4174 | for it as well. | 4174 | for it as well. |
4175 | 4175 | ||
4176 | To help understand when ``MLPREFIX`` might be needed, consider when | 4176 | To help understand when ``MLPREFIX`` might be needed, consider when |
4177 | ```BBCLASSEXTEND`` <#var-BBCLASSEXTEND>`__ is used to provide a | 4177 | :term:`BBCLASSEXTEND` is used to provide a |
4178 | ``nativesdk`` version of a recipe in addition to the target version. | 4178 | ``nativesdk`` version of a recipe in addition to the target version. |
4179 | If that recipe declares build-time dependencies on tasks in other | 4179 | If that recipe declares build-time dependencies on tasks in other |
4180 | recipes by using ```DEPENDS`` <#var-DEPENDS>`__, then a dependency on | 4180 | recipes by using :term:`DEPENDS`, then a dependency on |
4181 | "foo" will automatically get rewritten to a dependency on | 4181 | "foo" will automatically get rewritten to a dependency on |
4182 | "nativesdk-foo". However, dependencies like the following will not | 4182 | "nativesdk-foo". However, dependencies like the following will not |
4183 | get rewritten automatically: do_foo[depends] += "recipe:do_foo" If | 4183 | get rewritten automatically: do_foo[depends] += "recipe:do_foo" If |
@@ -4191,7 +4191,7 @@ system and gives an overview of their function and contents. | |||
4191 | module_autoload_rfcomm = "rfcomm" | 4191 | module_autoload_rfcomm = "rfcomm" |
4192 | 4192 | ||
4193 | should now be replaced with: KERNEL_MODULE_AUTOLOAD += "rfcomm" See | 4193 | should now be replaced with: KERNEL_MODULE_AUTOLOAD += "rfcomm" See |
4194 | the ```KERNEL_MODULE_AUTOLOAD`` <#var-KERNEL_MODULE_AUTOLOAD>`__ | 4194 | the :term:`KERNEL_MODULE_AUTOLOAD` |
4195 | variable for more information. | 4195 | variable for more information. |
4196 | 4196 | ||
4197 | module_conf | 4197 | module_conf |
@@ -4204,7 +4204,7 @@ system and gives an overview of their function and contents. | |||
4204 | configuration file, a distribution configuration file, an append file | 4204 | configuration file, a distribution configuration file, an append file |
4205 | for the recipe, or the recipe itself). If you use this variable, you | 4205 | for the recipe, or the recipe itself). If you use this variable, you |
4206 | must also be sure to list the module name in the | 4206 | must also be sure to list the module name in the |
4207 | ```KERNEL_MODULE_AUTOLOAD`` <#var-KERNEL_MODULE_AUTOLOAD>`__ | 4207 | :term:`KERNEL_MODULE_AUTOLOAD` |
4208 | variable. | 4208 | variable. |
4209 | 4209 | ||
4210 | Here is the general syntax: module_conf_module_name = | 4210 | Here is the general syntax: module_conf_module_name = |
@@ -4221,7 +4221,7 @@ system and gives an overview of their function and contents. | |||
4221 | 4221 | ||
4222 | For information on how to specify kernel modules to auto-load on | 4222 | For information on how to specify kernel modules to auto-load on |
4223 | boot, see the | 4223 | boot, see the |
4224 | ```KERNEL_MODULE_AUTOLOAD`` <#var-KERNEL_MODULE_AUTOLOAD>`__ | 4224 | :term:`KERNEL_MODULE_AUTOLOAD` |
4225 | variable. | 4225 | variable. |
4226 | 4226 | ||
4227 | MODULE_TARBALL_DEPLOY | 4227 | MODULE_TARBALL_DEPLOY |
@@ -4237,14 +4237,14 @@ system and gives an overview of their function and contents. | |||
4237 | same file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= | 4237 | same file, has the following value: KERNEL_ARTIFACT_LINK_NAME ?= |
4238 | "${MACHINE}" | 4238 | "${MACHINE}" |
4239 | 4239 | ||
4240 | See the ```MACHINE`` <#var-MACHINE>`__ variable for additional | 4240 | See the :term:`MACHINE` variable for additional |
4241 | information. | 4241 | information. |
4242 | 4242 | ||
4243 | MODULE_TARBALL_NAME | 4243 | MODULE_TARBALL_NAME |
4244 | The base name of the kernel module tarball. This variable is set in | 4244 | The base name of the kernel module tarball. This variable is set in |
4245 | the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: | 4245 | the ``meta/classes/kernel-artifact-names.bbclass`` file as follows: |
4246 | MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" The value of the | 4246 | MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}" The value of the |
4247 | ```KERNEL_ARTIFACT_NAME`` <#var-KERNEL_ARTIFACT_NAME>`__ variable, | 4247 | :term:`KERNEL_ARTIFACT_NAME` variable, |
4248 | which is set in the same file, has the following value: | 4248 | which is set in the same file, has the following value: |
4249 | KERNEL_ARTIFACT_NAME ?= | 4249 | KERNEL_ARTIFACT_NAME ?= |
4250 | "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 4250 | "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
@@ -4257,11 +4257,11 @@ system and gives an overview of their function and contents. | |||
4257 | 4257 | ||
4258 | The default value of this variable is: | 4258 | The default value of this variable is: |
4259 | ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS} Some classes (e.g. | 4259 | ${PACKAGE_ARCH}${TARGET_VENDOR}-${TARGET_OS} Some classes (e.g. |
4260 | ```cross-canadian`` <#ref-classes-cross-canadian>`__) modify the | 4260 | :ref:`cross-canadian <ref-classes-cross-canadian>`) modify the |
4261 | ``MULTIMACH_TARGET_SYS`` value. | 4261 | ``MULTIMACH_TARGET_SYS`` value. |
4262 | 4262 | ||
4263 | See the ```STAMP`` <#var-STAMP>`__ variable for an example. See the | 4263 | See the :term:`STAMP` variable for an example. See the |
4264 | ```STAGING_DIR_TARGET`` <#var-STAGING_DIR_TARGET>`__ variable for | 4264 | :term:`STAGING_DIR_TARGET` variable for |
4265 | more information. | 4265 | more information. |
4266 | 4266 | ||
4267 | NATIVELSBSTRING | 4267 | NATIVELSBSTRING |
@@ -4276,7 +4276,7 @@ system and gives an overview of their function and contents. | |||
4276 | packages for different distributions (e.g. to avoid problems with | 4276 | packages for different distributions (e.g. to avoid problems with |
4277 | ``glibc`` version incompatibilities). Additionally, the variable is | 4277 | ``glibc`` version incompatibilities). Additionally, the variable is |
4278 | checked against | 4278 | checked against |
4279 | ```SANITY_TESTED_DISTROS`` <#var-SANITY_TESTED_DISTROS>`__ if that | 4279 | :term:`SANITY_TESTED_DISTROS` if that |
4280 | variable is set. | 4280 | variable is set. |
4281 | 4281 | ||
4282 | NM | 4282 | NM |
@@ -4300,7 +4300,7 @@ system and gives an overview of their function and contents. | |||
4300 | NO_RECOMMENDATIONS | 4300 | NO_RECOMMENDATIONS |
4301 | Prevents installation of all "recommended-only" packages. | 4301 | Prevents installation of all "recommended-only" packages. |
4302 | Recommended-only packages are packages installed only through the | 4302 | Recommended-only packages are packages installed only through the |
4303 | ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ variable). Setting the | 4303 | :term:`RRECOMMENDS` variable). Setting the |
4304 | ``NO_RECOMMENDATIONS`` variable to "1" turns this feature on: | 4304 | ``NO_RECOMMENDATIONS`` variable to "1" turns this feature on: |
4305 | NO_RECOMMENDATIONS = "1" | 4305 | NO_RECOMMENDATIONS = "1" |
4306 | 4306 | ||
@@ -4310,7 +4310,7 @@ system and gives an overview of their function and contents. | |||
4310 | 4310 | ||
4311 | It is important to realize that if you choose to not install packages | 4311 | It is important to realize that if you choose to not install packages |
4312 | using this variable and some other packages are dependent on them | 4312 | using this variable and some other packages are dependent on them |
4313 | (i.e. listed in a recipe's ```RDEPENDS`` <#var-RDEPENDS>`__ | 4313 | (i.e. listed in a recipe's :term:`RDEPENDS` |
4314 | variable), the OpenEmbedded build system ignores your request and | 4314 | variable), the OpenEmbedded build system ignores your request and |
4315 | will install the packages to avoid dependency errors. | 4315 | will install the packages to avoid dependency errors. |
4316 | 4316 | ||
@@ -4325,8 +4325,8 @@ system and gives an overview of their function and contents. | |||
4325 | Support for this variable exists only when using the IPK and RPM | 4325 | Support for this variable exists only when using the IPK and RPM |
4326 | packaging backend. Support does not exist for DEB. | 4326 | packaging backend. Support does not exist for DEB. |
4327 | 4327 | ||
4328 | See the ```BAD_RECOMMENDATIONS`` <#var-BAD_RECOMMENDATIONS>`__ and | 4328 | See the :term:`BAD_RECOMMENDATIONS` and |
4329 | the ```PACKAGE_EXCLUDE`` <#var-PACKAGE_EXCLUDE>`__ variables for | 4329 | the :term:`PACKAGE_EXCLUDE` variables for |
4330 | related information. | 4330 | related information. |
4331 | 4331 | ||
4332 | NOAUTOPACKAGEDEBUG | 4332 | NOAUTOPACKAGEDEBUG |
@@ -4345,7 +4345,7 @@ system and gives an overview of their function and contents. | |||
4345 | The minimal command and arguments to run ``objdump``. | 4345 | The minimal command and arguments to run ``objdump``. |
4346 | 4346 | ||
4347 | OE_BINCONFIG_EXTRA_MANGLE | 4347 | OE_BINCONFIG_EXTRA_MANGLE |
4348 | When inheriting the ```binconfig`` <#ref-classes-binconfig>`__ class, | 4348 | When inheriting the :ref:`binconfig <ref-classes-binconfig>` class, |
4349 | this variable specifies additional arguments passed to the "sed" | 4349 | this variable specifies additional arguments passed to the "sed" |
4350 | command. The sed command alters any paths in configuration scripts | 4350 | command. The sed command alters any paths in configuration scripts |
4351 | that have been set up during compilation. Inheriting this class | 4351 | that have been set up during compilation. Inheriting this class |
@@ -4357,7 +4357,7 @@ system and gives an overview of their function and contents. | |||
4357 | Directory <#source-directory>`__ for details on how this class | 4357 | Directory <#source-directory>`__ for details on how this class |
4358 | applies these additional sed command arguments. For general | 4358 | applies these additional sed command arguments. For general |
4359 | information on the ``binconfig`` class, see the | 4359 | information on the ``binconfig`` class, see the |
4360 | "```binconfig.bbclass`` <#ref-classes-binconfig>`__" section. | 4360 | ":ref:`binconfig.bbclass <ref-classes-binconfig>`" section. |
4361 | 4361 | ||
4362 | OE_IMPORTS | 4362 | OE_IMPORTS |
4363 | An internal variable used to tell the OpenEmbedded build system what | 4363 | An internal variable used to tell the OpenEmbedded build system what |
@@ -4424,9 +4424,9 @@ system and gives an overview of their function and contents. | |||
4424 | overrides mechanism. | 4424 | overrides mechanism. |
4425 | 4425 | ||
4426 | The default value of ``OVERRIDES`` includes the values of the | 4426 | The default value of ``OVERRIDES`` includes the values of the |
4427 | ```CLASSOVERRIDE`` <#var-CLASSOVERRIDE>`__, | 4427 | :term:`CLASSOVERRIDE`, |
4428 | ```MACHINEOVERRIDES`` <#var-MACHINEOVERRIDES>`__, and | 4428 | :term:`MACHINEOVERRIDES`, and |
4429 | ```DISTROOVERRIDES`` <#var-DISTROOVERRIDES>`__ variables. Another | 4429 | :term:`DISTROOVERRIDES` variables. Another |
4430 | important override included by default is ``pn-${PN}``. This override | 4430 | important override included by default is ``pn-${PN}``. This override |
4431 | allows variables to be set for a single recipe within configuration | 4431 | allows variables to be set for a single recipe within configuration |
4432 | (``.conf``) files. Here is an example: FOO_pn-myrecipe = | 4432 | (``.conf``) files. Here is an example: FOO_pn-myrecipe = |
@@ -4468,8 +4468,8 @@ system and gives an overview of their function and contents. | |||
4468 | The architecture of the resulting package or packages. | 4468 | The architecture of the resulting package or packages. |
4469 | 4469 | ||
4470 | By default, the value of this variable is set to | 4470 | By default, the value of this variable is set to |
4471 | ```TUNE_PKGARCH`` <#var-TUNE_PKGARCH>`__ when building for the | 4471 | :term:`TUNE_PKGARCH` when building for the |
4472 | target, ```BUILD_ARCH`` <#var-BUILD_ARCH>`__ when building for the | 4472 | target, :term:`BUILD_ARCH` when building for the |
4473 | build host, and "${SDK_ARCH}-${SDKPKGSUFFIX}" when building for the | 4473 | build host, and "${SDK_ARCH}-${SDKPKGSUFFIX}" when building for the |
4474 | SDK. | 4474 | SDK. |
4475 | 4475 | ||
@@ -4482,7 +4482,7 @@ system and gives an overview of their function and contents. | |||
4482 | However, if your recipe's output packages are built specific to the | 4482 | However, if your recipe's output packages are built specific to the |
4483 | target machine rather than generally for the architecture of the | 4483 | target machine rather than generally for the architecture of the |
4484 | machine, you should set ``PACKAGE_ARCH`` to the value of | 4484 | machine, you should set ``PACKAGE_ARCH`` to the value of |
4485 | ```MACHINE_ARCH`` <#var-MACHINE_ARCH>`__ in the recipe as follows: | 4485 | :term:`MACHINE_ARCH` in the recipe as follows: |
4486 | PACKAGE_ARCH = "${MACHINE_ARCH}" | 4486 | PACKAGE_ARCH = "${MACHINE_ARCH}" |
4487 | 4487 | ||
4488 | PACKAGE_ARCHS | 4488 | PACKAGE_ARCHS |
@@ -4524,7 +4524,7 @@ system and gives an overview of their function and contents. | |||
4524 | 4524 | ||
4525 | For information on packaging and build performance effects as a | 4525 | For information on packaging and build performance effects as a |
4526 | result of the package manager in use, see the | 4526 | result of the package manager in use, see the |
4527 | "```package.bbclass`` <#ref-classes-package>`__" section. | 4527 | ":ref:`package.bbclass <ref-classes-package>`" section. |
4528 | 4528 | ||
4529 | PACKAGE_DEBUG_SPLIT_STYLE | 4529 | PACKAGE_DEBUG_SPLIT_STYLE |
4530 | Determines how to split up the binary and debug information when | 4530 | Determines how to split up the binary and debug information when |
@@ -4566,7 +4566,7 @@ system and gives an overview of their function and contents. | |||
4566 | 4566 | ||
4567 | You might find that you want to prevent installing certain packages | 4567 | You might find that you want to prevent installing certain packages |
4568 | when you are installing complementary packages. For example, if you | 4568 | when you are installing complementary packages. For example, if you |
4569 | are using ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__ to install | 4569 | are using :term:`IMAGE_FEATURES` to install |
4570 | ``dev-pkgs``, you might not want to install all packages from a | 4570 | ``dev-pkgs``, you might not want to install all packages from a |
4571 | particular multilib. If you find yourself in this situation, you can | 4571 | particular multilib. If you find yourself in this situation, you can |
4572 | use the ``PACKAGE_EXCLUDE_COMPLEMENTARY`` variable to specify regular | 4572 | use the ``PACKAGE_EXCLUDE_COMPLEMENTARY`` variable to specify regular |
@@ -4583,7 +4583,7 @@ system and gives an overview of their function and contents. | |||
4583 | 4583 | ||
4584 | If you choose to not install a package using this variable and some | 4584 | If you choose to not install a package using this variable and some |
4585 | other package is dependent on it (i.e. listed in a recipe's | 4585 | other package is dependent on it (i.e. listed in a recipe's |
4586 | ```RDEPENDS`` <#var-RDEPENDS>`__ variable), the OpenEmbedded build | 4586 | :term:`RDEPENDS` variable), the OpenEmbedded build |
4587 | system generates a fatal installation error. Because the build system | 4587 | system generates a fatal installation error. Because the build system |
4588 | halts the process with a fatal error, you can use the variable with | 4588 | halts the process with a fatal error, you can use the variable with |
4589 | an iterative development process to remove specific components from a | 4589 | an iterative development process to remove specific components from a |
@@ -4592,8 +4592,8 @@ system and gives an overview of their function and contents. | |||
4592 | Support for this variable exists only when using the IPK and RPM | 4592 | Support for this variable exists only when using the IPK and RPM |
4593 | packaging backend. Support does not exist for DEB. | 4593 | packaging backend. Support does not exist for DEB. |
4594 | 4594 | ||
4595 | See the ```NO_RECOMMENDATIONS`` <#var-NO_RECOMMENDATIONS>`__ and the | 4595 | See the :term:`NO_RECOMMENDATIONS` and the |
4596 | ```BAD_RECOMMENDATIONS`` <#var-BAD_RECOMMENDATIONS>`__ variables for | 4596 | :term:`BAD_RECOMMENDATIONS` variables for |
4597 | related information. | 4597 | related information. |
4598 | 4598 | ||
4599 | PACKAGE_EXTRA_ARCHS | 4599 | PACKAGE_EXTRA_ARCHS |
@@ -4606,8 +4606,8 @@ system and gives an overview of their function and contents. | |||
4606 | package feed URIs during the build. When used, the | 4606 | package feed URIs during the build. When used, the |
4607 | ``PACKAGE_FEED_ARCHS`` variable is appended to the final package feed | 4607 | ``PACKAGE_FEED_ARCHS`` variable is appended to the final package feed |
4608 | URI, which is constructed using the | 4608 | URI, which is constructed using the |
4609 | ```PACKAGE_FEED_URIS`` <#var-PACKAGE_FEED_URIS>`__ and | 4609 | :term:`PACKAGE_FEED_URIS` and |
4610 | ```PACKAGE_FEED_BASE_PATHS`` <#var-PACKAGE_FEED_BASE_PATHS>`__ | 4610 | :term:`PACKAGE_FEED_BASE_PATHS` |
4611 | variables. | 4611 | variables. |
4612 | 4612 | ||
4613 | .. note:: | 4613 | .. note:: |
@@ -4640,8 +4640,8 @@ system and gives an overview of their function and contents. | |||
4640 | Specifies the base path used when constructing package feed URIs. The | 4640 | Specifies the base path used when constructing package feed URIs. The |
4641 | ``PACKAGE_FEED_BASE_PATHS`` variable makes up the middle portion of a | 4641 | ``PACKAGE_FEED_BASE_PATHS`` variable makes up the middle portion of a |
4642 | package feed URI used by the OpenEmbedded build system. The base path | 4642 | package feed URI used by the OpenEmbedded build system. The base path |
4643 | lies between the ```PACKAGE_FEED_URIS`` <#var-PACKAGE_FEED_URIS>`__ | 4643 | lies between the :term:`PACKAGE_FEED_URIS` |
4644 | and ```PACKAGE_FEED_ARCHS`` <#var-PACKAGE_FEED_ARCHS>`__ variables. | 4644 | and :term:`PACKAGE_FEED_ARCHS` variables. |
4645 | 4645 | ||
4646 | Consider the following example where the ``PACKAGE_FEED_URIS``, | 4646 | Consider the following example where the ``PACKAGE_FEED_URIS``, |
4647 | ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are | 4647 | ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are |
@@ -4663,8 +4663,8 @@ system and gives an overview of their function and contents. | |||
4663 | Specifies the front portion of the package feed URI used by the | 4663 | Specifies the front portion of the package feed URI used by the |
4664 | OpenEmbedded build system. Each final package feed URI is comprised | 4664 | OpenEmbedded build system. Each final package feed URI is comprised |
4665 | of ``PACKAGE_FEED_URIS``, | 4665 | of ``PACKAGE_FEED_URIS``, |
4666 | ```PACKAGE_FEED_BASE_PATHS`` <#var-PACKAGE_FEED_BASE_PATHS>`__, and | 4666 | :term:`PACKAGE_FEED_BASE_PATHS`, and |
4667 | ```PACKAGE_FEED_ARCHS`` <#var-PACKAGE_FEED_ARCHS>`__ variables. | 4667 | :term:`PACKAGE_FEED_ARCHS` variables. |
4668 | 4668 | ||
4669 | Consider the following example where the ``PACKAGE_FEED_URIS``, | 4669 | Consider the following example where the ``PACKAGE_FEED_URIS``, |
4670 | ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are | 4670 | ``PACKAGE_FEED_BASE_PATHS``, and ``PACKAGE_FEED_ARCHS`` variables are |
@@ -4691,7 +4691,7 @@ system and gives an overview of their function and contents. | |||
4691 | not the final list of packages that are actually installed. This | 4691 | not the final list of packages that are actually installed. This |
4692 | variable is internal to the image construction code. Consequently, in | 4692 | variable is internal to the image construction code. Consequently, in |
4693 | general, you should use the | 4693 | general, you should use the |
4694 | ```IMAGE_INSTALL`` <#var-IMAGE_INSTALL>`__ variable to specify | 4694 | :term:`IMAGE_INSTALL` variable to specify |
4695 | packages for installation. The exception to this is when working with | 4695 | packages for installation. The exception to this is when working with |
4696 | the | 4696 | the |
4697 | ```core-image-minimal-initramfs`` <#images-core-image-minimal-initramfs>`__ | 4697 | ```core-image-minimal-initramfs`` <#images-core-image-minimal-initramfs>`__ |
@@ -4709,7 +4709,7 @@ system and gives an overview of their function and contents. | |||
4709 | 4709 | ||
4710 | PACKAGE_PREPROCESS_FUNCS | 4710 | PACKAGE_PREPROCESS_FUNCS |
4711 | Specifies a list of functions run to pre-process the | 4711 | Specifies a list of functions run to pre-process the |
4712 | ```PKGD`` <#var-PKGD>`__ directory prior to splitting the files out | 4712 | :term:`PKGD` directory prior to splitting the files out |
4713 | to individual packages. | 4713 | to individual packages. |
4714 | 4714 | ||
4715 | PACKAGE_WRITE_DEPS | 4715 | PACKAGE_WRITE_DEPS |
@@ -4744,21 +4744,21 @@ system and gives an overview of their function and contents. | |||
4744 | order is important and specifies the following: | 4744 | order is important and specifies the following: |
4745 | 4745 | ||
4746 | 1. Extra arguments that should be added to the configure script | 4746 | 1. Extra arguments that should be added to the configure script |
4747 | argument list (```EXTRA_OECONF`` <#var-EXTRA_OECONF>`__ or | 4747 | argument list (:term:`EXTRA_OECONF` or |
4748 | ```PACKAGECONFIG_CONFARGS`` <#var-PACKAGECONFIG_CONFARGS>`__) if | 4748 | :term:`PACKAGECONFIG_CONFARGS`) if |
4749 | the feature is enabled. | 4749 | the feature is enabled. |
4750 | 4750 | ||
4751 | 2. Extra arguments that should be added to ``EXTRA_OECONF`` or | 4751 | 2. Extra arguments that should be added to ``EXTRA_OECONF`` or |
4752 | ``PACKAGECONFIG_CONFARGS`` if the feature is disabled. | 4752 | ``PACKAGECONFIG_CONFARGS`` if the feature is disabled. |
4753 | 4753 | ||
4754 | 3. Additional build dependencies (```DEPENDS`` <#var-DEPENDS>`__) | 4754 | 3. Additional build dependencies (:term:`DEPENDS`) |
4755 | that should be added if the feature is enabled. | 4755 | that should be added if the feature is enabled. |
4756 | 4756 | ||
4757 | 4. Additional runtime dependencies (```RDEPENDS`` <#var-RDEPENDS>`__) | 4757 | 4. Additional runtime dependencies (:term:`RDEPENDS`) |
4758 | that should be added if the feature is enabled. | 4758 | that should be added if the feature is enabled. |
4759 | 4759 | ||
4760 | 5. Additional runtime recommendations | 4760 | 5. Additional runtime recommendations |
4761 | (```RRECOMMENDS`` <#var-RRECOMMENDS>`__) that should be added if | 4761 | (:term:`RRECOMMENDS`) that should be added if |
4762 | the feature is enabled. | 4762 | the feature is enabled. |
4763 | 4763 | ||
4764 | 6. Any conflicting (that is, mutually exclusive) ``PACKAGECONFIG`` | 4764 | 6. Any conflicting (that is, mutually exclusive) ``PACKAGECONFIG`` |
@@ -4797,10 +4797,10 @@ system and gives an overview of their function and contents. | |||
4797 | 4797 | ||
4798 | PACKAGECONFIG_CONFARGS | 4798 | PACKAGECONFIG_CONFARGS |
4799 | A space-separated list of configuration options generated from the | 4799 | A space-separated list of configuration options generated from the |
4800 | ```PACKAGECONFIG`` <#var-PACKAGECONFIG>`__ setting. | 4800 | :term:`PACKAGECONFIG` setting. |
4801 | 4801 | ||
4802 | Classes such as ```autotools`` <#ref-classes-autotools>`__ and | 4802 | Classes such as :ref:`autotools <ref-classes-autotools>` and |
4803 | ```cmake`` <#ref-classes-cmake>`__ use ``PACKAGECONFIG_CONFARGS`` to | 4803 | :ref:`cmake <ref-classes-cmake>` use ``PACKAGECONFIG_CONFARGS`` to |
4804 | pass ``PACKAGECONFIG`` options to ``configure`` and ``cmake``, | 4804 | pass ``PACKAGECONFIG`` options to ``configure`` and ``cmake``, |
4805 | respectively. If you are using ``PACKAGECONFIG`` but not a class that | 4805 | respectively. If you are using ``PACKAGECONFIG`` but not a class that |
4806 | handles the ``do_configure`` task, then you need to use | 4806 | handles the ``do_configure`` task, then you need to use |
@@ -4808,7 +4808,7 @@ system and gives an overview of their function and contents. | |||
4808 | 4808 | ||
4809 | PACKAGEGROUP_DISABLE_COMPLEMENTARY | 4809 | PACKAGEGROUP_DISABLE_COMPLEMENTARY |
4810 | For recipes inheriting the | 4810 | For recipes inheriting the |
4811 | ```packagegroup`` <#ref-classes-packagegroup>`__ class, setting | 4811 | :ref:`packagegroup <ref-classes-packagegroup>` class, setting |
4812 | ``PACKAGEGROUP_DISABLE_COMPLEMENTARY`` to "1" specifies that the | 4812 | ``PACKAGEGROUP_DISABLE_COMPLEMENTARY`` to "1" specifies that the |
4813 | normal complementary packages (i.e. ``-dev``, ``-dbg``, and so forth) | 4813 | normal complementary packages (i.e. ``-dev``, ``-dbg``, and so forth) |
4814 | should not be automatically created by the ``packagegroup`` recipe, | 4814 | should not be automatically created by the ``packagegroup`` recipe, |
@@ -4819,8 +4819,8 @@ system and gives an overview of their function and contents. | |||
4819 | following: ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale | 4819 | following: ${PN}-dbg ${PN}-staticdev ${PN}-dev ${PN}-doc ${PN}-locale |
4820 | ${PACKAGE_BEFORE_PN} ${PN} | 4820 | ${PACKAGE_BEFORE_PN} ${PN} |
4821 | 4821 | ||
4822 | During packaging, the ```do_package`` <#ref-tasks-package>`__ task | 4822 | During packaging, the :ref:`ref-tasks-package` task |
4823 | goes through ``PACKAGES`` and uses the ```FILES`` <#var-FILES>`__ | 4823 | goes through ``PACKAGES`` and uses the :term:`FILES` |
4824 | variable corresponding to each package to assign files to the | 4824 | variable corresponding to each package to assign files to the |
4825 | package. If a file matches the ``FILES`` variable for more than one | 4825 | package. If a file matches the ``FILES`` variable for more than one |
4826 | package in ``PACKAGES``, it will be assigned to the earliest | 4826 | package in ``PACKAGES``, it will be assigned to the earliest |
@@ -4828,26 +4828,26 @@ system and gives an overview of their function and contents. | |||
4828 | 4828 | ||
4829 | Packages in the variable's list that are empty (i.e. where none of | 4829 | Packages in the variable's list that are empty (i.e. where none of |
4830 | the patterns in ``FILES_``\ pkg match any files installed by the | 4830 | the patterns in ``FILES_``\ pkg match any files installed by the |
4831 | ```do_install`` <#ref-tasks-install>`__ task) are not generated, | 4831 | :ref:`ref-tasks-install` task) are not generated, |
4832 | unless generation is forced through the | 4832 | unless generation is forced through the |
4833 | ```ALLOW_EMPTY`` <#var-ALLOW_EMPTY>`__ variable. | 4833 | :term:`ALLOW_EMPTY` variable. |
4834 | 4834 | ||
4835 | PACKAGES_DYNAMIC | 4835 | PACKAGES_DYNAMIC |
4836 | A promise that your recipe satisfies runtime dependencies for | 4836 | A promise that your recipe satisfies runtime dependencies for |
4837 | optional modules that are found in other recipes. | 4837 | optional modules that are found in other recipes. |
4838 | ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it | 4838 | ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it |
4839 | only states that they should be satisfied. For example, if a hard, | 4839 | only states that they should be satisfied. For example, if a hard, |
4840 | runtime dependency (```RDEPENDS`` <#var-RDEPENDS>`__) of another | 4840 | runtime dependency (:term:`RDEPENDS`) of another |
4841 | package is satisfied at build time through the ``PACKAGES_DYNAMIC`` | 4841 | package is satisfied at build time through the ``PACKAGES_DYNAMIC`` |
4842 | variable, but a package with the module name is never actually | 4842 | variable, but a package with the module name is never actually |
4843 | produced, then the other package will be broken. Thus, if you attempt | 4843 | produced, then the other package will be broken. Thus, if you attempt |
4844 | to include that package in an image, you will get a dependency | 4844 | to include that package in an image, you will get a dependency |
4845 | failure from the packaging system during the | 4845 | failure from the packaging system during the |
4846 | ```do_rootfs`` <#ref-tasks-rootfs>`__ task. | 4846 | :ref:`ref-tasks-rootfs` task. |
4847 | 4847 | ||
4848 | Typically, if there is a chance that such a situation can occur and | 4848 | Typically, if there is a chance that such a situation can occur and |
4849 | the package that is not created is valid without the dependency being | 4849 | the package that is not created is valid without the dependency being |
4850 | satisfied, then you should use ```RRECOMMENDS`` <#var-RRECOMMENDS>`__ | 4850 | satisfied, then you should use :term:`RRECOMMENDS` |
4851 | (a soft runtime dependency) instead of ``RDEPENDS``. | 4851 | (a soft runtime dependency) instead of ``RDEPENDS``. |
4852 | 4852 | ||
4853 | For an example of how to use the ``PACKAGES_DYNAMIC`` variable when | 4853 | For an example of how to use the ``PACKAGES_DYNAMIC`` variable when |
@@ -4860,14 +4860,14 @@ system and gives an overview of their function and contents. | |||
4860 | files into individual packages. Recipes can either prepend to this | 4860 | files into individual packages. Recipes can either prepend to this |
4861 | variable or prepend to the ``populate_packages`` function in order to | 4861 | variable or prepend to the ``populate_packages`` function in order to |
4862 | perform additional package splitting. In either case, the function | 4862 | perform additional package splitting. In either case, the function |
4863 | should set ```PACKAGES`` <#var-PACKAGES>`__, | 4863 | should set :term:`PACKAGES`, |
4864 | ```FILES`` <#var-FILES>`__, ```RDEPENDS`` <#var-RDEPENDS>`__ and | 4864 | :term:`FILES`, :term:`RDEPENDS` and |
4865 | other packaging variables appropriately in order to perform the | 4865 | other packaging variables appropriately in order to perform the |
4866 | desired splitting. | 4866 | desired splitting. |
4867 | 4867 | ||
4868 | PARALLEL_MAKE | 4868 | PARALLEL_MAKE |
4869 | Extra options passed to the ``make`` command during the | 4869 | Extra options passed to the ``make`` command during the |
4870 | ```do_compile`` <#ref-tasks-compile>`__ task in order to specify | 4870 | :ref:`ref-tasks-compile` task in order to specify |
4871 | parallel compilation on the local build host. This variable is | 4871 | parallel compilation on the local build host. This variable is |
4872 | usually in the form "-j x", where x represents the maximum number of | 4872 | usually in the form "-j x", where x represents the maximum number of |
4873 | parallel threads ``make`` can run. | 4873 | parallel threads ``make`` can run. |
@@ -4913,15 +4913,15 @@ system and gives an overview of their function and contents. | |||
4913 | 4913 | ||
4914 | PARALLEL_MAKEINST | 4914 | PARALLEL_MAKEINST |
4915 | Extra options passed to the ``make install`` command during the | 4915 | Extra options passed to the ``make install`` command during the |
4916 | ```do_install`` <#ref-tasks-install>`__ task in order to specify | 4916 | :ref:`ref-tasks-install` task in order to specify |
4917 | parallel installation. This variable defaults to the value of | 4917 | parallel installation. This variable defaults to the value of |
4918 | ```PARALLEL_MAKE`` <#var-PARALLEL_MAKE>`__. | 4918 | :term:`PARALLEL_MAKE`. |
4919 | 4919 | ||
4920 | .. note:: | 4920 | .. note:: |
4921 | 4921 | ||
4922 | In order for ``PARALLEL_MAKEINST`` to be effective, ``make`` must | 4922 | In order for ``PARALLEL_MAKEINST`` to be effective, ``make`` must |
4923 | be called with | 4923 | be called with |
4924 | ``${``\ ```EXTRA_OEMAKE`` <#var-EXTRA_OEMAKE>`__\ ``}``. An easy | 4924 | ``${``\ :term:`EXTRA_OEMAKE`\ ``}``. An easy |
4925 | way to ensure this is to use the ``oe_runmake`` function. | 4925 | way to ensure this is to use the ``oe_runmake`` function. |
4926 | 4926 | ||
4927 | If the software being built experiences dependency issues during | 4927 | If the software being built experiences dependency issues during |
@@ -4946,7 +4946,7 @@ system and gives an overview of their function and contents. | |||
4946 | 4946 | ||
4947 | PATCHTOOL | 4947 | PATCHTOOL |
4948 | Specifies the utility used to apply patches for a recipe during the | 4948 | Specifies the utility used to apply patches for a recipe during the |
4949 | ```do_patch`` <#ref-tasks-patch>`__ task. You can specify one of | 4949 | :ref:`ref-tasks-patch` task. You can specify one of |
4950 | three utilities: "patch", "quilt", or "git". The default utility used | 4950 | three utilities: "patch", "quilt", or "git". The default utility used |
4951 | is "quilt" except for the quilt-native recipe itself. Because the | 4951 | is "quilt" except for the quilt-native recipe itself. Because the |
4952 | quilt tool is not available at the time quilt-native is being | 4952 | quilt tool is not available at the time quilt-native is being |
@@ -4961,20 +4961,20 @@ system and gives an overview of their function and contents. | |||
4961 | variable is used to make upgrades possible when the versioning scheme | 4961 | variable is used to make upgrades possible when the versioning scheme |
4962 | changes in some backwards incompatible way. | 4962 | changes in some backwards incompatible way. |
4963 | 4963 | ||
4964 | ``PE`` is the default value of the ```PKGE`` <#var-PKGE>`__ variable. | 4964 | ``PE`` is the default value of the :term:`PKGE` variable. |
4965 | 4965 | ||
4966 | PF | 4966 | PF |
4967 | Specifies the recipe or package name and includes all version and | 4967 | Specifies the recipe or package name and includes all version and |
4968 | revision numbers (i.e. ``glibc-2.13-r20+svnr15508/`` and | 4968 | revision numbers (i.e. ``glibc-2.13-r20+svnr15508/`` and |
4969 | ``bash-4.2-r1/``). This variable is comprised of the following: | 4969 | ``bash-4.2-r1/``). This variable is comprised of the following: |
4970 | ${`PN <#var-PN>`__}-${`EXTENDPE <#var-EXTENDPE>`__}${`PV <#var-PV>`__}-${`PR <#var-PR>`__} | 4970 | ${:term:`PN`}-${:term:`EXTENDPE`}${:term:`PV`}-${:term:`PR`} |
4971 | 4971 | ||
4972 | PIXBUF_PACKAGES | 4972 | PIXBUF_PACKAGES |
4973 | When inheriting the ```pixbufcache`` <#ref-classes-pixbufcache>`__ | 4973 | When inheriting the :ref:`pixbufcache <ref-classes-pixbufcache>` |
4974 | class, this variable identifies packages that contain the pixbuf | 4974 | class, this variable identifies packages that contain the pixbuf |
4975 | loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache`` | 4975 | loaders used with ``gdk-pixbuf``. By default, the ``pixbufcache`` |
4976 | class assumes that the loaders are in the recipe's main package (i.e. | 4976 | class assumes that the loaders are in the recipe's main package (i.e. |
4977 | ``${``\ ```PN`` <#var-PN>`__\ ``}``). Use this variable if the | 4977 | ``${``\ :term:`PN`\ ``}``). Use this variable if the |
4978 | loaders you need are in a package other than that main package. | 4978 | loaders you need are in a package other than that main package. |
4979 | 4979 | ||
4980 | PKG | 4980 | PKG |
@@ -4987,7 +4987,7 @@ system and gives an overview of their function and contents. | |||
4987 | PKG | 4987 | PKG |
4988 | variable, you must use a package name override. | 4988 | variable, you must use a package name override. |
4989 | 4989 | ||
4990 | For example, when the ```debian`` <#ref-classes-debian>`__ class | 4990 | For example, when the :ref:`debian <ref-classes-debian>` class |
4991 | renames the output package, it does so by setting | 4991 | renames the output package, it does so by setting |
4992 | ``PKG_packagename``. | 4992 | ``PKG_packagename``. |
4993 | 4993 | ||
@@ -5005,7 +5005,7 @@ system and gives an overview of their function and contents. | |||
5005 | PKGDATA_DIR | 5005 | PKGDATA_DIR |
5006 | Points to a shared, global-state directory that holds data generated | 5006 | Points to a shared, global-state directory that holds data generated |
5007 | during the packaging process. During the packaging process, the | 5007 | during the packaging process. During the packaging process, the |
5008 | ```do_packagedata`` <#ref-tasks-packagedata>`__ task packages data | 5008 | :ref:`ref-tasks-packagedata` task packages data |
5009 | for each recipe and installs it into this temporary, shared area. | 5009 | for each recipe and installs it into this temporary, shared area. |
5010 | This directory defaults to the following, which you should not | 5010 | This directory defaults to the following, which you should not |
5011 | change: ${STAGING_DIR_HOST}/pkgdata For examples of how this data is | 5011 | change: ${STAGING_DIR_HOST}/pkgdata For examples of how this data is |
@@ -5016,7 +5016,7 @@ system and gives an overview of their function and contents. | |||
5016 | ``oe-pkgdata-util`` <&YOCTO_DOCS_DEV_URL;#viewing-package-information-with-oe-pkgdata-util>`__" | 5016 | ``oe-pkgdata-util`` <&YOCTO_DOCS_DEV_URL;#viewing-package-information-with-oe-pkgdata-util>`__" |
5017 | section in the Yocto Project Development Tasks Manual. For more | 5017 | section in the Yocto Project Development Tasks Manual. For more |
5018 | information on the shared, global-state directory, see | 5018 | information on the shared, global-state directory, see |
5019 | ```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__. | 5019 | :term:`STAGING_DIR_HOST`. |
5020 | 5020 | ||
5021 | PKGDEST | 5021 | PKGDEST |
5022 | Points to the parent directory for files to be packaged after they | 5022 | Points to the parent directory for files to be packaged after they |
@@ -5024,30 +5024,30 @@ system and gives an overview of their function and contents. | |||
5024 | the following: ${WORKDIR}/packages-split | 5024 | the following: ${WORKDIR}/packages-split |
5025 | 5025 | ||
5026 | Under this directory, the build system creates directories for each | 5026 | Under this directory, the build system creates directories for each |
5027 | package specified in ```PACKAGES`` <#var-PACKAGES>`__. Do not change | 5027 | package specified in :term:`PACKAGES`. Do not change |
5028 | this default. | 5028 | this default. |
5029 | 5029 | ||
5030 | PKGDESTWORK | 5030 | PKGDESTWORK |
5031 | Points to a temporary work area where the | 5031 | Points to a temporary work area where the |
5032 | ```do_package`` <#ref-tasks-package>`__ task saves package metadata. | 5032 | :ref:`ref-tasks-package` task saves package metadata. |
5033 | The ``PKGDESTWORK`` location defaults to the following: | 5033 | The ``PKGDESTWORK`` location defaults to the following: |
5034 | ${WORKDIR}/pkgdata Do not change this default. | 5034 | ${WORKDIR}/pkgdata Do not change this default. |
5035 | 5035 | ||
5036 | The ```do_packagedata`` <#ref-tasks-packagedata>`__ task copies the | 5036 | The :ref:`ref-tasks-packagedata` task copies the |
5037 | package metadata from ``PKGDESTWORK`` to | 5037 | package metadata from ``PKGDESTWORK`` to |
5038 | ```PKGDATA_DIR`` <#var-PKGDATA_DIR>`__ to make it available globally. | 5038 | :term:`PKGDATA_DIR` to make it available globally. |
5039 | 5039 | ||
5040 | PKGE | 5040 | PKGE |
5041 | The epoch of the package(s) built by the recipe. By default, ``PKGE`` | 5041 | The epoch of the package(s) built by the recipe. By default, ``PKGE`` |
5042 | is set to ```PE`` <#var-PE>`__. | 5042 | is set to :term:`PE`. |
5043 | 5043 | ||
5044 | PKGR | 5044 | PKGR |
5045 | The revision of the package(s) built by the recipe. By default, | 5045 | The revision of the package(s) built by the recipe. By default, |
5046 | ``PKGR`` is set to ```PR`` <#var-PR>`__. | 5046 | ``PKGR`` is set to :term:`PR`. |
5047 | 5047 | ||
5048 | PKGV | 5048 | PKGV |
5049 | The version of the package(s) built by the recipe. By default, | 5049 | The version of the package(s) built by the recipe. By default, |
5050 | ``PKGV`` is set to ```PV`` <#var-PV>`__. | 5050 | ``PKGV`` is set to :term:`PV`. |
5051 | 5051 | ||
5052 | PN | 5052 | PN |
5053 | This variable can have two separate functions depending on the | 5053 | This variable can have two separate functions depending on the |
@@ -5071,7 +5071,7 @@ system and gives an overview of their function and contents. | |||
5071 | PNBLACKLIST | 5071 | PNBLACKLIST |
5072 | Lists recipes you do not want the OpenEmbedded build system to build. | 5072 | Lists recipes you do not want the OpenEmbedded build system to build. |
5073 | This variable works in conjunction with the | 5073 | This variable works in conjunction with the |
5074 | ```blacklist`` <#ref-classes-blacklist>`__ class, which is inherited | 5074 | :ref:`blacklist <ref-classes-blacklist>` class, which is inherited |
5075 | globally. | 5075 | globally. |
5076 | 5076 | ||
5077 | To prevent a recipe from being built, use the ``PNBLACKLIST`` | 5077 | To prevent a recipe from being built, use the ``PNBLACKLIST`` |
@@ -5088,7 +5088,7 @@ system and gives an overview of their function and contents. | |||
5088 | If you need to pass the SDK path to a command within a function, you | 5088 | If you need to pass the SDK path to a command within a function, you |
5089 | can use ``${SDK_DIR}``, which points to the parent directory used by | 5089 | can use ``${SDK_DIR}``, which points to the parent directory used by |
5090 | the OpenEmbedded build system when creating SDK output. See the | 5090 | the OpenEmbedded build system when creating SDK output. See the |
5091 | ```SDK_DIR`` <#var-SDK_DIR>`__ variable for more information. | 5091 | :term:`SDK_DIR` variable for more information. |
5092 | 5092 | ||
5093 | POPULATE_SDK_POST_TARGET_COMMAND | 5093 | POPULATE_SDK_POST_TARGET_COMMAND |
5094 | Specifies a list of functions to call once the OpenEmbedded build | 5094 | Specifies a list of functions to call once the OpenEmbedded build |
@@ -5099,12 +5099,12 @@ system and gives an overview of their function and contents. | |||
5099 | If you need to pass the SDK path to a command within a function, you | 5099 | If you need to pass the SDK path to a command within a function, you |
5100 | can use ``${SDK_DIR}``, which points to the parent directory used by | 5100 | can use ``${SDK_DIR}``, which points to the parent directory used by |
5101 | the OpenEmbedded build system when creating SDK output. See the | 5101 | the OpenEmbedded build system when creating SDK output. See the |
5102 | ```SDK_DIR`` <#var-SDK_DIR>`__ variable for more information. | 5102 | :term:`SDK_DIR` variable for more information. |
5103 | 5103 | ||
5104 | PR | 5104 | PR |
5105 | The revision of the recipe. The default value for this variable is | 5105 | The revision of the recipe. The default value for this variable is |
5106 | "r0". Subsequent revisions of the recipe conventionally have the | 5106 | "r0". Subsequent revisions of the recipe conventionally have the |
5107 | values "r1", "r2", and so forth. When ```PV`` <#var-PV>`__ increases, | 5107 | values "r1", "r2", and so forth. When :term:`PV` increases, |
5108 | ``PR`` is conventionally reset to "r0". | 5108 | ``PR`` is conventionally reset to "r0". |
5109 | 5109 | ||
5110 | .. note:: | 5110 | .. note:: |
@@ -5122,7 +5122,7 @@ system and gives an overview of their function and contents. | |||
5122 | The ``PR`` variable primarily becomes significant when a package | 5122 | The ``PR`` variable primarily becomes significant when a package |
5123 | manager dynamically installs packages on an already built image. In | 5123 | manager dynamically installs packages on an already built image. In |
5124 | this case, ``PR``, which is the default value of | 5124 | this case, ``PR``, which is the default value of |
5125 | ```PKGR`` <#var-PKGR>`__, helps the package manager distinguish which | 5125 | :term:`PKGR`, helps the package manager distinguish which |
5126 | package is the most recent one in cases where many packages have the | 5126 | package is the most recent one in cases where many packages have the |
5127 | same ``PV`` (i.e. ``PKGV``). A component having many packages with | 5127 | same ``PV`` (i.e. ``PKGV``). A component having many packages with |
5128 | the same ``PV`` usually means that the packages all install the same | 5128 | the same ``PV`` usually means that the packages all install the same |
@@ -5145,7 +5145,7 @@ system and gives an overview of their function and contents. | |||
5145 | which recipe is preferred and thus provides the item (i.e. the | 5145 | which recipe is preferred and thus provides the item (i.e. the |
5146 | preferred provider). You should always suffix this variable with the | 5146 | preferred provider). You should always suffix this variable with the |
5147 | name of the provided item. And, you should define the variable using | 5147 | name of the provided item. And, you should define the variable using |
5148 | the preferred recipe's name (```PN`` <#var-PN>`__). Here is a common | 5148 | the preferred recipe's name (:term:`PN`). Here is a common |
5149 | example: PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" In the | 5149 | example: PREFERRED_PROVIDER_virtual/kernel ?= "linux-yocto" In the |
5150 | previous example, multiple recipes are providing "virtual/kernel". | 5150 | previous example, multiple recipes are providing "virtual/kernel". |
5151 | The ``PREFERRED_PROVIDER`` variable is set with the name (``PN``) of | 5151 | The ``PREFERRED_PROVIDER`` variable is set with the name (``PN``) of |
@@ -5174,8 +5174,8 @@ system and gives an overview of their function and contents. | |||
5174 | PREFERRED_VERSION | 5174 | PREFERRED_VERSION |
5175 | If multiple versions of recipes exist, this variable determines which | 5175 | If multiple versions of recipes exist, this variable determines which |
5176 | version is given preference. You must always suffix the variable with | 5176 | version is given preference. You must always suffix the variable with |
5177 | the ```PN`` <#var-PN>`__ you want to select, and you should set the | 5177 | the :term:`PN` you want to select, and you should set the |
5178 | ```PV`` <#var-PV>`__ accordingly for precedence. | 5178 | :term:`PV` accordingly for precedence. |
5179 | 5179 | ||
5180 | The ``PREFERRED_VERSION`` variable supports limited wildcard use | 5180 | The ``PREFERRED_VERSION`` variable supports limited wildcard use |
5181 | through the "``%``" character. You can use the character to match any | 5181 | through the "``%``" character. You can use the character to match any |
@@ -5192,7 +5192,7 @@ system and gives an overview of their function and contents. | |||
5192 | string. You cannot use the wildcard character in any other | 5192 | string. You cannot use the wildcard character in any other |
5193 | location of the string. | 5193 | location of the string. |
5194 | 5194 | ||
5195 | The specified version is matched against ```PV`` <#var-PV>`__, which | 5195 | The specified version is matched against :term:`PV`, which |
5196 | does not necessarily match the version part of the recipe's filename. | 5196 | does not necessarily match the version part of the recipe's filename. |
5197 | For example, consider two recipes ``foo_1.2.bb`` and ``foo_git.bb`` | 5197 | For example, consider two recipes ``foo_1.2.bb`` and ``foo_git.bb`` |
5198 | where ``foo_git.bb`` contains the following assignment: PV = | 5198 | where ``foo_git.bb`` contains the following assignment: PV = |
@@ -5204,7 +5204,7 @@ system and gives an overview of their function and contents. | |||
5204 | 5204 | ||
5205 | Sometimes the ``PREFERRED_VERSION`` variable can be set by | 5205 | Sometimes the ``PREFERRED_VERSION`` variable can be set by |
5206 | configuration files in a way that is hard to change. You can use | 5206 | configuration files in a way that is hard to change. You can use |
5207 | ```OVERRIDES`` <#var-OVERRIDES>`__ to set a machine-specific | 5207 | :term:`OVERRIDES` to set a machine-specific |
5208 | override. Here is an example: PREFERRED_VERSION_linux-yocto_qemux86 = | 5208 | override. Here is an example: PREFERRED_VERSION_linux-yocto_qemux86 = |
5209 | "5.0%" Although not recommended, worst case, you can also use the | 5209 | "5.0%" Although not recommended, worst case, you can also use the |
5210 | "forcevariable" override, which is the strongest override possible. | 5210 | "forcevariable" override, which is the strongest override possible. |
@@ -5226,9 +5226,9 @@ system and gives an overview of their function and contents. | |||
5226 | first tries the local download directory. If that location fails, the | 5226 | first tries the local download directory. If that location fails, the |
5227 | build system tries locations defined by ``PREMIRRORS``, the upstream | 5227 | build system tries locations defined by ``PREMIRRORS``, the upstream |
5228 | source, and then locations specified by | 5228 | source, and then locations specified by |
5229 | ```MIRRORS`` <#var-MIRRORS>`__ in that order. | 5229 | :term:`MIRRORS` in that order. |
5230 | 5230 | ||
5231 | Assuming your distribution (```DISTRO`` <#var-DISTRO>`__) is "poky", | 5231 | Assuming your distribution (:term:`DISTRO`) is "poky", |
5232 | the default value for ``PREMIRRORS`` is defined in the | 5232 | the default value for ``PREMIRRORS`` is defined in the |
5233 | ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. | 5233 | ``conf/distro/poky.conf`` file in the ``meta-poky`` Git repository. |
5234 | 5234 | ||
@@ -5315,7 +5315,7 @@ system and gives an overview of their function and contents. | |||
5315 | "virtual/function" (e.g. "virtual/kernel"). The slash is simply part | 5315 | "virtual/function" (e.g. "virtual/kernel"). The slash is simply part |
5316 | of the name and has no syntactical significance. | 5316 | of the name and has no syntactical significance. |
5317 | 5317 | ||
5318 | The ```PREFERRED_PROVIDER`` <#var-PREFERRED_PROVIDER>`__ variable is | 5318 | The :term:`PREFERRED_PROVIDER` variable is |
5319 | used to select which particular recipe provides a virtual target. | 5319 | used to select which particular recipe provides a virtual target. |
5320 | 5320 | ||
5321 | .. note:: | 5321 | .. note:: |
@@ -5335,10 +5335,10 @@ system and gives an overview of their function and contents. | |||
5335 | 5335 | ||
5336 | 5336 | ||
5337 | PRSERV_HOST | 5337 | PRSERV_HOST |
5338 | The network based ```PR`` <#var-PR>`__ service host and port. | 5338 | The network based :term:`PR` service host and port. |
5339 | 5339 | ||
5340 | The ``conf/local.conf.sample.extended`` configuration file in the | 5340 | The ``conf/local.conf.sample.extended`` configuration file in the |
5341 | `Source Directory <#source-directory>`__ shows how the | 5341 | :term:`Source Directory` shows how the |
5342 | ``PRSERV_HOST`` variable is set: PRSERV_HOST = "localhost:0" You must | 5342 | ``PRSERV_HOST`` variable is set: PRSERV_HOST = "localhost:0" You must |
5343 | set the variable if you want to automatically start a local `PR | 5343 | set the variable if you want to automatically start a local `PR |
5344 | service <&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service>`__. You can | 5344 | service <&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service>`__. You can |
@@ -5350,7 +5350,7 @@ system and gives an overview of their function and contents. | |||
5350 | functionality is enabled when building a recipe. You should not set | 5350 | functionality is enabled when building a recipe. You should not set |
5351 | this variable directly. Enabling and disabling building Package Tests | 5351 | this variable directly. Enabling and disabling building Package Tests |
5352 | at build time should be done by adding "ptest" to (or removing it | 5352 | at build time should be done by adding "ptest" to (or removing it |
5353 | from) ```DISTRO_FEATURES`` <#var-DISTRO_FEATURES>`__. | 5353 | from) :term:`DISTRO_FEATURES`. |
5354 | 5354 | ||
5355 | PV | 5355 | PV |
5356 | The version of the recipe. The version is normally extracted from the | 5356 | The version of the recipe. The version is normally extracted from the |
@@ -5360,14 +5360,14 @@ system and gives an overview of their function and contents. | |||
5360 | building an unstable (i.e. development) version from a source code | 5360 | building an unstable (i.e. development) version from a source code |
5361 | repository (e.g. Git or Subversion). | 5361 | repository (e.g. Git or Subversion). |
5362 | 5362 | ||
5363 | ``PV`` is the default value of the ```PKGV`` <#var-PKGV>`__ variable. | 5363 | ``PV`` is the default value of the :term:`PKGV` variable. |
5364 | 5364 | ||
5365 | PYTHON_ABI | 5365 | PYTHON_ABI |
5366 | When used by recipes that inherit the | 5366 | When used by recipes that inherit the |
5367 | ```distutils3`` <#ref-classes-distutils3>`__, | 5367 | ```distutils3`` <#ref-classes-distutils3>`__, |
5368 | ```setuptools3`` <#ref-classes-setuptools3>`__, | 5368 | ```setuptools3`` <#ref-classes-setuptools3>`__, |
5369 | ```distutils`` <#ref-classes-distutils>`__, or | 5369 | :ref:`distutils <ref-classes-distutils>`, or |
5370 | ```setuptools`` <#ref-classes-setuptools>`__ classes, denotes the | 5370 | :ref:`setuptools <ref-classes-setuptools>` classes, denotes the |
5371 | Application Binary Interface (ABI) currently in use for Python. By | 5371 | Application Binary Interface (ABI) currently in use for Python. By |
5372 | default, the ABI is "m". You do not have to set this variable as the | 5372 | default, the ABI is "m". You do not have to set this variable as the |
5373 | OpenEmbedded build system sets it for you. | 5373 | OpenEmbedded build system sets it for you. |
@@ -5384,8 +5384,8 @@ system and gives an overview of their function and contents. | |||
5384 | When used by recipes that inherit the | 5384 | When used by recipes that inherit the |
5385 | ```distutils3`` <#ref-classes-distutils3>`__, | 5385 | ```distutils3`` <#ref-classes-distutils3>`__, |
5386 | ```setuptools3`` <#ref-classes-setuptools3>`__, | 5386 | ```setuptools3`` <#ref-classes-setuptools3>`__, |
5387 | ```distutils`` <#ref-classes-distutils>`__, or | 5387 | :ref:`distutils <ref-classes-distutils>`, or |
5388 | ```setuptools`` <#ref-classes-setuptools>`__ classes, specifies the | 5388 | :ref:`setuptools <ref-classes-setuptools>` classes, specifies the |
5389 | major Python version being built. For Python 3.x, ``PYTHON_PN`` would | 5389 | major Python version being built. For Python 3.x, ``PYTHON_PN`` would |
5390 | be "python3". You do not have to set this variable as the | 5390 | be "python3". You do not have to set this variable as the |
5391 | OpenEmbedded build system automatically sets it for you. | 5391 | OpenEmbedded build system automatically sets it for you. |
@@ -5432,15 +5432,15 @@ system and gives an overview of their function and contents. | |||
5432 | ```do_package_write_*`` <#ref-tasks-package_write_deb>`__ tasks. | 5432 | ```do_package_write_*`` <#ref-tasks-package_write_deb>`__ tasks. |
5433 | Exactly how this is done depends on which package format is used, | 5433 | Exactly how this is done depends on which package format is used, |
5434 | which is determined by | 5434 | which is determined by |
5435 | ```PACKAGE_CLASSES`` <#var-PACKAGE_CLASSES>`__. When the | 5435 | :term:`PACKAGE_CLASSES`. When the |
5436 | corresponding package manager installs the package, it will know to | 5436 | corresponding package manager installs the package, it will know to |
5437 | also install the packages on which it depends. | 5437 | also install the packages on which it depends. |
5438 | 5438 | ||
5439 | To ensure that the packages ``bar`` and ``baz`` get built, the | 5439 | To ensure that the packages ``bar`` and ``baz`` get built, the |
5440 | previous ``RDEPENDS`` assignment also causes a task dependency to be | 5440 | previous ``RDEPENDS`` assignment also causes a task dependency to be |
5441 | added. This dependency is from the recipe's | 5441 | added. This dependency is from the recipe's |
5442 | ```do_build`` <#ref-tasks-build>`__ (not to be confused with | 5442 | :ref:`ref-tasks-build` (not to be confused with |
5443 | ```do_compile`` <#ref-tasks-compile>`__) task to the | 5443 | :ref:`ref-tasks-compile`) task to the |
5444 | ``do_package_write_*`` task of the recipes that build ``bar`` and | 5444 | ``do_package_write_*`` task of the recipes that build ``bar`` and |
5445 | ``baz``. | 5445 | ``baz``. |
5446 | 5446 | ||
@@ -5449,7 +5449,7 @@ system and gives an overview of their function and contents. | |||
5449 | package names and recipe names usually match, the important point | 5449 | package names and recipe names usually match, the important point |
5450 | here is that you are providing package names within the ``RDEPENDS`` | 5450 | here is that you are providing package names within the ``RDEPENDS`` |
5451 | variable. For an example of the default list of packages created from | 5451 | variable. For an example of the default list of packages created from |
5452 | a recipe, see the ```PACKAGES`` <#var-PACKAGES>`__ variable. | 5452 | a recipe, see the :term:`PACKAGES` variable. |
5453 | 5453 | ||
5454 | Because the ``RDEPENDS`` variable applies to packages being built, | 5454 | Because the ``RDEPENDS`` variable applies to packages being built, |
5455 | you should always use the variable in a form with an attached package | 5455 | you should always use the variable in a form with an attached package |
@@ -5478,9 +5478,9 @@ system and gives an overview of their function and contents. | |||
5478 | . Use the "+=" operator rather than the "=" operator. | 5478 | . Use the "+=" operator rather than the "=" operator. |
5479 | 5479 | ||
5480 | The package names you use with ``RDEPENDS`` must appear as they would | 5480 | The package names you use with ``RDEPENDS`` must appear as they would |
5481 | in the ``PACKAGES`` variable. The ```PKG`` <#var-PKG>`__ variable | 5481 | in the ``PACKAGES`` variable. The :term:`PKG` variable |
5482 | allows a different name to be used for the final package (e.g. the | 5482 | allows a different name to be used for the final package (e.g. the |
5483 | ```debian`` <#ref-classes-debian>`__ class uses this to rename | 5483 | :ref:`debian <ref-classes-debian>` class uses this to rename |
5484 | packages), but this final package name cannot be used with | 5484 | packages), but this final package name cannot be used with |
5485 | ``RDEPENDS``, which makes sense as ``RDEPENDS`` is meant to be | 5485 | ``RDEPENDS``, which makes sense as ``RDEPENDS`` is meant to be |
5486 | independent of the package format used. | 5486 | independent of the package format used. |
@@ -5503,7 +5503,7 @@ system and gives an overview of their function and contents. | |||
5503 | greater of the package ``foo``: RDEPENDS_${PN} = "foo (>= 1.2)" | 5503 | greater of the package ``foo``: RDEPENDS_${PN} = "foo (>= 1.2)" |
5504 | 5504 | ||
5505 | For information on build-time dependencies, see the | 5505 | For information on build-time dependencies, see the |
5506 | ```DEPENDS`` <#var-DEPENDS>`__ variable. You can also see the | 5506 | :term:`DEPENDS` variable. You can also see the |
5507 | "`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and | 5507 | "`Tasks <&YOCTO_DOCS_BB_URL;#tasks>`__" and |
5508 | "`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the | 5508 | "`Dependencies <&YOCTO_DOCS_BB_URL;#dependencies>`__" sections in the |
5509 | BitBake User Manual for additional information on tasks and | 5509 | BitBake User Manual for additional information on tasks and |
@@ -5511,7 +5511,7 @@ system and gives an overview of their function and contents. | |||
5511 | 5511 | ||
5512 | REQUIRED_DISTRO_FEATURES | 5512 | REQUIRED_DISTRO_FEATURES |
5513 | When inheriting the | 5513 | When inheriting the |
5514 | ```distro_features_check`` <#ref-classes-distro_features_check>`__ | 5514 | :ref:`distro_features_check <ref-classes-distro_features_check>` |
5515 | class, this variable identifies distribution features that must exist | 5515 | class, this variable identifies distribution features that must exist |
5516 | in the current configuration in order for the OpenEmbedded build | 5516 | in the current configuration in order for the OpenEmbedded build |
5517 | system to build the recipe. In other words, if the | 5517 | system to build the recipe. In other words, if the |
@@ -5546,7 +5546,7 @@ system and gives an overview of their function and contents. | |||
5546 | Indicates a filesystem image to include as the root filesystem. | 5546 | Indicates a filesystem image to include as the root filesystem. |
5547 | 5547 | ||
5548 | The ``ROOTFS`` variable is an optional variable used with the | 5548 | The ``ROOTFS`` variable is an optional variable used with the |
5549 | ```image-live`` <#ref-classes-image-live>`__ class. | 5549 | :ref:`image-live <ref-classes-image-live>` class. |
5550 | 5550 | ||
5551 | ROOTFS_POSTINSTALL_COMMAND | 5551 | ROOTFS_POSTINSTALL_COMMAND |
5552 | Specifies a list of functions to call after the OpenEmbedded build | 5552 | Specifies a list of functions to call after the OpenEmbedded build |
@@ -5556,7 +5556,7 @@ system and gives an overview of their function and contents. | |||
5556 | If you need to pass the root filesystem path to a command within a | 5556 | If you need to pass the root filesystem path to a command within a |
5557 | function, you can use ``${IMAGE_ROOTFS}``, which points to the | 5557 | function, you can use ``${IMAGE_ROOTFS}``, which points to the |
5558 | directory that becomes the root filesystem image. See the | 5558 | directory that becomes the root filesystem image. See the |
5559 | ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more | 5559 | :term:`IMAGE_ROOTFS` variable for more |
5560 | information. | 5560 | information. |
5561 | 5561 | ||
5562 | ROOTFS_POSTPROCESS_COMMAND | 5562 | ROOTFS_POSTPROCESS_COMMAND |
@@ -5568,7 +5568,7 @@ system and gives an overview of their function and contents. | |||
5568 | If you need to pass the root filesystem path to a command within a | 5568 | If you need to pass the root filesystem path to a command within a |
5569 | function, you can use ``${IMAGE_ROOTFS}``, which points to the | 5569 | function, you can use ``${IMAGE_ROOTFS}``, which points to the |
5570 | directory that becomes the root filesystem image. See the | 5570 | directory that becomes the root filesystem image. See the |
5571 | ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more | 5571 | :term:`IMAGE_ROOTFS` variable for more |
5572 | information. | 5572 | information. |
5573 | 5573 | ||
5574 | ROOTFS_POSTUNINSTALL_COMMAND | 5574 | ROOTFS_POSTUNINSTALL_COMMAND |
@@ -5582,7 +5582,7 @@ system and gives an overview of their function and contents. | |||
5582 | If you need to pass the root filesystem path to a command within a | 5582 | If you need to pass the root filesystem path to a command within a |
5583 | function, you can use ``${IMAGE_ROOTFS}``, which points to the | 5583 | function, you can use ``${IMAGE_ROOTFS}``, which points to the |
5584 | directory that becomes the root filesystem image. See the | 5584 | directory that becomes the root filesystem image. See the |
5585 | ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more | 5585 | :term:`IMAGE_ROOTFS` variable for more |
5586 | information. | 5586 | information. |
5587 | 5587 | ||
5588 | ROOTFS_PREPROCESS_COMMAND | 5588 | ROOTFS_PREPROCESS_COMMAND |
@@ -5594,7 +5594,7 @@ system and gives an overview of their function and contents. | |||
5594 | If you need to pass the root filesystem path to a command within a | 5594 | If you need to pass the root filesystem path to a command within a |
5595 | function, you can use ``${IMAGE_ROOTFS}``, which points to the | 5595 | function, you can use ``${IMAGE_ROOTFS}``, which points to the |
5596 | directory that becomes the root filesystem image. See the | 5596 | directory that becomes the root filesystem image. See the |
5597 | ```IMAGE_ROOTFS`` <#var-IMAGE_ROOTFS>`__ variable for more | 5597 | :term:`IMAGE_ROOTFS` variable for more |
5598 | information. | 5598 | information. |
5599 | 5599 | ||
5600 | RPROVIDES | 5600 | RPROVIDES |
@@ -5623,15 +5623,15 @@ system and gives an overview of their function and contents. | |||
5623 | The package manager will automatically install the ``RRECOMMENDS`` | 5623 | The package manager will automatically install the ``RRECOMMENDS`` |
5624 | list of packages when installing the built package. However, you can | 5624 | list of packages when installing the built package. However, you can |
5625 | prevent listed packages from being installed by using the | 5625 | prevent listed packages from being installed by using the |
5626 | ```BAD_RECOMMENDATIONS`` <#var-BAD_RECOMMENDATIONS>`__, | 5626 | :term:`BAD_RECOMMENDATIONS`, |
5627 | ```NO_RECOMMENDATIONS`` <#var-NO_RECOMMENDATIONS>`__, and | 5627 | :term:`NO_RECOMMENDATIONS`, and |
5628 | ```PACKAGE_EXCLUDE`` <#var-PACKAGE_EXCLUDE>`__ variables. | 5628 | :term:`PACKAGE_EXCLUDE` variables. |
5629 | 5629 | ||
5630 | Packages specified in ``RRECOMMENDS`` need not actually be produced. | 5630 | Packages specified in ``RRECOMMENDS`` need not actually be produced. |
5631 | However, a recipe must exist that provides each package, either | 5631 | However, a recipe must exist that provides each package, either |
5632 | through the ```PACKAGES`` <#var-PACKAGES>`__ or | 5632 | through the :term:`PACKAGES` or |
5633 | ```PACKAGES_DYNAMIC`` <#var-PACKAGES_DYNAMIC>`__ variables or the | 5633 | :term:`PACKAGES_DYNAMIC` variables or the |
5634 | ```RPROVIDES`` <#var-RPROVIDES>`__ variable, or an error will occur | 5634 | :term:`RPROVIDES` variable, or an error will occur |
5635 | during the build. If such a recipe does exist and the package is not | 5635 | during the build. If such a recipe does exist and the package is not |
5636 | produced, the build continues without error. | 5636 | produced, the build continues without error. |
5637 | 5637 | ||
@@ -5684,9 +5684,9 @@ system and gives an overview of their function and contents. | |||
5684 | example: RSUGGESTS_${PN} = "useful_package another_package" | 5684 | example: RSUGGESTS_${PN} = "useful_package another_package" |
5685 | 5685 | ||
5686 | S | 5686 | S |
5687 | The location in the `Build Directory <#build-directory>`__ where | 5687 | The location in the :term:`Build Directory` where |
5688 | unpacked recipe source code resides. By default, this directory is | 5688 | unpacked recipe source code resides. By default, this directory is |
5689 | ``${``\ ```WORKDIR`` <#var-WORKDIR>`__\ ``}/${``\ ```BPN`` <#var-BPN>`__\ ``}-${``\ ```PV`` <#var-PV>`__\ ``}``, | 5689 | ``${``\ :term:`WORKDIR`\ ``}/${``\ :term:`BPN`\ ``}-${``\ :term:`PV`\ ``}``, |
5690 | where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe | 5690 | where ``${BPN}`` is the base recipe name and ``${PV}`` is the recipe |
5691 | version. If the source tarball extracts the code to a directory named | 5691 | version. If the source tarball extracts the code to a directory named |
5692 | anything other than ``${BPN}-${PV}``, or if the source code is | 5692 | anything other than ``${BPN}-${PV}``, or if the source code is |
@@ -5694,7 +5694,7 @@ system and gives an overview of their function and contents. | |||
5694 | ``S`` in the recipe so that the OpenEmbedded build system knows where | 5694 | ``S`` in the recipe so that the OpenEmbedded build system knows where |
5695 | to find the unpacked source. | 5695 | to find the unpacked source. |
5696 | 5696 | ||
5697 | As an example, assume a `Source Directory <#source-directory>`__ | 5697 | As an example, assume a :term:`Source Directory` |
5698 | top-level folder named ``poky`` and a default Build Directory at | 5698 | top-level folder named ``poky`` and a default Build Directory at |
5699 | ``poky/build``. In this case, the work directory the build system | 5699 | ``poky/build``. In this case, the work directory the build system |
5700 | uses to keep the unpacked recipe for ``db`` is the following: | 5700 | uses to keep the unpacked recipe for ``db`` is the following: |
@@ -5703,7 +5703,7 @@ system and gives an overview of their function and contents. | |||
5703 | 5703 | ||
5704 | This next example assumes a Git repository. By default, Git | 5704 | This next example assumes a Git repository. By default, Git |
5705 | repositories are cloned to ``${WORKDIR}/git`` during | 5705 | repositories are cloned to ``${WORKDIR}/git`` during |
5706 | ```do_fetch`` <#ref-tasks-fetch>`__. Since this path is different | 5706 | :ref:`ref-tasks-fetch`. Since this path is different |
5707 | from the default value of ``S``, you must set it specifically so the | 5707 | from the default value of ``S``, you must set it specifically so the |
5708 | source can be located: SRC_URI = "git://path/to/repo.git" S = | 5708 | source can be located: SRC_URI = "git://path/to/repo.git" S = |
5709 | "${WORKDIR}/git" | 5709 | "${WORKDIR}/git" |
@@ -5721,13 +5721,13 @@ system and gives an overview of their function and contents. | |||
5721 | as read from ``/etc/lsb-release``. Separate the list items with | 5721 | as read from ``/etc/lsb-release``. Separate the list items with |
5722 | explicit newline characters (``\n``). If ``SANITY_TESTED_DISTROS`` is | 5722 | explicit newline characters (``\n``). If ``SANITY_TESTED_DISTROS`` is |
5723 | not empty and the current value of | 5723 | not empty and the current value of |
5724 | ```NATIVELSBSTRING`` <#var-NATIVELSBSTRING>`__ does not appear in the | 5724 | :term:`NATIVELSBSTRING` does not appear in the |
5725 | list, then the build system reports a warning that indicates the | 5725 | list, then the build system reports a warning that indicates the |
5726 | current host distribution has not been tested as a build host. | 5726 | current host distribution has not been tested as a build host. |
5727 | 5727 | ||
5728 | SDK_ARCH | 5728 | SDK_ARCH |
5729 | The target architecture for the SDK. Typically, you do not directly | 5729 | The target architecture for the SDK. Typically, you do not directly |
5730 | set this variable. Instead, use ```SDKMACHINE`` <#var-SDKMACHINE>`__. | 5730 | set this variable. Instead, use :term:`SDKMACHINE`. |
5731 | 5731 | ||
5732 | SDK_DEPLOY | 5732 | SDK_DEPLOY |
5733 | The directory set up and used by the | 5733 | The directory set up and used by the |
@@ -5773,8 +5773,8 @@ system and gives an overview of their function and contents. | |||
5773 | The ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class | 5773 | The ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class |
5774 | defines the manifest file as follows: SDK_HOST_MANIFEST = | 5774 | defines the manifest file as follows: SDK_HOST_MANIFEST = |
5775 | "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest" The location is | 5775 | "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.host.manifest" The location is |
5776 | derived using the ```SDK_DEPLOY`` <#var-SDK_DEPLOY>`__ and | 5776 | derived using the :term:`SDK_DEPLOY` and |
5777 | ```TOOLCHAIN_OUTPUTNAME`` <#var-TOOLCHAIN_OUTPUTNAME>`__ variables. | 5777 | :term:`TOOLCHAIN_OUTPUTNAME` variables. |
5778 | 5778 | ||
5779 | SDK_INCLUDE_PKGDATA | 5779 | SDK_INCLUDE_PKGDATA |
5780 | When set to "1", specifies to include the packagedata for all recipes | 5780 | When set to "1", specifies to include the packagedata for all recipes |
@@ -5794,7 +5794,7 @@ system and gives an overview of their function and contents. | |||
5794 | SDK_INCLUDE_TOOLCHAIN | 5794 | SDK_INCLUDE_TOOLCHAIN |
5795 | When set to "1", specifies to include the toolchain in the extensible | 5795 | When set to "1", specifies to include the toolchain in the extensible |
5796 | SDK. Including the toolchain is useful particularly when | 5796 | SDK. Including the toolchain is useful particularly when |
5797 | ```SDK_EXT_TYPE`` <#var-SDK_EXT_TYPE>`__ is set to "minimal" to keep | 5797 | :term:`SDK_EXT_TYPE` is set to "minimal" to keep |
5798 | the SDK reasonably small but you still want to provide a usable | 5798 | the SDK reasonably small but you still want to provide a usable |
5799 | toolchain. For example, suppose you want to use the toolchain from an | 5799 | toolchain. For example, suppose you want to use the toolchain from an |
5800 | IDE or from other tools and you do not want to perform additional | 5800 | IDE or from other tools and you do not want to perform additional |
@@ -5805,7 +5805,7 @@ system and gives an overview of their function and contents. | |||
5805 | ``SDK_EXT_TYPE`` is set to "full". | 5805 | ``SDK_EXT_TYPE`` is set to "full". |
5806 | 5806 | ||
5807 | SDK_INHERIT_BLACKLIST | 5807 | SDK_INHERIT_BLACKLIST |
5808 | A list of classes to remove from the ```INHERIT`` <#var-INHERIT>`__ | 5808 | A list of classes to remove from the :term:`INHERIT` |
5809 | value globally within the extensible SDK configuration. The | 5809 | value globally within the extensible SDK configuration. The |
5810 | ```populate-sdk-ext`` <#ref-classes-populate-sdk-*>`__ class sets the | 5810 | ```populate-sdk-ext`` <#ref-classes-populate-sdk-*>`__ class sets the |
5811 | default value: SDK_INHERIT_BLACKLIST ?= "buildhistory icecc" | 5811 | default value: SDK_INHERIT_BLACKLIST ?= "buildhistory icecc" |
@@ -5829,14 +5829,14 @@ system and gives an overview of their function and contents. | |||
5829 | By default, ``SDK_LOCAL_CONF_BLACKLIST`` is set in the | 5829 | By default, ``SDK_LOCAL_CONF_BLACKLIST`` is set in the |
5830 | ```populate-sdk-ext`` <#ref-classes-populate-sdk-*>`__ class and | 5830 | ```populate-sdk-ext`` <#ref-classes-populate-sdk-*>`__ class and |
5831 | excludes the following variables: | 5831 | excludes the following variables: |
5832 | `CONF_VERSION <#var-CONF_VERSION>`__ | 5832 | :term:`CONF_VERSION` |
5833 | `BB_NUMBER_THREADS <#var-BB_NUMBER_THREADS>`__ | 5833 | :term:`BB_NUMBER_THREADS` |
5834 | `BB_NUMBER_PARSE_THREADS <&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS>`__ | 5834 | `BB_NUMBER_PARSE_THREADS <&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS>`__ |
5835 | `PARALLEL_MAKE <#var-PARALLEL_MAKE>`__ | 5835 | :term:`PARALLEL_MAKE` |
5836 | `PRSERV_HOST <#var-PRSERV_HOST>`__ | 5836 | :term:`PRSERV_HOST` |
5837 | `SSTATE_MIRRORS <#var-SSTATE_MIRRORS>`__ `DL_DIR <#var-DL_DIR>`__ | 5837 | :term:`SSTATE_MIRRORS` :term:`DL_DIR` |
5838 | `SSTATE_DIR <#var-SSTATE_DIR>`__ `TMPDIR <#var-TMPDIR>`__ | 5838 | :term:`SSTATE_DIR` :term:`TMPDIR` |
5839 | `BB_SERVER_TIMEOUT <#var-BB_SERVER_TIMEOUT>`__ | 5839 | :term:`BB_SERVER_TIMEOUT` |
5840 | 5840 | ||
5841 | For additional information on how to customize the extensible SDK's | 5841 | For additional information on how to customize the extensible SDK's |
5842 | configuration, see the "`Configuring the Extensible | 5842 | configuration, see the "`Configuring the Extensible |
@@ -5851,7 +5851,7 @@ system and gives an overview of their function and contents. | |||
5851 | ```populate-sdk-ext`` <#ref-classes-populate-sdk-*>`__ class. | 5851 | ```populate-sdk-ext`` <#ref-classes-populate-sdk-*>`__ class. |
5852 | 5852 | ||
5853 | This list overrides the variables specified using the | 5853 | This list overrides the variables specified using the |
5854 | ```SDK_LOCAL_CONF_BLACKLIST`` <#var-SDK_LOCAL_CONF_BLACKLIST>`__ | 5854 | :term:`SDK_LOCAL_CONF_BLACKLIST` |
5855 | variable as well as any variables identified by automatic | 5855 | variable as well as any variables identified by automatic |
5856 | blacklisting due to the "/" character being found at the start of the | 5856 | blacklisting due to the "/" character being found at the start of the |
5857 | value, which is usually indicative of being a path and thus might not | 5857 | value, which is usually indicative of being a path and thus might not |
@@ -5865,15 +5865,15 @@ system and gives an overview of their function and contents. | |||
5865 | 5865 | ||
5866 | SDK_NAME | 5866 | SDK_NAME |
5867 | The base name for SDK output files. The name is derived from the | 5867 | The base name for SDK output files. The name is derived from the |
5868 | ```DISTRO`` <#var-DISTRO>`__, ```TCLIBC`` <#var-TCLIBC>`__, | 5868 | :term:`DISTRO`, :term:`TCLIBC`, |
5869 | ```SDK_ARCH`` <#var-SDK_ARCH>`__, | 5869 | :term:`SDK_ARCH`, |
5870 | ```IMAGE_BASENAME`` <#var-IMAGE_BASENAME>`__, and | 5870 | :term:`IMAGE_BASENAME`, and |
5871 | ```TUNE_PKGARCH`` <#var-TUNE_PKGARCH>`__ variables: SDK_NAME = | 5871 | :term:`TUNE_PKGARCH` variables: SDK_NAME = |
5872 | "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}" | 5872 | "${DISTRO}-${TCLIBC}-${SDK_ARCH}-${IMAGE_BASENAME}-${TUNE_PKGARCH}" |
5873 | 5873 | ||
5874 | SDK_OS | 5874 | SDK_OS |
5875 | Specifies the operating system for which the SDK will be built. The | 5875 | Specifies the operating system for which the SDK will be built. The |
5876 | default value is the value of ```BUILD_OS`` <#var-BUILD_OS>`__. | 5876 | default value is the value of :term:`BUILD_OS`. |
5877 | 5877 | ||
5878 | SDK_OUTPUT | 5878 | SDK_OUTPUT |
5879 | The location used by the OpenEmbedded build system when creating SDK | 5879 | The location used by the OpenEmbedded build system when creating SDK |
@@ -5908,12 +5908,12 @@ system and gives an overview of their function and contents. | |||
5908 | If you need to pass an SDK path to a command within a function, you | 5908 | If you need to pass an SDK path to a command within a function, you |
5909 | can use ``${SDK_DIR}``, which points to the parent directory used by | 5909 | can use ``${SDK_DIR}``, which points to the parent directory used by |
5910 | the OpenEmbedded build system when creating SDK output. See the | 5910 | the OpenEmbedded build system when creating SDK output. See the |
5911 | ```SDK_DIR`` <#var-SDK_DIR>`__ variable for more information. | 5911 | :term:`SDK_DIR` variable for more information. |
5912 | 5912 | ||
5913 | SDK_PREFIX | 5913 | SDK_PREFIX |
5914 | The toolchain binary prefix used for ``nativesdk`` recipes. The | 5914 | The toolchain binary prefix used for ``nativesdk`` recipes. The |
5915 | OpenEmbedded build system uses the ``SDK_PREFIX`` value to set the | 5915 | OpenEmbedded build system uses the ``SDK_PREFIX`` value to set the |
5916 | ```TARGET_PREFIX`` <#var-TARGET_PREFIX>`__ when building | 5916 | :term:`TARGET_PREFIX` when building |
5917 | ``nativesdk`` recipes. The default value is "${SDK_SYS}-". | 5917 | ``nativesdk`` recipes. The default value is "${SDK_SYS}-". |
5918 | 5918 | ||
5919 | SDK_RECRDEP_TASKS | 5919 | SDK_RECRDEP_TASKS |
@@ -5924,16 +5924,16 @@ system and gives an overview of their function and contents. | |||
5924 | to the SDK. To specify tasks beyond these four, you need to use the | 5924 | to the SDK. To specify tasks beyond these four, you need to use the |
5925 | ``SDK_RECRDEP_TASKS`` variable (e.g. you are defining additional | 5925 | ``SDK_RECRDEP_TASKS`` variable (e.g. you are defining additional |
5926 | tasks that are needed in order to build | 5926 | tasks that are needed in order to build |
5927 | ```SDK_TARGETS`` <#var-SDK_TARGETS>`__). | 5927 | :term:`SDK_TARGETS`). |
5928 | 5928 | ||
5929 | SDK_SYS | 5929 | SDK_SYS |
5930 | Specifies the system, including the architecture and the operating | 5930 | Specifies the system, including the architecture and the operating |
5931 | system, for which the SDK will be built. | 5931 | system, for which the SDK will be built. |
5932 | 5932 | ||
5933 | The OpenEmbedded build system automatically sets this variable based | 5933 | The OpenEmbedded build system automatically sets this variable based |
5934 | on ```SDK_ARCH`` <#var-SDK_ARCH>`__, | 5934 | on :term:`SDK_ARCH`, |
5935 | ```SDK_VENDOR`` <#var-SDK_VENDOR>`__, and | 5935 | :term:`SDK_VENDOR`, and |
5936 | ```SDK_OS`` <#var-SDK_OS>`__. You do not need to set the ``SDK_SYS`` | 5936 | :term:`SDK_OS`. You do not need to set the ``SDK_SYS`` |
5937 | variable yourself. | 5937 | variable yourself. |
5938 | 5938 | ||
5939 | SDK_TARGET_MANIFEST | 5939 | SDK_TARGET_MANIFEST |
@@ -5945,8 +5945,8 @@ system and gives an overview of their function and contents. | |||
5945 | The ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class | 5945 | The ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class |
5946 | defines the manifest file as follows: SDK_TARGET_MANIFEST = | 5946 | defines the manifest file as follows: SDK_TARGET_MANIFEST = |
5947 | "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest" The location | 5947 | "${SDK_DEPLOY}/${TOOLCHAIN_OUTPUTNAME}.target.manifest" The location |
5948 | is derived using the ```SDK_DEPLOY`` <#var-SDK_DEPLOY>`__ and | 5948 | is derived using the :term:`SDK_DEPLOY` and |
5949 | ```TOOLCHAIN_OUTPUTNAME`` <#var-TOOLCHAIN_OUTPUTNAME>`__ variables. | 5949 | :term:`TOOLCHAIN_OUTPUTNAME` variables. |
5950 | 5950 | ||
5951 | SDK_TARGETS | 5951 | SDK_TARGETS |
5952 | A list of targets to install from shared state as part of the | 5952 | A list of targets to install from shared state as part of the |
@@ -5958,8 +5958,8 @@ system and gives an overview of their function and contents. | |||
5958 | 5958 | ||
5959 | SDK_TITLE | 5959 | SDK_TITLE |
5960 | The title to be printed when running the SDK installer. By default, | 5960 | The title to be printed when running the SDK installer. By default, |
5961 | this title is based on the ```DISTRO_NAME`` <#var-DISTRO_NAME>`__ or | 5961 | this title is based on the :term:`DISTRO_NAME` or |
5962 | ```DISTRO`` <#var-DISTRO>`__ variable and is set in the | 5962 | :term:`DISTRO` variable and is set in the |
5963 | ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class as | 5963 | ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class as |
5964 | follows: SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or | 5964 | follows: SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or |
5965 | d.getVar('DISTRO')} SDK" For the default distribution "poky", | 5965 | d.getVar('DISTRO')} SDK" For the default distribution "poky", |
@@ -5986,12 +5986,12 @@ system and gives an overview of their function and contents. | |||
5986 | "${@d.getVar('DISTRO_VERSION').replace('snapshot-${DATE}','snapshot')}" | 5986 | "${@d.getVar('DISTRO_VERSION').replace('snapshot-${DATE}','snapshot')}" |
5987 | 5987 | ||
5988 | For additional information, see the | 5988 | For additional information, see the |
5989 | ```DISTRO_VERSION`` <#var-DISTRO_VERSION>`__ and | 5989 | :term:`DISTRO_VERSION` and |
5990 | ```DATE`` <#var-DATE>`__ variables. | 5990 | :term:`DATE` variables. |
5991 | 5991 | ||
5992 | SDKEXTPATH | 5992 | SDKEXTPATH |
5993 | The default installation directory for the Extensible SDK. By | 5993 | The default installation directory for the Extensible SDK. By |
5994 | default, this directory is based on the ```DISTRO`` <#var-DISTRO>`__ | 5994 | default, this directory is based on the :term:`DISTRO` |
5995 | variable and is set in the | 5995 | variable and is set in the |
5996 | ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class as | 5996 | ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class as |
5997 | follows: SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" For the | 5997 | follows: SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" For the |
@@ -6035,7 +6035,7 @@ system and gives an overview of their function and contents. | |||
6035 | SDKTARGETSYSROOT | 6035 | SDKTARGETSYSROOT |
6036 | The full path to the sysroot used for cross-compilation within an SDK | 6036 | The full path to the sysroot used for cross-compilation within an SDK |
6037 | as it will be when installed into the default | 6037 | as it will be when installed into the default |
6038 | ```SDKPATH`` <#var-SDKPATH>`__. | 6038 | :term:`SDKPATH`. |
6039 | 6039 | ||
6040 | SECTION | 6040 | SECTION |
6041 | The section in which packages should be categorized. Package | 6041 | The section in which packages should be categorized. Package |
@@ -6044,7 +6044,7 @@ system and gives an overview of their function and contents. | |||
6044 | SELECTED_OPTIMIZATION | 6044 | SELECTED_OPTIMIZATION |
6045 | Specifies the optimization flags passed to the C compiler when | 6045 | Specifies the optimization flags passed to the C compiler when |
6046 | building for the target. The flags are passed through the default | 6046 | building for the target. The flags are passed through the default |
6047 | value of the ```TARGET_CFLAGS`` <#var-TARGET_CFLAGS>`__ variable. | 6047 | value of the :term:`TARGET_CFLAGS` variable. |
6048 | 6048 | ||
6049 | The ``SELECTED_OPTIMIZATION`` variable takes the value of | 6049 | The ``SELECTED_OPTIMIZATION`` variable takes the value of |
6050 | ``FULL_OPTIMIZATION`` unless ``DEBUG_BUILD`` = "1". If that is the | 6050 | ``FULL_OPTIMIZATION`` unless ``DEBUG_BUILD`` = "1". If that is the |
@@ -6074,7 +6074,7 @@ system and gives an overview of their function and contents. | |||
6074 | 6074 | ||
6075 | SERIAL_CONSOLES_CHECK | 6075 | SERIAL_CONSOLES_CHECK |
6076 | Specifies serial consoles, which must be listed in | 6076 | Specifies serial consoles, which must be listed in |
6077 | ```SERIAL_CONSOLES`` <#var-SERIAL_CONSOLES>`__, to check against | 6077 | :term:`SERIAL_CONSOLES`, to check against |
6078 | ``/proc/console`` before enabling them using getty. This variable | 6078 | ``/proc/console`` before enabling them using getty. This variable |
6079 | allows aliasing in the format: <device>:<alias>. If a device was | 6079 | allows aliasing in the format: <device>:<alias>. If a device was |
6080 | listed as "sclp_line0" in ``/dev/`` and "ttyS0" was listed in | 6080 | listed as "sclp_line0" in ``/dev/`` and "ttyS0" was listed in |
@@ -6175,8 +6175,8 @@ system and gives an overview of their function and contents. | |||
6175 | recipes are fetched regardless of whether or not a recipe is | 6175 | recipes are fetched regardless of whether or not a recipe is |
6176 | compatible with the configuration. A recipe is considered | 6176 | compatible with the configuration. A recipe is considered |
6177 | incompatible with the currently configured machine when either or | 6177 | incompatible with the currently configured machine when either or |
6178 | both the ```COMPATIBLE_MACHINE`` <#var-COMPATIBLE_MACHINE>`__ | 6178 | both the :term:`COMPATIBLE_MACHINE` |
6179 | variable and ```COMPATIBLE_HOST`` <#var-COMPATIBLE_HOST>`__ variables | 6179 | variable and :term:`COMPATIBLE_HOST` variables |
6180 | specify compatibility with a machine other than that of the current | 6180 | specify compatibility with a machine other than that of the current |
6181 | machine or host. | 6181 | machine or host. |
6182 | 6182 | ||
@@ -6188,12 +6188,12 @@ system and gives an overview of their function and contents. | |||
6188 | do not set the variable during a normal build. | 6188 | do not set the variable during a normal build. |
6189 | 6189 | ||
6190 | SOURCE_MIRROR_URL | 6190 | SOURCE_MIRROR_URL |
6191 | Defines your own ```PREMIRRORS`` <#var-PREMIRRORS>`__ from which to | 6191 | Defines your own :term:`PREMIRRORS` from which to |
6192 | first fetch source before attempting to fetch from the upstream | 6192 | first fetch source before attempting to fetch from the upstream |
6193 | specified in ```SRC_URI`` <#var-SRC_URI>`__. | 6193 | specified in :term:`SRC_URI`. |
6194 | 6194 | ||
6195 | To use this variable, you must globally inherit the | 6195 | To use this variable, you must globally inherit the |
6196 | ```own-mirrors`` <#ref-classes-own-mirrors>`__ class and then provide | 6196 | :ref:`own-mirrors <ref-classes-own-mirrors>` class and then provide |
6197 | the URL to your mirrors. Here is the general syntax: INHERIT += | 6197 | the URL to your mirrors. Here is the general syntax: INHERIT += |
6198 | "own-mirrors" SOURCE_MIRROR_URL = | 6198 | "own-mirrors" SOURCE_MIRROR_URL = |
6199 | "http://example.com/my_source_mirror" | 6199 | "http://example.com/my_source_mirror" |
@@ -6209,14 +6209,14 @@ system and gives an overview of their function and contents. | |||
6209 | ``meta/files/common-licenses/``. For the default ``SPDXLICENSEMAP`` | 6209 | ``meta/files/common-licenses/``. For the default ``SPDXLICENSEMAP`` |
6210 | mappings, see the ``meta/conf/licenses.conf`` file. | 6210 | mappings, see the ``meta/conf/licenses.conf`` file. |
6211 | 6211 | ||
6212 | For additional information, see the ```LICENSE`` <#var-LICENSE>`__ | 6212 | For additional information, see the :term:`LICENSE` |
6213 | variable. | 6213 | variable. |
6214 | 6214 | ||
6215 | SPECIAL_PKGSUFFIX | 6215 | SPECIAL_PKGSUFFIX |
6216 | A list of prefixes for ```PN`` <#var-PN>`__ used by the OpenEmbedded | 6216 | A list of prefixes for :term:`PN` used by the OpenEmbedded |
6217 | build system to create variants of recipes or packages. The list | 6217 | build system to create variants of recipes or packages. The list |
6218 | specifies the prefixes to strip off during certain circumstances such | 6218 | specifies the prefixes to strip off during certain circumstances such |
6219 | as the generation of the ```BPN`` <#var-BPN>`__ variable. | 6219 | as the generation of the :term:`BPN` variable. |
6220 | 6220 | ||
6221 | SPL_BINARY | 6221 | SPL_BINARY |
6222 | The file type for the Secondary Program Loader (SPL). Some devices | 6222 | The file type for the Secondary Program Loader (SPL). Some devices |
@@ -6260,9 +6260,9 @@ system and gives an overview of their function and contents. | |||
6260 | BitBake User Manual. | 6260 | BitBake User Manual. |
6261 | 6261 | ||
6262 | - *``file://`` -* Fetches files, which are usually files shipped | 6262 | - *``file://`` -* Fetches files, which are usually files shipped |
6263 | with the `Metadata <#metadata>`__, from the local machine (e.g. | 6263 | with the :term:`Metadata`, from the local machine (e.g. |
6264 | `patch <&YOCTO_DOCS_OM_URL;#patching-dev-environment>`__ files). | 6264 | `patch <&YOCTO_DOCS_OM_URL;#patching-dev-environment>`__ files). |
6265 | The path is relative to the ```FILESPATH`` <#var-FILESPATH>`__ | 6265 | The path is relative to the :term:`FILESPATH` |
6266 | variable. Thus, the build system searches, in order, from the | 6266 | variable. Thus, the build system searches, in order, from the |
6267 | following directories, which are assumed to be a subdirectories of | 6267 | following directories, which are assumed to be a subdirectories of |
6268 | the directory in which the recipe file (``.bb``) or append file | 6268 | the directory in which the recipe file (``.bb``) or append file |
@@ -6334,13 +6334,13 @@ system and gives an overview of their function and contents. | |||
6334 | patch. The default level is 1. | 6334 | patch. The default level is 1. |
6335 | 6335 | ||
6336 | - *``patchdir`` -* Specifies the directory in which the patch should | 6336 | - *``patchdir`` -* Specifies the directory in which the patch should |
6337 | be applied. The default is ``${``\ ```S`` <#var-S>`__\ ``}``. | 6337 | be applied. The default is ``${``\ :term:`S`\ ``}``. |
6338 | 6338 | ||
6339 | Here are options specific to recipes building code from a revision | 6339 | Here are options specific to recipes building code from a revision |
6340 | control system: | 6340 | control system: |
6341 | 6341 | ||
6342 | - *``mindate`` -* Apply the patch only if | 6342 | - *``mindate`` -* Apply the patch only if |
6343 | ```SRCDATE`` <#var-SRCDATE>`__ is equal to or greater than | 6343 | :term:`SRCDATE` is equal to or greater than |
6344 | ``mindate``. | 6344 | ``mindate``. |
6345 | 6345 | ||
6346 | - *``maxdate`` -* Apply the patch only if ``SRCDATE`` is not later | 6346 | - *``maxdate`` -* Apply the patch only if ``SRCDATE`` is not later |
@@ -6364,7 +6364,7 @@ system and gives an overview of their function and contents. | |||
6364 | an archive. The default action is to unpack the file. | 6364 | an archive. The default action is to unpack the file. |
6365 | 6365 | ||
6366 | - *``destsuffix`` -* Places the file (or extracts its contents) into | 6366 | - *``destsuffix`` -* Places the file (or extracts its contents) into |
6367 | the specified subdirectory of ```WORKDIR`` <#var-WORKDIR>`__ when | 6367 | the specified subdirectory of :term:`WORKDIR` when |
6368 | the Git fetcher is used. | 6368 | the Git fetcher is used. |
6369 | 6369 | ||
6370 | - *``subdir`` -* Places the file (or extracts its contents) into the | 6370 | - *``subdir`` -* Places the file (or extracts its contents) into the |
@@ -6398,10 +6398,10 @@ system and gives an overview of their function and contents. | |||
6398 | 6398 | ||
6399 | SRCPV | 6399 | SRCPV |
6400 | Returns the version string of the current package. This string is | 6400 | Returns the version string of the current package. This string is |
6401 | used to help define the value of ```PV`` <#var-PV>`__. | 6401 | used to help define the value of :term:`PV`. |
6402 | 6402 | ||
6403 | The ``SRCPV`` variable is defined in the ``meta/conf/bitbake.conf`` | 6403 | The ``SRCPV`` variable is defined in the ``meta/conf/bitbake.conf`` |
6404 | configuration file in the `Source Directory <#source-directory>`__ as | 6404 | configuration file in the :term:`Source Directory` as |
6405 | follows: SRCPV = "${@bb.fetch2.get_srcrev(d)}" | 6405 | follows: SRCPV = "${@bb.fetch2.get_srcrev(d)}" |
6406 | 6406 | ||
6407 | Recipes that need to define ``PV`` do so with the help of the | 6407 | Recipes that need to define ``PV`` do so with the help of the |
@@ -6433,7 +6433,7 @@ system and gives an overview of their function and contents. | |||
6433 | 6433 | ||
6434 | SSTATE_MIRROR_ALLOW_NETWORK | 6434 | SSTATE_MIRROR_ALLOW_NETWORK |
6435 | If set to "1", allows fetches from mirrors that are specified in | 6435 | If set to "1", allows fetches from mirrors that are specified in |
6436 | ```SSTATE_MIRRORS`` <#var-SSTATE_MIRRORS>`__ to work even when | 6436 | :term:`SSTATE_MIRRORS` to work even when |
6437 | fetching from the network is disabled by setting ``BB_NO_NETWORK`` to | 6437 | fetching from the network is disabled by setting ``BB_NO_NETWORK`` to |
6438 | "1". Using the ``SSTATE_MIRROR_ALLOW_NETWORK`` variable is useful if | 6438 | "1". Using the ``SSTATE_MIRROR_ALLOW_NETWORK`` variable is useful if |
6439 | you have set ``SSTATE_MIRRORS`` to point to an internal server for | 6439 | you have set ``SSTATE_MIRRORS`` to point to an internal server for |
@@ -6443,8 +6443,8 @@ system and gives an overview of their function and contents. | |||
6443 | SSTATE_MIRRORS | 6443 | SSTATE_MIRRORS |
6444 | Configures the OpenEmbedded build system to search other mirror | 6444 | Configures the OpenEmbedded build system to search other mirror |
6445 | locations for prebuilt cache data objects before building out the | 6445 | locations for prebuilt cache data objects before building out the |
6446 | data. This variable works like fetcher ```MIRRORS`` <#var-MIRRORS>`__ | 6446 | data. This variable works like fetcher :term:`MIRRORS` |
6447 | and ```PREMIRRORS`` <#var-PREMIRRORS>`__ and points to the cache | 6447 | and :term:`PREMIRRORS` and points to the cache |
6448 | locations to check for the shared state (sstate) objects. | 6448 | locations to check for the shared state (sstate) objects. |
6449 | 6449 | ||
6450 | You can specify a filesystem directory or a remote URL such as HTTP | 6450 | You can specify a filesystem directory or a remote URL such as HTTP |
@@ -6456,15 +6456,15 @@ system and gives an overview of their function and contents. | |||
6456 | a different GCC version for native builds, you must configure | 6456 | a different GCC version for native builds, you must configure |
6457 | ``SSTATE_MIRRORS`` with a regular expression that maps local search | 6457 | ``SSTATE_MIRRORS`` with a regular expression that maps local search |
6458 | paths to server paths. The paths need to take into account | 6458 | paths to server paths. The paths need to take into account |
6459 | ```NATIVELSBSTRING`` <#var-NATIVELSBSTRING>`__ set by the | 6459 | :term:`NATIVELSBSTRING` set by the |
6460 | ```uninative`` <#ref-classes-uninative>`__ class. For example, the | 6460 | :ref:`uninative <ref-classes-uninative>` class. For example, the |
6461 | following maps the local search path ``universal-4.9`` to the | 6461 | following maps the local search path ``universal-4.9`` to the |
6462 | server-provided path server_url_sstate_path: SSTATE_MIRRORS ?= | 6462 | server-provided path server_url_sstate_path: SSTATE_MIRRORS ?= |
6463 | file://universal-4.9/(.*) | 6463 | file://universal-4.9/(.*) |
6464 | http://server_url_sstate_path/universal-4.8/\1 \\n | 6464 | http://server_url_sstate_path/universal-4.8/\1 \\n |
6465 | 6465 | ||
6466 | If a mirror uses the same structure as | 6466 | If a mirror uses the same structure as |
6467 | ```SSTATE_DIR`` <#var-SSTATE_DIR>`__, you need to add "PATH" at the | 6467 | :term:`SSTATE_DIR`, you need to add "PATH" at the |
6468 | end as shown in the examples below. The build system substitutes the | 6468 | end as shown in the examples below. The build system substitutes the |
6469 | correct path within the directory structure. SSTATE_MIRRORS ?= "\\ | 6469 | correct path within the directory structure. SSTATE_MIRRORS ?= "\\ |
6470 | file://.\* | 6470 | file://.\* |
@@ -6484,11 +6484,11 @@ system and gives an overview of their function and contents. | |||
6484 | by the ``SSTATE_SCAN_FILES`` variable. Typically, recipes add files | 6484 | by the ``SSTATE_SCAN_FILES`` variable. Typically, recipes add files |
6485 | they want to be scanned to the value of ``SSTATE_SCAN_FILES`` rather | 6485 | they want to be scanned to the value of ``SSTATE_SCAN_FILES`` rather |
6486 | than the variable being comprehensively set. The | 6486 | than the variable being comprehensively set. The |
6487 | ```sstate`` <#ref-classes-sstate>`__ class specifies the default list | 6487 | :ref:`sstate <ref-classes-sstate>` class specifies the default list |
6488 | of files. | 6488 | of files. |
6489 | 6489 | ||
6490 | For details on the process, see the | 6490 | For details on the process, see the |
6491 | ```staging`` <#ref-classes-staging>`__ class. | 6491 | :ref:`staging <ref-classes-staging>` class. |
6492 | 6492 | ||
6493 | STAGING_BASE_LIBDIR_NATIVE | 6493 | STAGING_BASE_LIBDIR_NATIVE |
6494 | Specifies the path to the ``/lib`` subdirectory of the sysroot | 6494 | Specifies the path to the ``/lib`` subdirectory of the sysroot |
@@ -6497,12 +6497,12 @@ system and gives an overview of their function and contents. | |||
6497 | STAGING_BASELIBDIR | 6497 | STAGING_BASELIBDIR |
6498 | Specifies the path to the ``/lib`` subdirectory of the sysroot | 6498 | Specifies the path to the ``/lib`` subdirectory of the sysroot |
6499 | directory for the target for which the current recipe is being built | 6499 | directory for the target for which the current recipe is being built |
6500 | (```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__). | 6500 | (:term:`STAGING_DIR_HOST`). |
6501 | 6501 | ||
6502 | STAGING_BINDIR | 6502 | STAGING_BINDIR |
6503 | Specifies the path to the ``/usr/bin`` subdirectory of the sysroot | 6503 | Specifies the path to the ``/usr/bin`` subdirectory of the sysroot |
6504 | directory for the target for which the current recipe is being built | 6504 | directory for the target for which the current recipe is being built |
6505 | (```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__). | 6505 | (:term:`STAGING_DIR_HOST`). |
6506 | 6506 | ||
6507 | STAGING_BINDIR_CROSS | 6507 | STAGING_BINDIR_CROSS |
6508 | Specifies the path to the directory containing binary configuration | 6508 | Specifies the path to the directory containing binary configuration |
@@ -6528,7 +6528,7 @@ system and gives an overview of their function and contents. | |||
6528 | STAGING_DATADIR | 6528 | STAGING_DATADIR |
6529 | Specifies the path to the ``/usr/share`` subdirectory of the sysroot | 6529 | Specifies the path to the ``/usr/share`` subdirectory of the sysroot |
6530 | directory for the target for which the current recipe is being built | 6530 | directory for the target for which the current recipe is being built |
6531 | (```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__). | 6531 | (:term:`STAGING_DIR_HOST`). |
6532 | 6532 | ||
6533 | STAGING_DATADIR_NATIVE | 6533 | STAGING_DATADIR_NATIVE |
6534 | Specifies the path to the ``/usr/share`` subdirectory of the sysroot | 6534 | Specifies the path to the ``/usr/share`` subdirectory of the sysroot |
@@ -6539,14 +6539,14 @@ system and gives an overview of their function and contents. | |||
6539 | during packaging. | 6539 | during packaging. |
6540 | 6540 | ||
6541 | For information on how staging for recipe-specific sysroots occurs, | 6541 | For information on how staging for recipe-specific sysroots occurs, |
6542 | see the ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ | 6542 | see the :ref:`ref-tasks-populate_sysroot` |
6543 | task, the "`Sharing Files Between | 6543 | task, the "`Sharing Files Between |
6544 | Recipes <&YOCTO_DOCS_DEV_URL;#new-sharing-files-between-recipes>`__" | 6544 | Recipes <&YOCTO_DOCS_DEV_URL;#new-sharing-files-between-recipes>`__" |
6545 | section in the Yocto Project Development Tasks Manual, the | 6545 | section in the Yocto Project Development Tasks Manual, the |
6546 | "`Configuration, Compilation, and | 6546 | "`Configuration, Compilation, and |
6547 | Staging <&YOCTO_DOCS_OM_URL;#configuration-compilation-and-staging-dev-environment>`__" | 6547 | Staging <&YOCTO_DOCS_OM_URL;#configuration-compilation-and-staging-dev-environment>`__" |
6548 | section in the Yocto Project Overview and Concepts Manual, and the | 6548 | section in the Yocto Project Overview and Concepts Manual, and the |
6549 | ```SYSROOT_DIRS`` <#var-SYSROOT_DIRS>`__ variable. | 6549 | :term:`SYSROOT_DIRS` variable. |
6550 | 6550 | ||
6551 | .. note:: | 6551 | .. note:: |
6552 | 6552 | ||
@@ -6566,15 +6566,15 @@ system and gives an overview of their function and contents. | |||
6566 | Specifies the path to the sysroot directory for the system on which | 6566 | Specifies the path to the sysroot directory for the system on which |
6567 | the component is built to run (the system that hosts the component). | 6567 | the component is built to run (the system that hosts the component). |
6568 | For most recipes, this sysroot is the one in which that recipe's | 6568 | For most recipes, this sysroot is the one in which that recipe's |
6569 | ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task copies | 6569 | :ref:`ref-tasks-populate_sysroot` task copies |
6570 | files. Exceptions include ``-native`` recipes, where the | 6570 | files. Exceptions include ``-native`` recipes, where the |
6571 | ``do_populate_sysroot`` task instead uses | 6571 | ``do_populate_sysroot`` task instead uses |
6572 | ```STAGING_DIR_NATIVE`` <#var-STAGING_DIR_NATIVE>`__. Depending on | 6572 | :term:`STAGING_DIR_NATIVE`. Depending on |
6573 | the type of recipe and the build target, ``STAGING_DIR_HOST`` can | 6573 | the type of recipe and the build target, ``STAGING_DIR_HOST`` can |
6574 | have the following values: | 6574 | have the following values: |
6575 | 6575 | ||
6576 | - For recipes building for the target machine, the value is | 6576 | - For recipes building for the target machine, the value is |
6577 | "${`STAGING_DIR <#var-STAGING_DIR>`__}/${`MACHINE <#var-MACHINE>`__}". | 6577 | "${:term:`STAGING_DIR`}/${:term:`MACHINE`}". |
6578 | 6578 | ||
6579 | - For native recipes building for the build host, the value is empty | 6579 | - For native recipes building for the build host, the value is empty |
6580 | given the assumption that when building for the build host, the | 6580 | given the assumption that when building for the build host, the |
@@ -6586,16 +6586,16 @@ system and gives an overview of their function and contents. | |||
6586 | as ``/usr``. Rather, these recipes are installed into | 6586 | as ``/usr``. Rather, these recipes are installed into |
6587 | ``STAGING_DIR_NATIVE``. When compiling ``-native`` recipes, | 6587 | ``STAGING_DIR_NATIVE``. When compiling ``-native`` recipes, |
6588 | standard build environment variables such as | 6588 | standard build environment variables such as |
6589 | ```CPPFLAGS`` <#var-CPPFLAGS>`__ and | 6589 | :term:`CPPFLAGS` and |
6590 | ```CFLAGS`` <#var-CFLAGS>`__ are set up so that both host paths | 6590 | :term:`CFLAGS` are set up so that both host paths |
6591 | and ``STAGING_DIR_NATIVE`` are searched for libraries and | 6591 | and ``STAGING_DIR_NATIVE`` are searched for libraries and |
6592 | headers using, for example, GCC's ``-isystem`` option. | 6592 | headers using, for example, GCC's ``-isystem`` option. |
6593 | 6593 | ||
6594 | Thus, the emphasis is that the ``STAGING_DIR*`` variables | 6594 | Thus, the emphasis is that the ``STAGING_DIR*`` variables |
6595 | should be viewed as input variables by tasks such as | 6595 | should be viewed as input variables by tasks such as |
6596 | ```do_configure`` <#ref-tasks-configure>`__, | 6596 | :ref:`ref-tasks-configure`, |
6597 | ```do_compile`` <#ref-tasks-compile>`__, and | 6597 | :ref:`ref-tasks-compile`, and |
6598 | ```do_install`` <#ref-tasks-install>`__. Having the real system | 6598 | :ref:`ref-tasks-install`. Having the real system |
6599 | root correspond to ``STAGING_DIR_HOST`` makes conceptual sense | 6599 | root correspond to ``STAGING_DIR_HOST`` makes conceptual sense |
6600 | for ``-native`` recipes, as they make use of host headers and | 6600 | for ``-native`` recipes, as they make use of host headers and |
6601 | libraries. | 6601 | libraries. |
@@ -6608,7 +6608,7 @@ system and gives an overview of their function and contents. | |||
6608 | Specifies the path to the sysroot used for the system for which the | 6608 | Specifies the path to the sysroot used for the system for which the |
6609 | component generates code. For components that do not generate code, | 6609 | component generates code. For components that do not generate code, |
6610 | which is the majority, ``STAGING_DIR_TARGET`` is set to match | 6610 | which is the majority, ``STAGING_DIR_TARGET`` is set to match |
6611 | ```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__. | 6611 | :term:`STAGING_DIR_HOST`. |
6612 | 6612 | ||
6613 | Some recipes build binaries that can run on the target system but | 6613 | Some recipes build binaries that can run on the target system but |
6614 | those binaries in turn generate code for another different system | 6614 | those binaries in turn generate code for another different system |
@@ -6627,12 +6627,12 @@ system and gives an overview of their function and contents. | |||
6627 | STAGING_EXECPREFIXDIR | 6627 | STAGING_EXECPREFIXDIR |
6628 | Specifies the path to the ``/usr`` subdirectory of the sysroot | 6628 | Specifies the path to the ``/usr`` subdirectory of the sysroot |
6629 | directory for the target for which the current recipe is being built | 6629 | directory for the target for which the current recipe is being built |
6630 | (```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__). | 6630 | (:term:`STAGING_DIR_HOST`). |
6631 | 6631 | ||
6632 | STAGING_INCDIR | 6632 | STAGING_INCDIR |
6633 | Specifies the path to the ``/usr/include`` subdirectory of the | 6633 | Specifies the path to the ``/usr/include`` subdirectory of the |
6634 | sysroot directory for the target for which the current recipe being | 6634 | sysroot directory for the target for which the current recipe being |
6635 | built (```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__). | 6635 | built (:term:`STAGING_DIR_HOST`). |
6636 | 6636 | ||
6637 | STAGING_INCDIR_NATIVE | 6637 | STAGING_INCDIR_NATIVE |
6638 | Specifies the path to the ``/usr/include`` subdirectory of the | 6638 | Specifies the path to the ``/usr/include`` subdirectory of the |
@@ -6652,7 +6652,7 @@ system and gives an overview of their function and contents. | |||
6652 | STAGING_LIBDIR | 6652 | STAGING_LIBDIR |
6653 | Specifies the path to the ``/usr/lib`` subdirectory of the sysroot | 6653 | Specifies the path to the ``/usr/lib`` subdirectory of the sysroot |
6654 | directory for the target for which the current recipe is being built | 6654 | directory for the target for which the current recipe is being built |
6655 | (```STAGING_DIR_HOST`` <#var-STAGING_DIR_HOST>`__). | 6655 | (:term:`STAGING_DIR_HOST`). |
6656 | 6656 | ||
6657 | STAGING_LIBDIR_NATIVE | 6657 | STAGING_LIBDIR_NATIVE |
6658 | Specifies the path to the ``/usr/lib`` subdirectory of the sysroot | 6658 | Specifies the path to the ``/usr/lib`` subdirectory of the sysroot |
@@ -6671,10 +6671,10 @@ system and gives an overview of their function and contents. | |||
6671 | Tasks <&YOCTO_DOCS_OM_URL;#stamp-files-and-the-rerunning-of-tasks>`__" | 6671 | Tasks <&YOCTO_DOCS_OM_URL;#stamp-files-and-the-rerunning-of-tasks>`__" |
6672 | section in the Yocto Project Overview and Concepts Manual. | 6672 | section in the Yocto Project Overview and Concepts Manual. |
6673 | 6673 | ||
6674 | See ```STAMPS_DIR`` <#var-STAMPS_DIR>`__, | 6674 | See :term:`STAMPS_DIR`, |
6675 | ```MULTIMACH_TARGET_SYS`` <#var-MULTIMACH_TARGET_SYS>`__, | 6675 | :term:`MULTIMACH_TARGET_SYS`, |
6676 | ```PN`` <#var-PN>`__, ```EXTENDPE`` <#var-EXTENDPE>`__, | 6676 | :term:`PN`, :term:`EXTENDPE`, |
6677 | ```PV`` <#var-PV>`__, and ```PR`` <#var-PR>`__ for related variable | 6677 | :term:`PV`, and :term:`PR` for related variable |
6678 | information. | 6678 | information. |
6679 | 6679 | ||
6680 | STAMPS_DIR | 6680 | STAMPS_DIR |
@@ -6689,7 +6689,7 @@ system and gives an overview of their function and contents. | |||
6689 | The short (72 characters or less) summary of the binary package for | 6689 | The short (72 characters or less) summary of the binary package for |
6690 | packaging systems such as ``opkg``, ``rpm``, or ``dpkg``. By default, | 6690 | packaging systems such as ``opkg``, ``rpm``, or ``dpkg``. By default, |
6691 | ``SUMMARY`` is used to define the | 6691 | ``SUMMARY`` is used to define the |
6692 | ```DESCRIPTION`` <#var-DESCRIPTION>`__ variable if ``DESCRIPTION`` is | 6692 | :term:`DESCRIPTION` variable if ``DESCRIPTION`` is |
6693 | not set in the recipe. | 6693 | not set in the recipe. |
6694 | 6694 | ||
6695 | SVNDIR | 6695 | SVNDIR |
@@ -6702,7 +6702,7 @@ system and gives an overview of their function and contents. | |||
6702 | follows where "X" is the console number you want to use: | 6702 | follows where "X" is the console number you want to use: |
6703 | SYSLINUX_DEFAULT_CONSOLE = "console=ttyX" | 6703 | SYSLINUX_DEFAULT_CONSOLE = "console=ttyX" |
6704 | 6704 | ||
6705 | The ```syslinux`` <#ref-classes-syslinux>`__ class initially sets | 6705 | The :ref:`syslinux <ref-classes-syslinux>` class initially sets |
6706 | this variable to null but then checks for a value later. | 6706 | this variable to null but then checks for a value later. |
6707 | 6707 | ||
6708 | SYSLINUX_OPTS | 6708 | SYSLINUX_OPTS |
@@ -6710,14 +6710,14 @@ system and gives an overview of their function and contents. | |||
6710 | this variable in your recipe. If you want to list multiple options, | 6710 | this variable in your recipe. If you want to list multiple options, |
6711 | separate the options with a semicolon character (``;``). | 6711 | separate the options with a semicolon character (``;``). |
6712 | 6712 | ||
6713 | The ```syslinux`` <#ref-classes-syslinux>`__ class uses this variable | 6713 | The :ref:`syslinux <ref-classes-syslinux>` class uses this variable |
6714 | to create a set of options. | 6714 | to create a set of options. |
6715 | 6715 | ||
6716 | SYSLINUX_SERIAL | 6716 | SYSLINUX_SERIAL |
6717 | Specifies the alternate serial port or turns it off. To turn off | 6717 | Specifies the alternate serial port or turns it off. To turn off |
6718 | serial, set this variable to an empty string in your recipe. The | 6718 | serial, set this variable to an empty string in your recipe. The |
6719 | variable's default value is set in the | 6719 | variable's default value is set in the |
6720 | ```syslinux`` <#ref-classes-syslinux>`__ class as follows: | 6720 | :ref:`syslinux <ref-classes-syslinux>` class as follows: |
6721 | SYSLINUX_SERIAL ?= "0 115200" | 6721 | SYSLINUX_SERIAL ?= "0 115200" |
6722 | 6722 | ||
6723 | The class checks for and uses the variable as needed. | 6723 | The class checks for and uses the variable as needed. |
@@ -6726,36 +6726,36 @@ system and gives an overview of their function and contents. | |||
6726 | An ``.LSS`` file used as the background for the VGA boot menu when | 6726 | An ``.LSS`` file used as the background for the VGA boot menu when |
6727 | you use the boot menu. You need to set this variable in your recipe. | 6727 | you use the boot menu. You need to set this variable in your recipe. |
6728 | 6728 | ||
6729 | The ```syslinux`` <#ref-classes-syslinux>`__ class checks for this | 6729 | The :ref:`syslinux <ref-classes-syslinux>` class checks for this |
6730 | variable and if found, the OpenEmbedded build system installs the | 6730 | variable and if found, the OpenEmbedded build system installs the |
6731 | splash screen. | 6731 | splash screen. |
6732 | 6732 | ||
6733 | SYSLINUX_SERIAL_TTY | 6733 | SYSLINUX_SERIAL_TTY |
6734 | Specifies the alternate console=tty... kernel boot argument. The | 6734 | Specifies the alternate console=tty... kernel boot argument. The |
6735 | variable's default value is set in the | 6735 | variable's default value is set in the |
6736 | ```syslinux`` <#ref-classes-syslinux>`__ class as follows: | 6736 | :ref:`syslinux <ref-classes-syslinux>` class as follows: |
6737 | SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200" | 6737 | SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200" |
6738 | 6738 | ||
6739 | The class checks for and uses the variable as needed. | 6739 | The class checks for and uses the variable as needed. |
6740 | 6740 | ||
6741 | SYSROOT_DESTDIR | 6741 | SYSROOT_DESTDIR |
6742 | Points to the temporary directory under the work directory (default | 6742 | Points to the temporary directory under the work directory (default |
6743 | "``${``\ ```WORKDIR`` <#var-WORKDIR>`__\ ``}/sysroot-destdir``") | 6743 | "``${``\ :term:`WORKDIR`\ ``}/sysroot-destdir``") |
6744 | where the files populated into the sysroot are assembled during the | 6744 | where the files populated into the sysroot are assembled during the |
6745 | ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task. | 6745 | :ref:`ref-tasks-populate_sysroot` task. |
6746 | 6746 | ||
6747 | SYSROOT_DIRS | 6747 | SYSROOT_DIRS |
6748 | Directories that are staged into the sysroot by the | 6748 | Directories that are staged into the sysroot by the |
6749 | ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task. By | 6749 | :ref:`ref-tasks-populate_sysroot` task. By |
6750 | default, the following directories are staged: SYSROOT_DIRS = " \\ | 6750 | default, the following directories are staged: SYSROOT_DIRS = " \\ |
6751 | ${includedir} \\ ${libdir} \\ ${base_libdir} \\ | 6751 | ${includedir} \\ ${libdir} \\ ${base_libdir} \\ |
6752 | ${nonarch_base_libdir} \\ ${datadir} \\ " | 6752 | ${nonarch_base_libdir} \\ ${datadir} \\ " |
6753 | 6753 | ||
6754 | SYSROOT_DIRS_BLACKLIST | 6754 | SYSROOT_DIRS_BLACKLIST |
6755 | Directories that are not staged into the sysroot by the | 6755 | Directories that are not staged into the sysroot by the |
6756 | ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task. You | 6756 | :ref:`ref-tasks-populate_sysroot` task. You |
6757 | can use this variable to exclude certain subdirectories of | 6757 | can use this variable to exclude certain subdirectories of |
6758 | directories listed in ```SYSROOT_DIRS`` <#var-SYSROOT_DIRS>`__ from | 6758 | directories listed in :term:`SYSROOT_DIRS` from |
6759 | staging. By default, the following directories are not staged: | 6759 | staging. By default, the following directories are not staged: |
6760 | SYSROOT_DIRS_BLACKLIST = " \\ ${mandir} \\ ${docdir} \\ ${infodir} \\ | 6760 | SYSROOT_DIRS_BLACKLIST = " \\ ${mandir} \\ ${docdir} \\ ${infodir} \\ |
6761 | ${datadir}/locale \\ ${datadir}/applications \\ ${datadir}/fonts \\ | 6761 | ${datadir}/locale \\ ${datadir}/applications \\ ${datadir}/fonts \\ |
@@ -6763,9 +6763,9 @@ system and gives an overview of their function and contents. | |||
6763 | 6763 | ||
6764 | SYSROOT_DIRS_NATIVE | 6764 | SYSROOT_DIRS_NATIVE |
6765 | Extra directories staged into the sysroot by the | 6765 | Extra directories staged into the sysroot by the |
6766 | ```do_populate_sysroot`` <#ref-tasks-populate_sysroot>`__ task for | 6766 | :ref:`ref-tasks-populate_sysroot` task for |
6767 | ``-native`` recipes, in addition to those specified in | 6767 | ``-native`` recipes, in addition to those specified in |
6768 | ```SYSROOT_DIRS`` <#var-SYSROOT_DIRS>`__. By default, the following | 6768 | :term:`SYSROOT_DIRS`. By default, the following |
6769 | extra directories are staged: SYSROOT_DIRS_NATIVE = " \\ ${bindir} \\ | 6769 | extra directories are staged: SYSROOT_DIRS_NATIVE = " \\ ${bindir} \\ |
6770 | ${sbindir} \\ ${base_bindir} \\ ${base_sbindir} \\ ${libexecdir} \\ | 6770 | ${sbindir} \\ ${base_bindir} \\ ${base_sbindir} \\ ${libexecdir} \\ |
6771 | ${sysconfdir} \\ ${localstatedir} \\ " | 6771 | ${sysconfdir} \\ ${localstatedir} \\ " |
@@ -6785,50 +6785,50 @@ system and gives an overview of their function and contents. | |||
6785 | processing on the staged files, or to stage additional files. | 6785 | processing on the staged files, or to stage additional files. |
6786 | 6786 | ||
6787 | SYSTEMD_AUTO_ENABLE | 6787 | SYSTEMD_AUTO_ENABLE |
6788 | When inheriting the ```systemd`` <#ref-classes-systemd>`__ class, | 6788 | When inheriting the :ref:`systemd <ref-classes-systemd>` class, |
6789 | this variable specifies whether the specified service in | 6789 | this variable specifies whether the specified service in |
6790 | ```SYSTEMD_SERVICE`` <#var-SYSTEMD_SERVICE>`__ should start | 6790 | :term:`SYSTEMD_SERVICE` should start |
6791 | automatically or not. By default, the service is enabled to | 6791 | automatically or not. By default, the service is enabled to |
6792 | automatically start at boot time. The default setting is in the | 6792 | automatically start at boot time. The default setting is in the |
6793 | ```systemd`` <#ref-classes-systemd>`__ class as follows: | 6793 | :ref:`systemd <ref-classes-systemd>` class as follows: |
6794 | SYSTEMD_AUTO_ENABLE ??= "enable" | 6794 | SYSTEMD_AUTO_ENABLE ??= "enable" |
6795 | 6795 | ||
6796 | You can disable the service by setting the variable to "disable". | 6796 | You can disable the service by setting the variable to "disable". |
6797 | 6797 | ||
6798 | SYSTEMD_BOOT_CFG | 6798 | SYSTEMD_BOOT_CFG |
6799 | When ```EFI_PROVIDER`` <#var-EFI_PROVIDER>`__ is set to | 6799 | When :term:`EFI_PROVIDER` is set to |
6800 | "systemd-boot", the ``SYSTEMD_BOOT_CFG`` variable specifies the | 6800 | "systemd-boot", the ``SYSTEMD_BOOT_CFG`` variable specifies the |
6801 | configuration file that should be used. By default, the | 6801 | configuration file that should be used. By default, the |
6802 | ```systemd-boot`` <#ref-classes-systemd-boot>`__ class sets the | 6802 | :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the |
6803 | ``SYSTEMD_BOOT_CFG`` as follows: SYSTEMD_BOOT_CFG ?= | 6803 | ``SYSTEMD_BOOT_CFG`` as follows: SYSTEMD_BOOT_CFG ?= |
6804 | "${`S <#var-S>`__}/loader.conf" | 6804 | "${:term:`S`}/loader.conf" |
6805 | 6805 | ||
6806 | For information on Systemd-boot, see the `Systemd-boot | 6806 | For information on Systemd-boot, see the `Systemd-boot |
6807 | documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. | 6807 | documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. |
6808 | 6808 | ||
6809 | SYSTEMD_BOOT_ENTRIES | 6809 | SYSTEMD_BOOT_ENTRIES |
6810 | When ```EFI_PROVIDER`` <#var-EFI_PROVIDER>`__ is set to | 6810 | When :term:`EFI_PROVIDER` is set to |
6811 | "systemd-boot", the ``SYSTEMD_BOOT_ENTRIES`` variable specifies a | 6811 | "systemd-boot", the ``SYSTEMD_BOOT_ENTRIES`` variable specifies a |
6812 | list of entry files (``*.conf``) to install that contain one boot | 6812 | list of entry files (``*.conf``) to install that contain one boot |
6813 | entry per file. By default, the | 6813 | entry per file. By default, the |
6814 | ```systemd-boot`` <#ref-classes-systemd-boot>`__ class sets the | 6814 | :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the |
6815 | ``SYSTEMD_BOOT_ENTRIES`` as follows: SYSTEMD_BOOT_ENTRIES ?= "" | 6815 | ``SYSTEMD_BOOT_ENTRIES`` as follows: SYSTEMD_BOOT_ENTRIES ?= "" |
6816 | 6816 | ||
6817 | For information on Systemd-boot, see the `Systemd-boot | 6817 | For information on Systemd-boot, see the `Systemd-boot |
6818 | documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. | 6818 | documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. |
6819 | 6819 | ||
6820 | SYSTEMD_BOOT_TIMEOUT | 6820 | SYSTEMD_BOOT_TIMEOUT |
6821 | When ```EFI_PROVIDER`` <#var-EFI_PROVIDER>`__ is set to | 6821 | When :term:`EFI_PROVIDER` is set to |
6822 | "systemd-boot", the ``SYSTEMD_BOOT_TIMEOUT`` variable specifies the | 6822 | "systemd-boot", the ``SYSTEMD_BOOT_TIMEOUT`` variable specifies the |
6823 | boot menu timeout in seconds. By default, the | 6823 | boot menu timeout in seconds. By default, the |
6824 | ```systemd-boot`` <#ref-classes-systemd-boot>`__ class sets the | 6824 | :ref:`systemd-boot <ref-classes-systemd-boot>` class sets the |
6825 | ``SYSTEMD_BOOT_TIMEOUT`` as follows: SYSTEMD_BOOT_TIMEOUT ?= "10" | 6825 | ``SYSTEMD_BOOT_TIMEOUT`` as follows: SYSTEMD_BOOT_TIMEOUT ?= "10" |
6826 | 6826 | ||
6827 | For information on Systemd-boot, see the `Systemd-boot | 6827 | For information on Systemd-boot, see the `Systemd-boot |
6828 | documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. | 6828 | documentation <http://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__. |
6829 | 6829 | ||
6830 | SYSTEMD_PACKAGES | 6830 | SYSTEMD_PACKAGES |
6831 | When inheriting the ```systemd`` <#ref-classes-systemd>`__ class, | 6831 | When inheriting the :ref:`systemd <ref-classes-systemd>` class, |
6832 | this variable locates the systemd unit files when they are not found | 6832 | this variable locates the systemd unit files when they are not found |
6833 | in the main recipe's package. By default, the ``SYSTEMD_PACKAGES`` | 6833 | in the main recipe's package. By default, the ``SYSTEMD_PACKAGES`` |
6834 | variable is set such that the systemd unit files are assumed to | 6834 | variable is set such that the systemd unit files are assumed to |
@@ -6839,7 +6839,7 @@ system and gives an overview of their function and contents. | |||
6839 | the build system can find the systemd unit files. | 6839 | the build system can find the systemd unit files. |
6840 | 6840 | ||
6841 | SYSTEMD_SERVICE | 6841 | SYSTEMD_SERVICE |
6842 | When inheriting the ```systemd`` <#ref-classes-systemd>`__ class, | 6842 | When inheriting the :ref:`systemd <ref-classes-systemd>` class, |
6843 | this variable specifies the systemd service name for a package. | 6843 | this variable specifies the systemd service name for a package. |
6844 | 6844 | ||
6845 | When you specify this file in your recipe, use a package name | 6845 | When you specify this file in your recipe, use a package name |
@@ -6852,7 +6852,7 @@ system and gives an overview of their function and contents. | |||
6852 | `SysVinit <&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services>`__, | 6852 | `SysVinit <&YOCTO_DOCS_DEV_URL;#new-recipe-enabling-system-services>`__, |
6853 | specifies a space-separated list of the virtual terminals that should | 6853 | specifies a space-separated list of the virtual terminals that should |
6854 | run a `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ | 6854 | run a `getty <http://en.wikipedia.org/wiki/Getty_%28Unix%29>`__ |
6855 | (allowing login), assuming ```USE_VT`` <#var-USE_VT>`__ is not set to | 6855 | (allowing login), assuming :term:`USE_VT` is not set to |
6856 | "0". | 6856 | "0". |
6857 | 6857 | ||
6858 | The default value for ``SYSVINIT_ENABLED_GETTYS`` is "1" (i.e. only | 6858 | The default value for ``SYSVINIT_ENABLED_GETTYS`` is "1" (i.e. only |
@@ -6864,12 +6864,12 @@ system and gives an overview of their function and contents. | |||
6864 | particular recipe. The variable is typically set as follows: T = | 6864 | particular recipe. The variable is typically set as follows: T = |
6865 | "${WORKDIR}/temp" | 6865 | "${WORKDIR}/temp" |
6866 | 6866 | ||
6867 | The ```WORKDIR`` <#var-WORKDIR>`__ is the directory into which | 6867 | The :term:`WORKDIR` is the directory into which |
6868 | BitBake unpacks and builds the recipe. The default ``bitbake.conf`` | 6868 | BitBake unpacks and builds the recipe. The default ``bitbake.conf`` |
6869 | file sets this variable. | 6869 | file sets this variable. |
6870 | 6870 | ||
6871 | The ``T`` variable is not to be confused with the | 6871 | The ``T`` variable is not to be confused with the |
6872 | ```TMPDIR`` <#var-TMPDIR>`__ variable, which points to the root of | 6872 | :term:`TMPDIR` variable, which points to the root of |
6873 | the directory tree where BitBake places the output of an entire | 6873 | the directory tree where BitBake places the output of an entire |
6874 | build. | 6874 | build. |
6875 | 6875 | ||
@@ -6880,19 +6880,19 @@ system and gives an overview of their function and contents. | |||
6880 | configurable: arm i586 x86_64 powerpc powerpc64 mips mipsel | 6880 | configurable: arm i586 x86_64 powerpc powerpc64 mips mipsel |
6881 | 6881 | ||
6882 | For additional information on machine architectures, see the | 6882 | For additional information on machine architectures, see the |
6883 | ```TUNE_ARCH`` <#var-TUNE_ARCH>`__ variable. | 6883 | :term:`TUNE_ARCH` variable. |
6884 | 6884 | ||
6885 | TARGET_AS_ARCH | 6885 | TARGET_AS_ARCH |
6886 | Specifies architecture-specific assembler flags for the target | 6886 | Specifies architecture-specific assembler flags for the target |
6887 | system. ``TARGET_AS_ARCH`` is initialized from | 6887 | system. ``TARGET_AS_ARCH`` is initialized from |
6888 | ```TUNE_ASARGS`` <#var-TUNE_ASARGS>`__ by default in the BitBake | 6888 | :term:`TUNE_ASARGS` by default in the BitBake |
6889 | configuration file (``meta/conf/bitbake.conf``): TARGET_AS_ARCH = | 6889 | configuration file (``meta/conf/bitbake.conf``): TARGET_AS_ARCH = |
6890 | "${TUNE_ASARGS}" | 6890 | "${TUNE_ASARGS}" |
6891 | 6891 | ||
6892 | TARGET_CC_ARCH | 6892 | TARGET_CC_ARCH |
6893 | Specifies architecture-specific C compiler flags for the target | 6893 | Specifies architecture-specific C compiler flags for the target |
6894 | system. ``TARGET_CC_ARCH`` is initialized from | 6894 | system. ``TARGET_CC_ARCH`` is initialized from |
6895 | ```TUNE_CCARGS`` <#var-TUNE_CCARGS>`__ by default. | 6895 | :term:`TUNE_CCARGS` by default. |
6896 | 6896 | ||
6897 | .. note:: | 6897 | .. note:: |
6898 | 6898 | ||
@@ -6908,17 +6908,17 @@ system and gives an overview of their function and contents. | |||
6908 | TARGET_CC_KERNEL_ARCH | 6908 | TARGET_CC_KERNEL_ARCH |
6909 | This is a specific kernel compiler flag for a CPU or Application | 6909 | This is a specific kernel compiler flag for a CPU or Application |
6910 | Binary Interface (ABI) tune. The flag is used rarely and only for | 6910 | Binary Interface (ABI) tune. The flag is used rarely and only for |
6911 | cases where a userspace ```TUNE_CCARGS`` <#var-TUNE_CCARGS>`__ is not | 6911 | cases where a userspace :term:`TUNE_CCARGS` is not |
6912 | compatible with the kernel compilation. The ``TARGET_CC_KERNEL_ARCH`` | 6912 | compatible with the kernel compilation. The ``TARGET_CC_KERNEL_ARCH`` |
6913 | variable allows the kernel (and associated modules) to use a | 6913 | variable allows the kernel (and associated modules) to use a |
6914 | different configuration. See the | 6914 | different configuration. See the |
6915 | ``meta/conf/machine/include/arm/feature-arm-thumb.inc`` file in the | 6915 | ``meta/conf/machine/include/arm/feature-arm-thumb.inc`` file in the |
6916 | `Source Directory <#source-directory>`__ for an example. | 6916 | :term:`Source Directory` for an example. |
6917 | 6917 | ||
6918 | TARGET_CFLAGS | 6918 | TARGET_CFLAGS |
6919 | Specifies the flags to pass to the C compiler when building for the | 6919 | Specifies the flags to pass to the C compiler when building for the |
6920 | target. When building in the target context, | 6920 | target. When building in the target context, |
6921 | ```CFLAGS`` <#var-CFLAGS>`__ is set to the value of this variable by | 6921 | :term:`CFLAGS` is set to the value of this variable by |
6922 | default. | 6922 | default. |
6923 | 6923 | ||
6924 | Additionally, the SDK's environment setup script sets the ``CFLAGS`` | 6924 | Additionally, the SDK's environment setup script sets the ``CFLAGS`` |
@@ -6928,7 +6928,7 @@ system and gives an overview of their function and contents. | |||
6928 | TARGET_CPPFLAGS | 6928 | TARGET_CPPFLAGS |
6929 | Specifies the flags to pass to the C pre-processor (i.e. to both the | 6929 | Specifies the flags to pass to the C pre-processor (i.e. to both the |
6930 | C and the C++ compilers) when building for the target. When building | 6930 | C and the C++ compilers) when building for the target. When building |
6931 | in the target context, ```CPPFLAGS`` <#var-CPPFLAGS>`__ is set to the | 6931 | in the target context, :term:`CPPFLAGS` is set to the |
6932 | value of this variable by default. | 6932 | value of this variable by default. |
6933 | 6933 | ||
6934 | Additionally, the SDK's environment setup script sets the | 6934 | Additionally, the SDK's environment setup script sets the |
@@ -6939,7 +6939,7 @@ system and gives an overview of their function and contents. | |||
6939 | TARGET_CXXFLAGS | 6939 | TARGET_CXXFLAGS |
6940 | Specifies the flags to pass to the C++ compiler when building for the | 6940 | Specifies the flags to pass to the C++ compiler when building for the |
6941 | target. When building in the target context, | 6941 | target. When building in the target context, |
6942 | ```CXXFLAGS`` <#var-CXXFLAGS>`__ is set to the value of this variable | 6942 | :term:`CXXFLAGS` is set to the value of this variable |
6943 | by default. | 6943 | by default. |
6944 | 6944 | ||
6945 | Additionally, the SDK's environment setup script sets the | 6945 | Additionally, the SDK's environment setup script sets the |
@@ -6956,18 +6956,18 @@ system and gives an overview of their function and contents. | |||
6956 | TARGET_LD_ARCH | 6956 | TARGET_LD_ARCH |
6957 | Specifies architecture-specific linker flags for the target system. | 6957 | Specifies architecture-specific linker flags for the target system. |
6958 | ``TARGET_LD_ARCH`` is initialized from | 6958 | ``TARGET_LD_ARCH`` is initialized from |
6959 | ```TUNE_LDARGS`` <#var-TUNE_LDARGS>`__ by default in the BitBake | 6959 | :term:`TUNE_LDARGS` by default in the BitBake |
6960 | configuration file (``meta/conf/bitbake.conf``): TARGET_LD_ARCH = | 6960 | configuration file (``meta/conf/bitbake.conf``): TARGET_LD_ARCH = |
6961 | "${TUNE_LDARGS}" | 6961 | "${TUNE_LDARGS}" |
6962 | 6962 | ||
6963 | TARGET_LDFLAGS | 6963 | TARGET_LDFLAGS |
6964 | Specifies the flags to pass to the linker when building for the | 6964 | Specifies the flags to pass to the linker when building for the |
6965 | target. When building in the target context, | 6965 | target. When building in the target context, |
6966 | ```LDFLAGS`` <#var-LDFLAGS>`__ is set to the value of this variable | 6966 | :term:`LDFLAGS` is set to the value of this variable |
6967 | by default. | 6967 | by default. |
6968 | 6968 | ||
6969 | Additionally, the SDK's environment setup script sets the | 6969 | Additionally, the SDK's environment setup script sets the |
6970 | ```LDFLAGS`` <#var-LDFLAGS>`__ variable in the environment to the | 6970 | :term:`LDFLAGS` variable in the environment to the |
6971 | ``TARGET_LDFLAGS`` value so that executables built using the SDK also | 6971 | ``TARGET_LDFLAGS`` value so that executables built using the SDK also |
6972 | have the flags applied. | 6972 | have the flags applied. |
6973 | 6973 | ||
@@ -6984,7 +6984,7 @@ system and gives an overview of their function and contents. | |||
6984 | ``TARGET_PREFIX`` is set as follows: | 6984 | ``TARGET_PREFIX`` is set as follows: |
6985 | 6985 | ||
6986 | - For recipes building for the target machine, the value is | 6986 | - For recipes building for the target machine, the value is |
6987 | "${`TARGET_SYS <#var-TARGET_SYS>`__}-". | 6987 | "${:term:`TARGET_SYS`}-". |
6988 | 6988 | ||
6989 | - For native recipes, the build system sets the variable to the | 6989 | - For native recipes, the build system sets the variable to the |
6990 | value of ``BUILD_PREFIX``. | 6990 | value of ``BUILD_PREFIX``. |
@@ -6998,9 +6998,9 @@ system and gives an overview of their function and contents. | |||
6998 | current recipe. | 6998 | current recipe. |
6999 | 6999 | ||
7000 | The OpenEmbedded build system automatically sets this variable based | 7000 | The OpenEmbedded build system automatically sets this variable based |
7001 | on ```TARGET_ARCH`` <#var-TARGET_ARCH>`__, | 7001 | on :term:`TARGET_ARCH`, |
7002 | ```TARGET_VENDOR`` <#var-TARGET_VENDOR>`__, and | 7002 | :term:`TARGET_VENDOR`, and |
7003 | ```TARGET_OS`` <#var-TARGET_OS>`__ variables. | 7003 | :term:`TARGET_OS` variables. |
7004 | 7004 | ||
7005 | .. note:: | 7005 | .. note:: |
7006 | 7006 | ||
@@ -7028,9 +7028,9 @@ system and gives an overview of their function and contents. | |||
7028 | 7028 | ||
7029 | TCLIBCAPPEND | 7029 | TCLIBCAPPEND |
7030 | Specifies a suffix to be appended onto the | 7030 | Specifies a suffix to be appended onto the |
7031 | ```TMPDIR`` <#var-TMPDIR>`__ value. The suffix identifies the | 7031 | :term:`TMPDIR` value. The suffix identifies the |
7032 | ``libc`` variant for building. When you are building for multiple | 7032 | ``libc`` variant for building. When you are building for multiple |
7033 | variants with the same `Build Directory <#build-directory>`__, this | 7033 | variants with the same :term:`Build Directory`, this |
7034 | mechanism ensures that output for different ``libc`` variants is kept | 7034 | mechanism ensures that output for different ``libc`` variants is kept |
7035 | separate to avoid potential conflicts. | 7035 | separate to avoid potential conflicts. |
7036 | 7036 | ||
@@ -7063,7 +7063,7 @@ system and gives an overview of their function and contents. | |||
7063 | page on the Yocto Project website and click on the "RELEASE | 7063 | page on the Yocto Project website and click on the "RELEASE |
7064 | INFORMATION" link for the appropriate release. | 7064 | INFORMATION" link for the appropriate release. |
7065 | 7065 | ||
7066 | The ``TCMODE`` variable is similar to ```TCLIBC`` <#var-TCLIBC>`__, | 7066 | The ``TCMODE`` variable is similar to :term:`TCLIBC`, |
7067 | which controls the variant of the GNU standard C library (``libc``) | 7067 | which controls the variant of the GNU standard C library (``libc``) |
7068 | used during the build process: ``glibc`` or ``musl``. | 7068 | used during the build process: ``glibc`` or ``musl``. |
7069 | 7069 | ||
@@ -7086,7 +7086,7 @@ system and gives an overview of their function and contents. | |||
7086 | 7086 | ||
7087 | TEST_EXPORT_DIR | 7087 | TEST_EXPORT_DIR |
7088 | The location the OpenEmbedded build system uses to export tests when | 7088 | The location the OpenEmbedded build system uses to export tests when |
7089 | the ```TEST_EXPORT_ONLY`` <#var-TEST_EXPORT_ONLY>`__ variable is set | 7089 | the :term:`TEST_EXPORT_ONLY` variable is set |
7090 | to "1". | 7090 | to "1". |
7091 | 7091 | ||
7092 | The ``TEST_EXPORT_DIR`` variable defaults to | 7092 | The ``TEST_EXPORT_DIR`` variable defaults to |
@@ -7121,7 +7121,7 @@ system and gives an overview of their function and contents. | |||
7121 | TEST_POWERCONTROL_EXTRA_ARGS | 7121 | TEST_POWERCONTROL_EXTRA_ARGS |
7122 | For automated hardware testing, specifies additional arguments to | 7122 | For automated hardware testing, specifies additional arguments to |
7123 | pass through to the command specified in | 7123 | pass through to the command specified in |
7124 | ```TEST_POWERCONTROL_CMD`` <#var-TEST_POWERCONTROL_CMD>`__. Setting | 7124 | :term:`TEST_POWERCONTROL_CMD`. Setting |
7125 | ``TEST_POWERCONTROL_EXTRA_ARGS`` is optional. You can use it if you | 7125 | ``TEST_POWERCONTROL_EXTRA_ARGS`` is optional. You can use it if you |
7126 | wish, for example, to separate the machine-specific and | 7126 | wish, for example, to separate the machine-specific and |
7127 | non-machine-specific parts of the arguments. | 7127 | non-machine-specific parts of the arguments. |
@@ -7152,7 +7152,7 @@ system and gives an overview of their function and contents. | |||
7152 | TEST_SERIALCONTROL_EXTRA_ARGS | 7152 | TEST_SERIALCONTROL_EXTRA_ARGS |
7153 | For automated hardware testing, specifies additional arguments to | 7153 | For automated hardware testing, specifies additional arguments to |
7154 | pass through to the command specified in | 7154 | pass through to the command specified in |
7155 | ```TEST_SERIALCONTROL_CMD`` <#var-TEST_SERIALCONTROL_CMD>`__. Setting | 7155 | :term:`TEST_SERIALCONTROL_CMD`. Setting |
7156 | ``TEST_SERIALCONTROL_EXTRA_ARGS`` is optional. You can use it if you | 7156 | ``TEST_SERIALCONTROL_EXTRA_ARGS`` is optional. You can use it if you |
7157 | wish, for example, to separate the machine-specific and | 7157 | wish, for example, to separate the machine-specific and |
7158 | non-machine-specific parts of the command. | 7158 | non-machine-specific parts of the command. |
@@ -7195,7 +7195,7 @@ system and gives an overview of their function and contents. | |||
7195 | - *"simpleremote":* Runs the tests on target hardware that is | 7195 | - *"simpleremote":* Runs the tests on target hardware that is |
7196 | already up and running. The hardware can be on the network or it | 7196 | already up and running. The hardware can be on the network or it |
7197 | can be a device running an image on QEMU. You must also set | 7197 | can be a device running an image on QEMU. You must also set |
7198 | ```TEST_TARGET_IP`` <#var-TEST_TARGET_IP>`__ when you use | 7198 | :term:`TEST_TARGET_IP` when you use |
7199 | "simpleremote". | 7199 | "simpleremote". |
7200 | 7200 | ||
7201 | .. note:: | 7201 | .. note:: |
@@ -7211,7 +7211,7 @@ system and gives an overview of their function and contents. | |||
7211 | 7211 | ||
7212 | TEST_TARGET_IP | 7212 | TEST_TARGET_IP |
7213 | The IP address of your hardware under test. The ``TEST_TARGET_IP`` | 7213 | The IP address of your hardware under test. The ``TEST_TARGET_IP`` |
7214 | variable has no effect when ```TEST_TARGET`` <#var-TEST_TARGET>`__ is | 7214 | variable has no effect when :term:`TEST_TARGET` is |
7215 | set to "qemu". | 7215 | set to "qemu". |
7216 | 7216 | ||
7217 | When you specify the IP address, you can also include a port. Here is | 7217 | When you specify the IP address, you can also include a port. Here is |
@@ -7263,14 +7263,14 @@ system and gives an overview of their function and contents. | |||
7263 | These tests are written in Python making use of the ``unittest`` | 7263 | These tests are written in Python making use of the ``unittest`` |
7264 | module, and the majority of them run commands on the target system | 7264 | module, and the majority of them run commands on the target system |
7265 | over ``ssh``. You can set this variable to "1" in your ``local.conf`` | 7265 | over ``ssh``. You can set this variable to "1" in your ``local.conf`` |
7266 | file in the `Build Directory <#build-directory>`__ to have the | 7266 | file in the :term:`Build Directory` to have the |
7267 | OpenEmbedded build system automatically run these tests after an | 7267 | OpenEmbedded build system automatically run these tests after an |
7268 | image successfully builds: TESTIMAGE_AUTO = "1" For more information | 7268 | image successfully builds: TESTIMAGE_AUTO = "1" For more information |
7269 | on enabling, running, and writing these tests, see the "`Performing | 7269 | on enabling, running, and writing these tests, see the "`Performing |
7270 | Automated Runtime | 7270 | Automated Runtime |
7271 | Testing <&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing>`__" | 7271 | Testing <&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing>`__" |
7272 | section in the Yocto Project Development Tasks Manual and the | 7272 | section in the Yocto Project Development Tasks Manual and the |
7273 | "```testimage*.bbclass`` <#ref-classes-testimage*>`__" section. | 7273 | ":ref:`testimage*.bbclass <ref-classes-testimage*>`" section. |
7274 | 7274 | ||
7275 | THISDIR | 7275 | THISDIR |
7276 | The directory in which the file BitBake is currently parsing is | 7276 | The directory in which the file BitBake is currently parsing is |
@@ -7285,7 +7285,7 @@ system and gives an overview of their function and contents. | |||
7285 | This variable is the base directory the OpenEmbedded build system | 7285 | This variable is the base directory the OpenEmbedded build system |
7286 | uses for all build output and intermediate files (other than the | 7286 | uses for all build output and intermediate files (other than the |
7287 | shared state cache). By default, the ``TMPDIR`` variable points to | 7287 | shared state cache). By default, the ``TMPDIR`` variable points to |
7288 | ``tmp`` within the `Build Directory <#build-directory>`__. | 7288 | ``tmp`` within the :term:`Build Directory`. |
7289 | 7289 | ||
7290 | If you want to establish this directory in a location other than the | 7290 | If you want to establish this directory in a location other than the |
7291 | default, you can uncomment and edit the following statement in the | 7291 | default, you can uncomment and edit the following statement in the |
@@ -7304,7 +7304,7 @@ system and gives an overview of their function and contents. | |||
7304 | This variable lists packages the OpenEmbedded build system uses when | 7304 | This variable lists packages the OpenEmbedded build system uses when |
7305 | building an SDK, which contains a cross-development environment. The | 7305 | building an SDK, which contains a cross-development environment. The |
7306 | packages specified by this variable are part of the toolchain set | 7306 | packages specified by this variable are part of the toolchain set |
7307 | that runs on the ```SDKMACHINE`` <#var-SDKMACHINE>`__, and each | 7307 | that runs on the :term:`SDKMACHINE`, and each |
7308 | package should usually have the prefix ``nativesdk-``. For example, | 7308 | package should usually have the prefix ``nativesdk-``. For example, |
7309 | consider the following command when building an SDK: $ bitbake -c | 7309 | consider the following command when building an SDK: $ bitbake -c |
7310 | populate_sdk imagename In this case, a default list of packages is | 7310 | populate_sdk imagename In this case, a default list of packages is |
@@ -7328,8 +7328,8 @@ system and gives an overview of their function and contents. | |||
7328 | ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class sets | 7328 | ```populate_sdk_base`` <#ref-classes-populate-sdk-*>`__ class sets |
7329 | the ``TOOLCHAIN_OUTPUTNAME`` variable as follows: | 7329 | the ``TOOLCHAIN_OUTPUTNAME`` variable as follows: |
7330 | TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}" See | 7330 | TOOLCHAIN_OUTPUTNAME ?= "${SDK_NAME}-toolchain-${SDK_VERSION}" See |
7331 | the ```SDK_NAME`` <#var-SDK_NAME>`__ and | 7331 | the :term:`SDK_NAME` and |
7332 | ```SDK_VERSION`` <#var-SDK_VERSION>`__ variables for additional | 7332 | :term:`SDK_VERSION` variables for additional |
7333 | information. | 7333 | information. |
7334 | 7334 | ||
7335 | TOOLCHAIN_TARGET_TASK | 7335 | TOOLCHAIN_TARGET_TASK |
@@ -7352,12 +7352,12 @@ system and gives an overview of their function and contents. | |||
7352 | Development Kit (eSDK) <&YOCTO_DOCS_SDK_URL;>`__ manual. | 7352 | Development Kit (eSDK) <&YOCTO_DOCS_SDK_URL;>`__ manual. |
7353 | 7353 | ||
7354 | TOPDIR | 7354 | TOPDIR |
7355 | The top-level `Build Directory <#build-directory>`__. BitBake | 7355 | The top-level :term:`Build Directory`. BitBake |
7356 | automatically sets this variable when you initialize your build | 7356 | automatically sets this variable when you initialize your build |
7357 | environment using ````` <#structure-core-script>`__. | 7357 | environment using ````` <#structure-core-script>`__. |
7358 | 7358 | ||
7359 | TRANSLATED_TARGET_ARCH | 7359 | TRANSLATED_TARGET_ARCH |
7360 | A sanitized version of ```TARGET_ARCH`` <#var-TARGET_ARCH>`__. This | 7360 | A sanitized version of :term:`TARGET_ARCH`. This |
7361 | variable is used where the architecture is needed in a value where | 7361 | variable is used where the architecture is needed in a value where |
7362 | underscores are not allowed, for example within package filenames. In | 7362 | underscores are not allowed, for example within package filenames. In |
7363 | this case, dash characters replace any underscore characters used in | 7363 | this case, dash characters replace any underscore characters used in |
@@ -7379,7 +7379,7 @@ system and gives an overview of their function and contents. | |||
7379 | ``TUNE_ARCH`` specific to the ``mips`` architecture. | 7379 | ``TUNE_ARCH`` specific to the ``mips`` architecture. |
7380 | 7380 | ||
7381 | ``TUNE_ARCH`` is tied closely to | 7381 | ``TUNE_ARCH`` is tied closely to |
7382 | ```TARGET_ARCH`` <#var-TARGET_ARCH>`__, which defines the target | 7382 | :term:`TARGET_ARCH`, which defines the target |
7383 | machine's architecture. The BitBake configuration file | 7383 | machine's architecture. The BitBake configuration file |
7384 | (``meta/conf/bitbake.conf``) sets ``TARGET_ARCH`` as follows: | 7384 | (``meta/conf/bitbake.conf``) sets ``TARGET_ARCH`` as follows: |
7385 | TARGET_ARCH = "${TUNE_ARCH}" | 7385 | TARGET_ARCH = "${TUNE_ARCH}" |
@@ -7393,7 +7393,7 @@ system and gives an overview of their function and contents. | |||
7393 | system. The set of flags is based on the selected tune features. | 7393 | system. The set of flags is based on the selected tune features. |
7394 | ``TUNE_ASARGS`` is set using the tune include files, which are | 7394 | ``TUNE_ASARGS`` is set using the tune include files, which are |
7395 | typically under ``meta/conf/machine/include/`` and are influenced | 7395 | typically under ``meta/conf/machine/include/`` and are influenced |
7396 | through ```TUNE_FEATURES`` <#var-TUNE_FEATURES>`__. For example, the | 7396 | through :term:`TUNE_FEATURES`. For example, the |
7397 | ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags | 7397 | ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags |
7398 | for the x86 architecture as follows: TUNE_ASARGS += | 7398 | for the x86 architecture as follows: TUNE_ASARGS += |
7399 | "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-x32", "", d)}" | 7399 | "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-x32", "", d)}" |
@@ -7409,7 +7409,7 @@ system and gives an overview of their function and contents. | |||
7409 | system. The set of flags is based on the selected tune features. | 7409 | system. The set of flags is based on the selected tune features. |
7410 | ``TUNE_CCARGS`` is set using the tune include files, which are | 7410 | ``TUNE_CCARGS`` is set using the tune include files, which are |
7411 | typically under ``meta/conf/machine/include/`` and are influenced | 7411 | typically under ``meta/conf/machine/include/`` and are influenced |
7412 | through ```TUNE_FEATURES`` <#var-TUNE_FEATURES>`__. | 7412 | through :term:`TUNE_FEATURES`. |
7413 | 7413 | ||
7414 | .. note:: | 7414 | .. note:: |
7415 | 7415 | ||
@@ -7422,7 +7422,7 @@ system and gives an overview of their function and contents. | |||
7422 | The set of flags is based on the selected tune features. | 7422 | The set of flags is based on the selected tune features. |
7423 | ``TUNE_LDARGS`` is set using the tune include files, which are | 7423 | ``TUNE_LDARGS`` is set using the tune include files, which are |
7424 | typically under ``meta/conf/machine/include/`` and are influenced | 7424 | typically under ``meta/conf/machine/include/`` and are influenced |
7425 | through ```TUNE_FEATURES`` <#var-TUNE_FEATURES>`__. For example, the | 7425 | through :term:`TUNE_FEATURES`. For example, the |
7426 | ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags | 7426 | ``meta/conf/machine/include/x86/arch-x86.inc`` file defines the flags |
7427 | for the x86 architecture as follows: TUNE_LDARGS += | 7427 | for the x86 architecture as follows: TUNE_LDARGS += |
7428 | "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", | 7428 | "${@bb.utils.contains("TUNE_FEATURES", "mx32", "-m elf32_x86_64", "", |
@@ -7446,7 +7446,7 @@ system and gives an overview of their function and contents. | |||
7446 | The BitBake configuration file (``meta/conf/bitbake.conf``) defines | 7446 | The BitBake configuration file (``meta/conf/bitbake.conf``) defines |
7447 | ``TUNE_FEATURES`` as follows: TUNE_FEATURES ??= | 7447 | ``TUNE_FEATURES`` as follows: TUNE_FEATURES ??= |
7448 | "${TUNE_FEATURES_tune-${DEFAULTTUNE}}" See the | 7448 | "${TUNE_FEATURES_tune-${DEFAULTTUNE}}" See the |
7449 | ```DEFAULTTUNE`` <#var-DEFAULTTUNE>`__ variable for more information. | 7449 | :term:`DEFAULTTUNE` variable for more information. |
7450 | 7450 | ||
7451 | TUNE_PKGARCH | 7451 | TUNE_PKGARCH |
7452 | The package architecture understood by the packaging system to define | 7452 | The package architecture understood by the packaging system to define |
@@ -7463,34 +7463,34 @@ system and gives an overview of their function and contents. | |||
7463 | An underlying Application Binary Interface (ABI) used by a particular | 7463 | An underlying Application Binary Interface (ABI) used by a particular |
7464 | tuning in a given toolchain layer. Providers that use prebuilt | 7464 | tuning in a given toolchain layer. Providers that use prebuilt |
7465 | libraries can use the ``TUNEABI``, | 7465 | libraries can use the ``TUNEABI``, |
7466 | ```TUNEABI_OVERRIDE`` <#var-TUNEABI_OVERRIDE>`__, and | 7466 | :term:`TUNEABI_OVERRIDE`, and |
7467 | ```TUNEABI_WHITELIST`` <#var-TUNEABI_WHITELIST>`__ variables to check | 7467 | :term:`TUNEABI_WHITELIST` variables to check |
7468 | compatibility of tunings against their selection of libraries. | 7468 | compatibility of tunings against their selection of libraries. |
7469 | 7469 | ||
7470 | If ``TUNEABI`` is undefined, then every tuning is allowed. See the | 7470 | If ``TUNEABI`` is undefined, then every tuning is allowed. See the |
7471 | ```sanity`` <#ref-classes-sanity>`__ class to see how the variable is | 7471 | :ref:`sanity <ref-classes-sanity>` class to see how the variable is |
7472 | used. | 7472 | used. |
7473 | 7473 | ||
7474 | TUNEABI_OVERRIDE | 7474 | TUNEABI_OVERRIDE |
7475 | If set, the OpenEmbedded system ignores the | 7475 | If set, the OpenEmbedded system ignores the |
7476 | ```TUNEABI_WHITELIST`` <#var-TUNEABI_WHITELIST>`__ variable. | 7476 | :term:`TUNEABI_WHITELIST` variable. |
7477 | Providers that use prebuilt libraries can use the | 7477 | Providers that use prebuilt libraries can use the |
7478 | ``TUNEABI_OVERRIDE``, ``TUNEABI_WHITELIST``, and | 7478 | ``TUNEABI_OVERRIDE``, ``TUNEABI_WHITELIST``, and |
7479 | ```TUNEABI`` <#var-TUNEABI>`__ variables to check compatibility of a | 7479 | :term:`TUNEABI` variables to check compatibility of a |
7480 | tuning against their selection of libraries. | 7480 | tuning against their selection of libraries. |
7481 | 7481 | ||
7482 | See the ```sanity`` <#ref-classes-sanity>`__ class to see how the | 7482 | See the :ref:`sanity <ref-classes-sanity>` class to see how the |
7483 | variable is used. | 7483 | variable is used. |
7484 | 7484 | ||
7485 | TUNEABI_WHITELIST | 7485 | TUNEABI_WHITELIST |
7486 | A whitelist of permissible ```TUNEABI`` <#var-TUNEABI>`__ values. If | 7486 | A whitelist of permissible :term:`TUNEABI` values. If |
7487 | ``TUNEABI_WHITELIST`` is not set, all tunes are allowed. Providers | 7487 | ``TUNEABI_WHITELIST`` is not set, all tunes are allowed. Providers |
7488 | that use prebuilt libraries can use the ``TUNEABI_WHITELIST``, | 7488 | that use prebuilt libraries can use the ``TUNEABI_WHITELIST``, |
7489 | ```TUNEABI_OVERRIDE`` <#var-TUNEABI_OVERRIDE>`__, and ``TUNEABI`` | 7489 | :term:`TUNEABI_OVERRIDE`, and ``TUNEABI`` |
7490 | variables to check compatibility of a tuning against their selection | 7490 | variables to check compatibility of a tuning against their selection |
7491 | of libraries. | 7491 | of libraries. |
7492 | 7492 | ||
7493 | See the ```sanity`` <#ref-classes-sanity>`__ class to see how the | 7493 | See the :ref:`sanity <ref-classes-sanity>` class to see how the |
7494 | variable is used. | 7494 | variable is used. |
7495 | 7495 | ||
7496 | TUNECONFLICTS[feature] | 7496 | TUNECONFLICTS[feature] |
@@ -7498,7 +7498,7 @@ system and gives an overview of their function and contents. | |||
7498 | that conflict with feature. | 7498 | that conflict with feature. |
7499 | 7499 | ||
7500 | Known tuning conflicts are specified in the machine include files in | 7500 | Known tuning conflicts are specified in the machine include files in |
7501 | the `Source Directory <#source-directory>`__. Here is an example from | 7501 | the :term:`Source Directory`. Here is an example from |
7502 | the ``meta/conf/machine/include/mips/arch-mips.inc`` include file | 7502 | the ``meta/conf/machine/include/mips/arch-mips.inc`` include file |
7503 | that lists the "o32" and "n64" features as conflicting with the "n32" | 7503 | that lists the "o32" and "n64" features as conflicting with the "n32" |
7504 | feature: TUNECONFLICTS[n32] = "o32 n64" | 7504 | feature: TUNECONFLICTS[n32] = "o32 n64" |
@@ -7514,8 +7514,8 @@ system and gives an overview of their function and contents. | |||
7514 | Directory <#source-directory>`__ for these features. | 7514 | Directory <#source-directory>`__ for these features. |
7515 | 7515 | ||
7516 | UBOOT_CONFIG | 7516 | UBOOT_CONFIG |
7517 | Configures the ```UBOOT_MACHINE`` <#var-UBOOT_MACHINE>`__ and can | 7517 | Configures the :term:`UBOOT_MACHINE` and can |
7518 | also define ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ for individual | 7518 | also define :term:`IMAGE_FSTYPES` for individual |
7519 | cases. | 7519 | cases. |
7520 | 7520 | ||
7521 | Following is an example from the ``meta-fsl-arm`` layer. UBOOT_CONFIG | 7521 | Following is an example from the ``meta-fsl-arm`` layer. UBOOT_CONFIG |
@@ -7611,10 +7611,10 @@ system and gives an overview of their function and contents. | |||
7611 | UNKNOWN_CONFIGURE_WHITELIST | 7611 | UNKNOWN_CONFIGURE_WHITELIST |
7612 | Specifies a list of options that, if reported by the configure script | 7612 | Specifies a list of options that, if reported by the configure script |
7613 | as being invalid, should not generate a warning during the | 7613 | as being invalid, should not generate a warning during the |
7614 | ```do_configure`` <#ref-tasks-configure>`__ task. Normally, invalid | 7614 | :ref:`ref-tasks-configure` task. Normally, invalid |
7615 | configure options are simply not passed to the configure script (e.g. | 7615 | configure options are simply not passed to the configure script (e.g. |
7616 | should be removed from ```EXTRA_OECONF`` <#var-EXTRA_OECONF>`__ or | 7616 | should be removed from :term:`EXTRA_OECONF` or |
7617 | ```PACKAGECONFIG_CONFARGS`` <#var-PACKAGECONFIG_CONFARGS>`__). | 7617 | :term:`PACKAGECONFIG_CONFARGS`). |
7618 | However, common options, for example, exist that are passed to all | 7618 | However, common options, for example, exist that are passed to all |
7619 | configure scripts at a class level that might not be valid for some | 7619 | configure scripts at a class level that might not be valid for some |
7620 | configure scripts. It follows that no benefit exists in seeing a | 7620 | configure scripts. It follows that no benefit exists in seeing a |
@@ -7623,12 +7623,12 @@ system and gives an overview of their function and contents. | |||
7623 | 7623 | ||
7624 | The configure arguments check that uses | 7624 | The configure arguments check that uses |
7625 | ``UNKNOWN_CONFIGURE_WHITELIST`` is part of the | 7625 | ``UNKNOWN_CONFIGURE_WHITELIST`` is part of the |
7626 | ```insane`` <#ref-classes-insane>`__ class and is only enabled if the | 7626 | :ref:`insane <ref-classes-insane>` class and is only enabled if the |
7627 | recipe inherits the ```autotools`` <#ref-classes-autotools>`__ class. | 7627 | recipe inherits the :ref:`autotools <ref-classes-autotools>` class. |
7628 | 7628 | ||
7629 | UPDATERCPN | 7629 | UPDATERCPN |
7630 | For recipes inheriting the | 7630 | For recipes inheriting the |
7631 | ```update-rc.d`` <#ref-classes-update-rc.d>`__ class, ``UPDATERCPN`` | 7631 | :ref:`update-rc.d <ref-classes-update-rc.d>` class, ``UPDATERCPN`` |
7632 | specifies the package that contains the initscript that is enabled. | 7632 | specifies the package that contains the initscript that is enabled. |
7633 | 7633 | ||
7634 | The default value is "${PN}". Given that almost all recipes that | 7634 | The default value is "${PN}". Given that almost all recipes that |
@@ -7651,7 +7651,7 @@ system and gives an overview of their function and contents. | |||
7651 | Use the ``UPSTREAM_CHECK_REGEX`` variable to specify a different | 7651 | Use the ``UPSTREAM_CHECK_REGEX`` variable to specify a different |
7652 | regular expression instead of the default one when the package | 7652 | regular expression instead of the default one when the package |
7653 | checking system is parsing the page found using | 7653 | checking system is parsing the page found using |
7654 | ```UPSTREAM_CHECK_URI`` <#var-UPSTREAM_CHECK_URI>`__. | 7654 | :term:`UPSTREAM_CHECK_URI`. |
7655 | UPSTREAM_CHECK_REGEX = "package_regex" | 7655 | UPSTREAM_CHECK_REGEX = "package_regex" |
7656 | 7656 | ||
7657 | UPSTREAM_CHECK_URI | 7657 | UPSTREAM_CHECK_URI |
@@ -7703,8 +7703,8 @@ system and gives an overview of their function and contents. | |||
7703 | If set to ``error``, forces the OpenEmbedded build system to produce | 7703 | If set to ``error``, forces the OpenEmbedded build system to produce |
7704 | an error if the user identification (``uid``) and group | 7704 | an error if the user identification (``uid``) and group |
7705 | identification (``gid``) values are not defined in any of the files | 7705 | identification (``gid``) values are not defined in any of the files |
7706 | listed in ```USERADD_UID_TABLES`` <#var-USERADD_UID_TABLES>`__ and | 7706 | listed in :term:`USERADD_UID_TABLES` and |
7707 | ```USERADD_GID_TABLES`` <#var-USERADD_GID_TABLES>`__. If set to | 7707 | :term:`USERADD_GID_TABLES`. If set to |
7708 | ``warn``, a warning will be issued instead. | 7708 | ``warn``, a warning will be issued instead. |
7709 | 7709 | ||
7710 | The default behavior for the build system is to dynamically apply | 7710 | The default behavior for the build system is to dynamically apply |
@@ -7715,9 +7715,9 @@ system and gives an overview of their function and contents. | |||
7715 | file as follows: USERADD_ERROR_DYNAMIC = "error" Overriding the | 7715 | file as follows: USERADD_ERROR_DYNAMIC = "error" Overriding the |
7716 | default behavior implies you are going to also take steps to set | 7716 | default behavior implies you are going to also take steps to set |
7717 | static ``uid`` and ``gid`` values through use of the | 7717 | static ``uid`` and ``gid`` values through use of the |
7718 | ```USERADDEXTENSION`` <#var-USERADDEXTENSION>`__, | 7718 | :term:`USERADDEXTENSION`, |
7719 | ```USERADD_UID_TABLES`` <#var-USERADD_UID_TABLES>`__, and | 7719 | :term:`USERADD_UID_TABLES`, and |
7720 | ```USERADD_GID_TABLES`` <#var-USERADD_GID_TABLES>`__ variables. | 7720 | :term:`USERADD_GID_TABLES` variables. |
7721 | 7721 | ||
7722 | .. note:: | 7722 | .. note:: |
7723 | 7723 | ||
@@ -7745,7 +7745,7 @@ system and gives an overview of their function and contents. | |||
7745 | adds a group to the system during package installation. | 7745 | adds a group to the system during package installation. |
7746 | 7746 | ||
7747 | When applying static group identification (``gid``) values, the | 7747 | When applying static group identification (``gid``) values, the |
7748 | OpenEmbedded build system looks in ```BBPATH`` <#var-BBPATH>`__ for a | 7748 | OpenEmbedded build system looks in :term:`BBPATH` for a |
7749 | ``files/group`` file and then applies those ``uid`` values. Set the | 7749 | ``files/group`` file and then applies those ``uid`` values. Set the |
7750 | variable as follows in your ``local.conf`` file: USERADD_GID_TABLES = | 7750 | variable as follows in your ``local.conf`` file: USERADD_GID_TABLES = |
7751 | "files/group" | 7751 | "files/group" |
@@ -7760,7 +7760,7 @@ system and gives an overview of their function and contents. | |||
7760 | values. | 7760 | values. |
7761 | 7761 | ||
7762 | USERADD_PACKAGES | 7762 | USERADD_PACKAGES |
7763 | When inheriting the ```useradd`` <#ref-classes-useradd>`__ class, | 7763 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, |
7764 | this variable specifies the individual packages within the recipe | 7764 | this variable specifies the individual packages within the recipe |
7765 | that require users and/or groups to be added. | 7765 | that require users and/or groups to be added. |
7766 | 7766 | ||
@@ -7781,7 +7781,7 @@ system and gives an overview of their function and contents. | |||
7781 | variables. | 7781 | variables. |
7782 | 7782 | ||
7783 | USERADD_PARAM | 7783 | USERADD_PARAM |
7784 | When inheriting the ```useradd`` <#ref-classes-useradd>`__ class, | 7784 | When inheriting the :ref:`useradd <ref-classes-useradd>` class, |
7785 | this variable specifies for a package what parameters should pass to | 7785 | this variable specifies for a package what parameters should pass to |
7786 | the ``useradd`` command if you add a user to the system when the | 7786 | the ``useradd`` command if you add a user to the system when the |
7787 | package is installed. | 7787 | package is installed. |
@@ -7798,7 +7798,7 @@ system and gives an overview of their function and contents. | |||
7798 | adds a user to the system during package installation. | 7798 | adds a user to the system during package installation. |
7799 | 7799 | ||
7800 | When applying static user identification (``uid``) values, the | 7800 | When applying static user identification (``uid``) values, the |
7801 | OpenEmbedded build system looks in ```BBPATH`` <#var-BBPATH>`__ for a | 7801 | OpenEmbedded build system looks in :term:`BBPATH` for a |
7802 | ``files/passwd`` file and then applies those ``uid`` values. Set the | 7802 | ``files/passwd`` file and then applies those ``uid`` values. Set the |
7803 | variable as follows in your ``local.conf`` file: USERADD_UID_TABLES = | 7803 | variable as follows in your ``local.conf`` file: USERADD_UID_TABLES = |
7804 | "files/passwd" | 7804 | "files/passwd" |
@@ -7815,7 +7815,7 @@ system and gives an overview of their function and contents. | |||
7815 | USERADDEXTENSION | 7815 | USERADDEXTENSION |
7816 | When set to "useradd-staticids", causes the OpenEmbedded build system | 7816 | When set to "useradd-staticids", causes the OpenEmbedded build system |
7817 | to base all user and group additions on a static ``passwd`` and | 7817 | to base all user and group additions on a static ``passwd`` and |
7818 | ``group`` files found in ```BBPATH`` <#var-BBPATH>`__. | 7818 | ``group`` files found in :term:`BBPATH`. |
7819 | 7819 | ||
7820 | To use static user identification (``uid``) and group identification | 7820 | To use static user identification (``uid``) and group identification |
7821 | (``gid``) values, set the variable as follows in your ``local.conf`` | 7821 | (``gid``) values, set the variable as follows in your ``local.conf`` |
@@ -7833,10 +7833,10 @@ system and gives an overview of their function and contents. | |||
7833 | 7833 | ||
7834 | If you use static ``uid`` and ``gid`` information, you must also | 7834 | If you use static ``uid`` and ``gid`` information, you must also |
7835 | specify the ``files/passwd`` and ``files/group`` files by setting the | 7835 | specify the ``files/passwd`` and ``files/group`` files by setting the |
7836 | ```USERADD_UID_TABLES`` <#var-USERADD_UID_TABLES>`__ and | 7836 | :term:`USERADD_UID_TABLES` and |
7837 | ```USERADD_GID_TABLES`` <#var-USERADD_GID_TABLES>`__ variables. | 7837 | :term:`USERADD_GID_TABLES` variables. |
7838 | Additionally, you should also set the | 7838 | Additionally, you should also set the |
7839 | ```USERADD_ERROR_DYNAMIC`` <#var-USERADD_ERROR_DYNAMIC>`__ variable. | 7839 | :term:`USERADD_ERROR_DYNAMIC` variable. |
7840 | 7840 | ||
7841 | VOLATILE_LOG_DIR | 7841 | VOLATILE_LOG_DIR |
7842 | Specifies the persistence of the target's ``/var/log`` directory, | 7842 | Specifies the persistence of the target's ``/var/log`` directory, |
@@ -7851,18 +7851,18 @@ system and gives an overview of their function and contents. | |||
7851 | warnings by the OpenEmbedded build system. You set this variable in | 7851 | warnings by the OpenEmbedded build system. You set this variable in |
7852 | your distribution configuration file. For a list of the checks you | 7852 | your distribution configuration file. For a list of the checks you |
7853 | can control with this variable, see the | 7853 | can control with this variable, see the |
7854 | "```insane.bbclass`` <#ref-classes-insane>`__" section. | 7854 | ":ref:`insane.bbclass <ref-classes-insane>`" section. |
7855 | 7855 | ||
7856 | WKS_FILE_DEPENDS | 7856 | WKS_FILE_DEPENDS |
7857 | When placed in the recipe that builds your image, this variable lists | 7857 | When placed in the recipe that builds your image, this variable lists |
7858 | build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only | 7858 | build-time dependencies. The ``WKS_FILE_DEPENDS`` variable is only |
7859 | applicable when Wic images are active (i.e. when | 7859 | applicable when Wic images are active (i.e. when |
7860 | ```IMAGE_FSTYPES`` <#var-IMAGE_FSTYPES>`__ contains entries related | 7860 | :term:`IMAGE_FSTYPES` contains entries related |
7861 | to Wic). If your recipe does not create Wic images, the variable has | 7861 | to Wic). If your recipe does not create Wic images, the variable has |
7862 | no effect. | 7862 | no effect. |
7863 | 7863 | ||
7864 | The ``WKS_FILE_DEPENDS`` variable is similar to the | 7864 | The ``WKS_FILE_DEPENDS`` variable is similar to the |
7865 | ```DEPENDS`` <#var-DEPENDS>`__ variable. When you use the variable in | 7865 | :term:`DEPENDS` variable. When you use the variable in |
7866 | your recipe that builds the Wic image, dependencies you list in the | 7866 | your recipe that builds the Wic image, dependencies you list in the |
7867 | ``WIC_FILE_DEPENDS`` variable are added to the ``DEPENDS`` variable. | 7867 | ``WIC_FILE_DEPENDS`` variable are added to the ``DEPENDS`` variable. |
7868 | 7868 | ||
@@ -7886,7 +7886,7 @@ system and gives an overview of their function and contents. | |||
7886 | WORKDIR | 7886 | WORKDIR |
7887 | The pathname of the work directory in which the OpenEmbedded build | 7887 | The pathname of the work directory in which the OpenEmbedded build |
7888 | system builds a recipe. This directory is located within the | 7888 | system builds a recipe. This directory is located within the |
7889 | ```TMPDIR`` <#var-TMPDIR>`__ directory structure and is specific to | 7889 | :term:`TMPDIR` directory structure and is specific to |
7890 | the recipe being built and the system for which it is being built. | 7890 | the recipe being built and the system for which it is being built. |
7891 | 7891 | ||
7892 | The ``WORKDIR`` directory is defined as follows: | 7892 | The ``WORKDIR`` directory is defined as follows: |
@@ -7922,7 +7922,7 @@ system and gives an overview of their function and contents. | |||
7922 | server and drivers for the current machine, assuming your image | 7922 | server and drivers for the current machine, assuming your image |
7923 | directly includes ``packagegroup-core-x11-xserver`` or, perhaps | 7923 | directly includes ``packagegroup-core-x11-xserver`` or, perhaps |
7924 | indirectly, includes "x11-base" in | 7924 | indirectly, includes "x11-base" in |
7925 | ```IMAGE_FEATURES`` <#var-IMAGE_FEATURES>`__. | 7925 | :term:`IMAGE_FEATURES`. |
7926 | 7926 | ||
7927 | The default value of ``XSERVER``, if not specified in the machine | 7927 | The default value of ``XSERVER``, if not specified in the machine |
7928 | configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev". | 7928 | configuration, is "xserver-xorg xf86-video-fbdev xf86-input-evdev". |