summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-10-05 13:46:59 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-10-06 13:52:25 +0100
commitb2c2b87953d200c637d9f218d8bc616e8fef662c (patch)
tree785a6a47de2a66a4f4941e7d127b7529a0c30b42 /bitbake/doc/bitbake-user-manual
parent520e95902f12feac2850e0c24167002eb2cc7c42 (diff)
downloadpoky-b2c2b87953d200c637d9f218d8bc616e8fef662c.tar.gz
bitbake: docs: ref-variables: add links to terms in glossary
This is similar to this change in yocto-docs: 9e468274eaad (docs: ref-manual: ref-variables: add links to terms in glossary) (Bitbake rev: ebdeef2c185465ac9f7d7f01ae9e8531355b9e70) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc/bitbake-user-manual')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst244
1 files changed, 122 insertions, 122 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index fb1b353c82..3de2a9ffd9 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
@@ -29,7 +29,7 @@ overview of their function and contents.
29 29
30.. glossary:: 30.. glossary::
31 31
32 ASSUME_PROVIDED 32 :term:`ASSUME_PROVIDED`
33 Lists recipe names (:term:`PN` values) BitBake does not 33 Lists recipe names (:term:`PN` values) BitBake does not
34 attempt to build. Instead, BitBake assumes these recipes have already 34 attempt to build. Instead, BitBake assumes these recipes have already
35 been built. 35 been built.
@@ -39,11 +39,11 @@ overview of their function and contents.
39 when specified allows for the Git binary from the host to be used 39 when specified allows for the Git binary from the host to be used
40 rather than building ``git-native``. 40 rather than building ``git-native``.
41 41
42 B 42 :term:`B`
43 The directory in which BitBake executes functions during a recipe's 43 The directory in which BitBake executes functions during a recipe's
44 build process. 44 build process.
45 45
46 BB_ALLOWED_NETWORKS 46 :term:`BB_ALLOWED_NETWORKS`
47 Specifies a space-delimited list of hosts that the fetcher is allowed 47 Specifies a space-delimited list of hosts that the fetcher is allowed
48 to use to obtain the required source code. Following are 48 to use to obtain the required source code. Following are
49 considerations surrounding this variable: 49 considerations surrounding this variable:
@@ -83,15 +83,15 @@ overview of their function and contents.
83 fetcher does not attempt to use the host listed in ``SRC_URI`` after 83 fetcher does not attempt to use the host listed in ``SRC_URI`` after
84 a successful fetch from the ``PREMIRRORS`` occurs. 84 a successful fetch from the ``PREMIRRORS`` occurs.
85 85
86 BB_CONSOLELOG 86 :term:`BB_CONSOLELOG`
87 Specifies the path to a log file into which BitBake's user interface 87 Specifies the path to a log file into which BitBake's user interface
88 writes output during the build. 88 writes output during the build.
89 89
90 BB_CURRENTTASK 90 :term:`BB_CURRENTTASK`
91 Contains the name of the currently running task. The name does not 91 Contains the name of the currently running task. The name does not
92 include the ``do_`` prefix. 92 include the ``do_`` prefix.
93 93
94 BB_DANGLINGAPPENDS_WARNONLY 94 :term:`BB_DANGLINGAPPENDS_WARNONLY`
95 Defines how BitBake handles situations where an append file 95 Defines how BitBake handles situations where an append file
96 (``.bbappend``) has no corresponding recipe file (``.bb``). This 96 (``.bbappend``) has no corresponding recipe file (``.bb``). This
97 condition often occurs when layers get out of sync (e.g. ``oe-core`` 97 condition often occurs when layers get out of sync (e.g. ``oe-core``
@@ -103,12 +103,12 @@ overview of their function and contents.
103 given something is out of sync. It is important to realize when your 103 given something is out of sync. It is important to realize when your
104 changes are no longer being applied. 104 changes are no longer being applied.
105 105
106 BB_DEFAULT_TASK 106 :term:`BB_DEFAULT_TASK`
107 The default task to use when none is specified (e.g. with the ``-c`` 107 The default task to use when none is specified (e.g. with the ``-c``
108 command line option). The task name specified should not include the 108 command line option). The task name specified should not include the
109 ``do_`` prefix. 109 ``do_`` prefix.
110 110
111 BB_DISKMON_DIRS 111 :term:`BB_DISKMON_DIRS`
112 Monitors disk space and available inodes during the build and allows 112 Monitors disk space and available inodes during the build and allows
113 you to control the build based on these parameters. 113 you to control the build based on these parameters.
114 114
@@ -175,7 +175,7 @@ overview of their function and contents.
175 free inodes in the ``${TMPDIR}`` directory drops below 100 Kbytes. No 175 free inodes in the ``${TMPDIR}`` directory drops below 100 Kbytes. No
176 disk space monitoring for the directory itself occurs in this case. 176 disk space monitoring for the directory itself occurs in this case.
177 177
178 BB_DISKMON_WARNINTERVAL 178 :term:`BB_DISKMON_WARNINTERVAL`
179 Defines the disk space and free inode warning intervals. 179 Defines the disk space and free inode warning intervals.
180 180
181 If you are going to use the ``BB_DISKMON_WARNINTERVAL`` variable, you 181 If you are going to use the ``BB_DISKMON_WARNINTERVAL`` variable, you
@@ -218,7 +218,7 @@ overview of their function and contents.
218 based on the interval occur each time a respective interval is 218 based on the interval occur each time a respective interval is
219 reached beyond the initial warning (i.e. 1 Gbytes and 100 Kbytes). 219 reached beyond the initial warning (i.e. 1 Gbytes and 100 Kbytes).
220 220
221 BB_ENV_WHITELIST 221 :term:`BB_ENV_WHITELIST`
222 Specifies the internal whitelist of variables to allow through from 222 Specifies the internal whitelist of variables to allow through from
223 the external environment into BitBake's datastore. If the value of 223 the external environment into BitBake's datastore. If the value of
224 this variable is not specified (which is the default), the following 224 this variable is not specified (which is the default), the following
@@ -230,7 +230,7 @@ overview of their function and contents.
230 You must set this variable in the external environment in order 230 You must set this variable in the external environment in order
231 for it to work. 231 for it to work.
232 232
233 BB_ENV_EXTRAWHITE 233 :term:`BB_ENV_EXTRAWHITE`
234 Specifies an additional set of variables to allow through (whitelist) 234 Specifies an additional set of variables to allow through (whitelist)
235 from the external environment into BitBake's datastore. This list of 235 from the external environment into BitBake's datastore. This list of
236 variables are on top of the internal list set in 236 variables are on top of the internal list set in
@@ -241,19 +241,19 @@ overview of their function and contents.
241 You must set this variable in the external environment in order 241 You must set this variable in the external environment in order
242 for it to work. 242 for it to work.
243 243
244 BB_FETCH_PREMIRRORONLY 244 :term:`BB_FETCH_PREMIRRORONLY`
245 When set to "1", causes BitBake's fetcher module to only search 245 When set to "1", causes BitBake's fetcher module to only search
246 :term:`PREMIRRORS` for files. BitBake will not 246 :term:`PREMIRRORS` for files. BitBake will not
247 search the main :term:`SRC_URI` or 247 search the main :term:`SRC_URI` or
248 :term:`MIRRORS`. 248 :term:`MIRRORS`.
249 249
250 BB_FILENAME 250 :term:`BB_FILENAME`
251 Contains the filename of the recipe that owns the currently running 251 Contains the filename of the recipe that owns the currently running
252 task. For example, if the ``do_fetch`` task that resides in the 252 task. For example, if the ``do_fetch`` task that resides in the
253 ``my-recipe.bb`` is executing, the ``BB_FILENAME`` variable contains 253 ``my-recipe.bb`` is executing, the ``BB_FILENAME`` variable contains
254 "/foo/path/my-recipe.bb". 254 "/foo/path/my-recipe.bb".
255 255
256 BBFILES_DYNAMIC 256 :term:`BBFILES_DYNAMIC`
257 Activates content depending on presence of identified layers. You 257 Activates content depending on presence of identified layers. You
258 identify the layers by the collections that the layers define. 258 identify the layers by the collections that the layers define.
259 259
@@ -292,7 +292,7 @@ overview of their function and contents.
292 /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend 292 /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend
293 /work/my-layer/bbappends/openembedded-core/meta/*/*/*.bbappend 293 /work/my-layer/bbappends/openembedded-core/meta/*/*/*.bbappend
294 294
295 BB_GENERATE_MIRROR_TARBALLS 295 :term:`BB_GENERATE_MIRROR_TARBALLS`
296 Causes tarballs of the Git repositories, including the Git metadata, 296 Causes tarballs of the Git repositories, including the Git metadata,
297 to be placed in the :term:`DL_DIR` directory. Anyone 297 to be placed in the :term:`DL_DIR` directory. Anyone
298 wishing to create a source mirror would want to enable this variable. 298 wishing to create a source mirror would want to enable this variable.
@@ -302,7 +302,7 @@ overview of their function and contents.
302 302
303 BB_GENERATE_MIRROR_TARBALLS = "1" 303 BB_GENERATE_MIRROR_TARBALLS = "1"
304 304
305 BB_HASHCONFIG_WHITELIST 305 :term:`BB_HASHCONFIG_WHITELIST`
306 Lists variables that are excluded from base configuration checksum, 306 Lists variables that are excluded from base configuration checksum,
307 which is used to determine if the cache can be reused. 307 which is used to determine if the cache can be reused.
308 308
@@ -314,14 +314,14 @@ overview of their function and contents.
314 and ``DATE`` because these variables are always changing. If you did 314 and ``DATE`` because these variables are always changing. If you did
315 not exclude them, BitBake would never reuse the cache. 315 not exclude them, BitBake would never reuse the cache.
316 316
317 BB_HASHBASE_WHITELIST 317 :term:`BB_HASHBASE_WHITELIST`
318 Lists variables that are excluded from checksum and dependency data. 318 Lists variables that are excluded from checksum and dependency data.
319 Variables that are excluded can therefore change without affecting 319 Variables that are excluded can therefore change without affecting
320 the checksum mechanism. A common example would be the variable for 320 the checksum mechanism. A common example would be the variable for
321 the path of the build. BitBake's output should not (and usually does 321 the path of the build. BitBake's output should not (and usually does
322 not) depend on the directory in which it was built. 322 not) depend on the directory in which it was built.
323 323
324 BB_HASHCHECK_FUNCTION 324 :term:`BB_HASHCHECK_FUNCTION`
325 Specifies the name of the function to call during the "setscene" part 325 Specifies the name of the function to call during the "setscene" part
326 of the task's execution in order to validate the list of task hashes. 326 of the task's execution in order to validate the list of task hashes.
327 The function returns the list of setscene tasks that should be 327 The function returns the list of setscene tasks that should be
@@ -335,19 +335,19 @@ overview of their function and contents.
335 However, the more accurate the data returned, the more efficient the 335 However, the more accurate the data returned, the more efficient the
336 build will be. 336 build will be.
337 337
338 BB_INVALIDCONF 338 :term:`BB_INVALIDCONF`
339 Used in combination with the ``ConfigParsed`` event to trigger 339 Used in combination with the ``ConfigParsed`` event to trigger
340 re-parsing the base metadata (i.e. all the recipes). The 340 re-parsing the base metadata (i.e. all the recipes). The
341 ``ConfigParsed`` event can set the variable to trigger the re-parse. 341 ``ConfigParsed`` event can set the variable to trigger the re-parse.
342 You must be careful to avoid recursive loops with this functionality. 342 You must be careful to avoid recursive loops with this functionality.
343 343
344 BB_LOGCONFIG 344 :term:`BB_LOGCONFIG`
345 Specifies the name of a config file that contains the user logging 345 Specifies the name of a config file that contains the user logging
346 configuration. See 346 configuration. See
347 :ref:`bitbake-user-manual/bitbake-user-manual-execution:logging` 347 :ref:`bitbake-user-manual/bitbake-user-manual-execution:logging`
348 for additional information 348 for additional information
349 349
350 BB_LOGFMT 350 :term:`BB_LOGFMT`
351 Specifies the name of the log files saved into 351 Specifies the name of the log files saved into
352 ``${``\ :term:`T`\ ``}``. By default, the ``BB_LOGFMT`` 352 ``${``\ :term:`T`\ ``}``. By default, the ``BB_LOGFMT``
353 variable is undefined and the log file names get created using the 353 variable is undefined and the log file names get created using the
@@ -358,13 +358,13 @@ overview of their function and contents.
358 If you want to force log files to take a specific name, you can set this 358 If you want to force log files to take a specific name, you can set this
359 variable in a configuration file. 359 variable in a configuration file.
360 360
361 BB_NICE_LEVEL 361 :term:`BB_NICE_LEVEL`
362 Allows BitBake to run at a specific priority (i.e. nice level). 362 Allows BitBake to run at a specific priority (i.e. nice level).
363 System permissions usually mean that BitBake can reduce its priority 363 System permissions usually mean that BitBake can reduce its priority
364 but not raise it again. See :term:`BB_TASK_NICE_LEVEL` for 364 but not raise it again. See :term:`BB_TASK_NICE_LEVEL` for
365 additional information. 365 additional information.
366 366
367 BB_NO_NETWORK 367 :term:`BB_NO_NETWORK`
368 Disables network access in the BitBake fetcher modules. With this 368 Disables network access in the BitBake fetcher modules. With this
369 access disabled, any command that attempts to access the network 369 access disabled, any command that attempts to access the network
370 becomes an error. 370 becomes an error.
@@ -373,16 +373,16 @@ overview of their function and contents.
373 running builds when not connected to the Internet, and when operating 373 running builds when not connected to the Internet, and when operating
374 in certain kinds of firewall environments. 374 in certain kinds of firewall environments.
375 375
376 BB_NUMBER_THREADS 376 :term:`BB_NUMBER_THREADS`
377 The maximum number of tasks BitBake should run in parallel at any one 377 The maximum number of tasks BitBake should run in parallel at any one
378 time. If your host development system supports multiple cores, a good 378 time. If your host development system supports multiple cores, a good
379 rule of thumb is to set this variable to twice the number of cores. 379 rule of thumb is to set this variable to twice the number of cores.
380 380
381 BB_NUMBER_PARSE_THREADS 381 :term:`BB_NUMBER_PARSE_THREADS`
382 Sets the number of threads BitBake uses when parsing. By default, the 382 Sets the number of threads BitBake uses when parsing. By default, the
383 number of threads is equal to the number of cores on the system. 383 number of threads is equal to the number of cores on the system.
384 384
385 BB_ORIGENV 385 :term:`BB_ORIGENV`
386 Contains a copy of the original external environment in which BitBake 386 Contains a copy of the original external environment in which BitBake
387 was run. The copy is taken before any whitelisted variable values are 387 was run. The copy is taken before any whitelisted variable values are
388 filtered into BitBake's datastore. 388 filtered into BitBake's datastore.
@@ -392,7 +392,7 @@ overview of their function and contents.
392 The contents of this variable is a datastore object that can be 392 The contents of this variable is a datastore object that can be
393 queried using the normal datastore operations. 393 queried using the normal datastore operations.
394 394
395 BB_PRESERVE_ENV 395 :term:`BB_PRESERVE_ENV`
396 Disables whitelisting and instead allows all variables through from 396 Disables whitelisting and instead allows all variables through from
397 the external environment into BitBake's datastore. 397 the external environment into BitBake's datastore.
398 398
@@ -401,7 +401,7 @@ overview of their function and contents.
401 You must set this variable in the external environment in order 401 You must set this variable in the external environment in order
402 for it to work. 402 for it to work.
403 403
404 BB_RUNFMT 404 :term:`BB_RUNFMT`
405 Specifies the name of the executable script files (i.e. run files) 405 Specifies the name of the executable script files (i.e. run files)
406 saved into ``${``\ :term:`T`\ ``}``. By default, the 406 saved into ``${``\ :term:`T`\ ``}``. By default, the
407 ``BB_RUNFMT`` variable is undefined and the run file names get 407 ``BB_RUNFMT`` variable is undefined and the run file names get
@@ -412,12 +412,12 @@ overview of their function and contents.
412 If you want to force run files to take a specific name, you can set this 412 If you want to force run files to take a specific name, you can set this
413 variable in a configuration file. 413 variable in a configuration file.
414 414
415 BB_RUNTASK 415 :term:`BB_RUNTASK`
416 Contains the name of the currently executing task. The value includes 416 Contains the name of the currently executing task. The value includes
417 the "do\_" prefix. For example, if the currently executing task is 417 the "do\_" prefix. For example, if the currently executing task is
418 ``do_config``, the value is "do_config". 418 ``do_config``, the value is "do_config".
419 419
420 BB_SCHEDULER 420 :term:`BB_SCHEDULER`
421 Selects the name of the scheduler to use for the scheduling of 421 Selects the name of the scheduler to use for the scheduling of
422 BitBake tasks. Three options exist: 422 BitBake tasks. Three options exist:
423 423
@@ -431,14 +431,14 @@ overview of their function and contents.
431 - *completion* - Causes the scheduler to try to complete a given 431 - *completion* - Causes the scheduler to try to complete a given
432 recipe once its build has started. 432 recipe once its build has started.
433 433
434 BB_SCHEDULERS 434 :term:`BB_SCHEDULERS`
435 Defines custom schedulers to import. Custom schedulers need to be 435 Defines custom schedulers to import. Custom schedulers need to be
436 derived from the ``RunQueueScheduler`` class. 436 derived from the ``RunQueueScheduler`` class.
437 437
438 For information how to select a scheduler, see the 438 For information how to select a scheduler, see the
439 :term:`BB_SCHEDULER` variable. 439 :term:`BB_SCHEDULER` variable.
440 440
441 BB_SETSCENE_DEPVALID 441 :term:`BB_SETSCENE_DEPVALID`
442 Specifies a function BitBake calls that determines whether BitBake 442 Specifies a function BitBake calls that determines whether BitBake
443 requires a setscene dependency to be met. 443 requires a setscene dependency to be met.
444 444
@@ -448,7 +448,7 @@ overview of their function and contents.
448 The function specified by this variable returns a "True" or "False" 448 The function specified by this variable returns a "True" or "False"
449 depending on whether the dependency needs to be met. 449 depending on whether the dependency needs to be met.
450 450
451 BB_SETSCENE_VERIFY_FUNCTION2 451 :term:`BB_SETSCENE_VERIFY_FUNCTION2`
452 Specifies a function to call that verifies the list of planned task 452 Specifies a function to call that verifies the list of planned task
453 execution before the main task execution happens. The function is 453 execution before the main task execution happens. The function is
454 called once BitBake has a list of setscene tasks that have run and 454 called once BitBake has a list of setscene tasks that have run and
@@ -459,7 +459,7 @@ overview of their function and contents.
459 the function can force BitBake to run the task, which is necessary 459 the function can force BitBake to run the task, which is necessary
460 under certain metadata defined circumstances. 460 under certain metadata defined circumstances.
461 461
462 BB_SIGNATURE_EXCLUDE_FLAGS 462 :term:`BB_SIGNATURE_EXCLUDE_FLAGS`
463 Lists variable flags (varflags) that can be safely excluded from 463 Lists variable flags (varflags) that can be safely excluded from
464 checksum and dependency data for keys in the datastore. When 464 checksum and dependency data for keys in the datastore. When
465 generating checksum or dependency data for keys in the datastore, the 465 generating checksum or dependency data for keys in the datastore, the
@@ -469,7 +469,7 @@ overview of their function and contents.
469 ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variable flags`" 469 ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variable flags`"
470 section. 470 section.
471 471
472 BB_SIGNATURE_HANDLER 472 :term:`BB_SIGNATURE_HANDLER`
473 Defines the name of the signature handler BitBake uses. The signature 473 Defines the name of the signature handler BitBake uses. The signature
474 handler defines the way stamp files are created and handled, if and 474 handler defines the way stamp files are created and handled, if and
475 how the signature is incorporated into the stamps, and how the 475 how the signature is incorporated into the stamps, and how the
@@ -478,7 +478,7 @@ overview of their function and contents.
478 A new signature handler can be added by injecting a class derived 478 A new signature handler can be added by injecting a class derived
479 from the ``SignatureGenerator`` class into the global namespace. 479 from the ``SignatureGenerator`` class into the global namespace.
480 480
481 BB_SRCREV_POLICY 481 :term:`BB_SRCREV_POLICY`
482 Defines the behavior of the fetcher when it interacts with source 482 Defines the behavior of the fetcher when it interacts with source
483 control systems and dynamic source revisions. The 483 control systems and dynamic source revisions. The
484 ``BB_SRCREV_POLICY`` variable is useful when working without a 484 ``BB_SRCREV_POLICY`` variable is useful when working without a
@@ -492,7 +492,7 @@ overview of their function and contents.
492 - *clear* - Queries the source controls system every time. With this 492 - *clear* - Queries the source controls system every time. With this
493 policy, there is no cache. The "clear" policy is the default. 493 policy, there is no cache. The "clear" policy is the default.
494 494
495 BB_STAMP_POLICY 495 :term:`BB_STAMP_POLICY`
496 Defines the mode used for how timestamps of stamp files are compared. 496 Defines the mode used for how timestamps of stamp files are compared.
497 You can set the variable to one of the following modes: 497 You can set the variable to one of the following modes:
498 498
@@ -510,18 +510,18 @@ overview of their function and contents.
510 Stamp policies are largely obsolete with the introduction of 510 Stamp policies are largely obsolete with the introduction of
511 setscene tasks. 511 setscene tasks.
512 512
513 BB_STAMP_WHITELIST 513 :term:`BB_STAMP_WHITELIST`
514 Lists files whose stamp file timestamps are compared when the stamp 514 Lists files whose stamp file timestamps are compared when the stamp
515 policy mode is set to "whitelist". For information on stamp policies, 515 policy mode is set to "whitelist". For information on stamp policies,
516 see the :term:`BB_STAMP_POLICY` variable. 516 see the :term:`BB_STAMP_POLICY` variable.
517 517
518 BB_STRICT_CHECKSUM 518 :term:`BB_STRICT_CHECKSUM`
519 Sets a more strict checksum mechanism for non-local URLs. Setting 519 Sets a more strict checksum mechanism for non-local URLs. Setting
520 this variable to a value causes BitBake to report an error if it 520 this variable to a value causes BitBake to report an error if it
521 encounters a non-local URL that does not have at least one checksum 521 encounters a non-local URL that does not have at least one checksum
522 specified. 522 specified.
523 523
524 BB_TASK_IONICE_LEVEL 524 :term:`BB_TASK_IONICE_LEVEL`
525 Allows adjustment of a task's Input/Output priority. During 525 Allows adjustment of a task's Input/Output priority. During
526 Autobuilder testing, random failures can occur for tasks due to I/O 526 Autobuilder testing, random failures can occur for tasks due to I/O
527 starvation. These failures occur during various QEMU runtime 527 starvation. These failures occur during various QEMU runtime
@@ -555,7 +555,7 @@ overview of their function and contents.
555 555
556 $ sudo sh -c “echo cfq > /sys/block/device/queu/scheduler 556 $ sudo sh -c “echo cfq > /sys/block/device/queu/scheduler
557 557
558 BB_TASK_NICE_LEVEL 558 :term:`BB_TASK_NICE_LEVEL`
559 Allows specific tasks to change their priority (i.e. nice level). 559 Allows specific tasks to change their priority (i.e. nice level).
560 560
561 You can use this variable in combination with task overrides to raise 561 You can use this variable in combination with task overrides to raise
@@ -564,22 +564,22 @@ overview of their function and contents.
564 in images is given a higher priority as compared to build tasks to 564 in images is given a higher priority as compared to build tasks to
565 ensure that images do not suffer timeouts on loaded systems. 565 ensure that images do not suffer timeouts on loaded systems.
566 566
567 BB_TASKHASH 567 :term:`BB_TASKHASH`
568 Within an executing task, this variable holds the hash of the task as 568 Within an executing task, this variable holds the hash of the task as
569 returned by the currently enabled signature generator. 569 returned by the currently enabled signature generator.
570 570
571 BB_VERBOSE_LOGS 571 :term:`BB_VERBOSE_LOGS`
572 Controls how verbose BitBake is during builds. If set, shell scripts 572 Controls how verbose BitBake is during builds. If set, shell scripts
573 echo commands and shell script output appears on standard out 573 echo commands and shell script output appears on standard out
574 (stdout). 574 (stdout).
575 575
576 BB_WORKERCONTEXT 576 :term:`BB_WORKERCONTEXT`
577 Specifies if the current context is executing a task. BitBake sets 577 Specifies if the current context is executing a task. BitBake sets
578 this variable to "1" when a task is being executed. The value is not 578 this variable to "1" when a task is being executed. The value is not
579 set when the task is in server context during parsing or event 579 set when the task is in server context during parsing or event
580 handling. 580 handling.
581 581
582 BBCLASSEXTEND 582 :term:`BBCLASSEXTEND`
583 Allows you to extend a recipe so that it builds variants of the 583 Allows you to extend a recipe so that it builds variants of the
584 software. Some examples of these variants for recipes from the 584 software. Some examples of these variants for recipes from the
585 OpenEmbedded-Core metadata are "natives" such as ``quilt-native``, 585 OpenEmbedded-Core metadata are "natives" such as ``quilt-native``,
@@ -611,7 +611,7 @@ overview of their function and contents.
611 since ``include`` statements are processed when the recipe is 611 since ``include`` statements are processed when the recipe is
612 parsed. 612 parsed.
613 613
614 BBDEBUG 614 :term:`BBDEBUG`
615 Sets the BitBake debug output level to a specific value as 615 Sets the BitBake debug output level to a specific value as
616 incremented by the ``-D`` command line option. 616 incremented by the ``-D`` command line option.
617 617
@@ -620,19 +620,19 @@ overview of their function and contents.
620 You must set this variable in the external environment in order 620 You must set this variable in the external environment in order
621 for it to work. 621 for it to work.
622 622
623 BBFILE_COLLECTIONS 623 :term:`BBFILE_COLLECTIONS`
624 Lists the names of configured layers. These names are used to find 624 Lists the names of configured layers. These names are used to find
625 the other ``BBFILE_*`` variables. Typically, each layer appends its 625 the other ``BBFILE_*`` variables. Typically, each layer appends its
626 name to this variable in its ``conf/layer.conf`` file. 626 name to this variable in its ``conf/layer.conf`` file.
627 627
628 BBFILE_PATTERN 628 :term:`BBFILE_PATTERN`
629 Variable that expands to match files from 629 Variable that expands to match files from
630 :term:`BBFILES` in a particular layer. This 630 :term:`BBFILES` in a particular layer. This
631 variable is used in the ``conf/layer.conf`` file and must be suffixed 631 variable is used in the ``conf/layer.conf`` file and must be suffixed
632 with the name of the specific layer (e.g. 632 with the name of the specific layer (e.g.
633 ``BBFILE_PATTERN_emenlow``). 633 ``BBFILE_PATTERN_emenlow``).
634 634
635 BBFILE_PRIORITY 635 :term:`BBFILE_PRIORITY`
636 Assigns the priority for recipe files in each layer. 636 Assigns the priority for recipe files in each layer.
637 637
638 This variable is useful in situations where the same recipe appears 638 This variable is useful in situations where the same recipe appears
@@ -658,7 +658,7 @@ overview of their function and contents.
658 You can use the command bitbake-layers show-layers to list all 658 You can use the command bitbake-layers show-layers to list all
659 configured layers along with their priorities. 659 configured layers along with their priorities.
660 660
661 BBFILES 661 :term:`BBFILES`
662 A space-separated list of recipe files BitBake uses to build 662 A space-separated list of recipe files BitBake uses to build
663 software. 663 software.
664 664
@@ -667,21 +667,21 @@ overview of their function and contents.
667 For details on the syntax, see the documentation by following the 667 For details on the syntax, see the documentation by following the
668 previous link. 668 previous link.
669 669
670 BBINCLUDED 670 :term:`BBINCLUDED`
671 Contains a space-separated list of all of all files that BitBake's 671 Contains a space-separated list of all of all files that BitBake's
672 parser included during parsing of the current file. 672 parser included during parsing of the current file.
673 673
674 BBINCLUDELOGS 674 :term:`BBINCLUDELOGS`
675 If set to a value, enables printing the task log when reporting a 675 If set to a value, enables printing the task log when reporting a
676 failed task. 676 failed task.
677 677
678 BBINCLUDELOGS_LINES 678 :term:`BBINCLUDELOGS_LINES`
679 If :term:`BBINCLUDELOGS` is set, specifies 679 If :term:`BBINCLUDELOGS` is set, specifies
680 the maximum number of lines from the task log file to print when 680 the maximum number of lines from the task log file to print when
681 reporting a failed task. If you do not set ``BBINCLUDELOGS_LINES``, 681 reporting a failed task. If you do not set ``BBINCLUDELOGS_LINES``,
682 the entire log is printed. 682 the entire log is printed.
683 683
684 BBLAYERS 684 :term:`BBLAYERS`
685 Lists the layers to enable during the build. This variable is defined 685 Lists the layers to enable during the build. This variable is defined
686 in the ``bblayers.conf`` configuration file in the build directory. 686 in the ``bblayers.conf`` configuration file in the build directory.
687 Here is an example: :: 687 Here is an example: ::
@@ -696,12 +696,12 @@ overview of their function and contents.
696 This example enables four layers, one of which is a custom, user-defined 696 This example enables four layers, one of which is a custom, user-defined
697 layer named ``meta-mykernel``. 697 layer named ``meta-mykernel``.
698 698
699 BBLAYERS_FETCH_DIR 699 :term:`BBLAYERS_FETCH_DIR`
700 Sets the base location where layers are stored. This setting is used 700 Sets the base location where layers are stored. This setting is used
701 in conjunction with ``bitbake-layers layerindex-fetch`` and tells 701 in conjunction with ``bitbake-layers layerindex-fetch`` and tells
702 ``bitbake-layers`` where to place the fetched layers. 702 ``bitbake-layers`` where to place the fetched layers.
703 703
704 BBMASK 704 :term:`BBMASK`
705 Prevents BitBake from processing recipes and recipe append files. 705 Prevents BitBake from processing recipes and recipe append files.
706 706
707 You can use the ``BBMASK`` variable to "hide" these ``.bb`` and 707 You can use the ``BBMASK`` variable to "hide" these ``.bb`` and
@@ -737,7 +737,7 @@ overview of their function and contents.
737 When specifying a directory name, use the trailing slash character 737 When specifying a directory name, use the trailing slash character
738 to ensure you match just that directory name. 738 to ensure you match just that directory name.
739 739
740 BBMULTICONFIG 740 :term:`BBMULTICONFIG`
741 Enables BitBake to perform multiple configuration builds and lists 741 Enables BitBake to perform multiple configuration builds and lists
742 each separate configuration (multiconfig). You can use this variable 742 each separate configuration (multiconfig). You can use this variable
743 to cause BitBake to build multiple targets where each target has a 743 to cause BitBake to build multiple targets where each target has a
@@ -758,7 +758,7 @@ overview of their function and contents.
758 ":ref:`bitbake-user-manual/bitbake-user-manual-intro:executing a multiple configuration build`" 758 ":ref:`bitbake-user-manual/bitbake-user-manual-intro:executing a multiple configuration build`"
759 section. 759 section.
760 760
761 BBPATH 761 :term:`BBPATH`
762 Used by BitBake to locate class (``.bbclass``) and configuration 762 Used by BitBake to locate class (``.bbclass``) and configuration
763 (``.conf``) files. This variable is analogous to the ``PATH`` 763 (``.conf``) files. This variable is analogous to the ``PATH``
764 variable. 764 variable.
@@ -772,15 +772,15 @@ overview of their function and contents.
772 $ export BBPATH 772 $ export BBPATH
773 $ bitbake target 773 $ bitbake target
774 774
775 BBSERVER 775 :term:`BBSERVER`
776 Points to the server that runs memory-resident BitBake. The variable 776 Points to the server that runs memory-resident BitBake. The variable
777 is only used when you employ memory-resident BitBake. 777 is only used when you employ memory-resident BitBake.
778 778
779 BBTARGETS 779 :term:`BBTARGETS`
780 Allows you to use a configuration file to add to the list of 780 Allows you to use a configuration file to add to the list of
781 command-line target recipes you want to build. 781 command-line target recipes you want to build.
782 782
783 BBVERSIONS 783 :term:`BBVERSIONS`
784 Allows a single recipe to build multiple versions of a project from a 784 Allows a single recipe to build multiple versions of a project from a
785 single recipe file. You also able to specify conditional metadata 785 single recipe file. You also able to specify conditional metadata
786 using the :term:`OVERRIDES` mechanism for a 786 using the :term:`OVERRIDES` mechanism for a
@@ -790,7 +790,7 @@ overview of their function and contents.
790 ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variants - class extension mechanism`" 790 ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:variants - class extension mechanism`"
791 section. 791 section.
792 792
793 BITBAKE_UI 793 :term:`BITBAKE_UI`
794 Used to specify the UI module to use when running BitBake. Using this 794 Used to specify the UI module to use when running BitBake. Using this
795 variable is equivalent to using the ``-u`` command-line option. 795 variable is equivalent to using the ``-u`` command-line option.
796 796
@@ -799,23 +799,23 @@ overview of their function and contents.
799 You must set this variable in the external environment in order 799 You must set this variable in the external environment in order
800 for it to work. 800 for it to work.
801 801
802 BUILDNAME 802 :term:`BUILDNAME`
803 A name assigned to the build. The name defaults to a datetime stamp 803 A name assigned to the build. The name defaults to a datetime stamp
804 of when the build was started but can be defined by the metadata. 804 of when the build was started but can be defined by the metadata.
805 805
806 BZRDIR 806 :term:`BZRDIR`
807 The directory in which files checked out of a Bazaar system are 807 The directory in which files checked out of a Bazaar system are
808 stored. 808 stored.
809 809
810 CACHE 810 :term:`CACHE`
811 Specifies the directory BitBake uses to store a cache of the metadata 811 Specifies the directory BitBake uses to store a cache of the metadata
812 so it does not need to be parsed every time BitBake is started. 812 so it does not need to be parsed every time BitBake is started.
813 813
814 CVSDIR 814 :term:`CVSDIR`
815 The directory in which files checked out under the CVS system are 815 The directory in which files checked out under the CVS system are
816 stored. 816 stored.
817 817
818 DEFAULT_PREFERENCE 818 :term:`DEFAULT_PREFERENCE`
819 Specifies a weak bias for recipe selection priority. 819 Specifies a weak bias for recipe selection priority.
820 820
821 The most common usage of this is variable is to set it to "-1" within 821 The most common usage of this is variable is to set it to "-1" within
@@ -830,7 +830,7 @@ overview of their function and contents.
830 :term:`BBFILE_PRIORITY` if that variable is different between two 830 :term:`BBFILE_PRIORITY` if that variable is different between two
831 layers that contain different versions of the same recipe. 831 layers that contain different versions of the same recipe.
832 832
833 DEPENDS 833 :term:`DEPENDS`
834 Lists a recipe's build-time dependencies (i.e. other recipe files). 834 Lists a recipe's build-time dependencies (i.e. other recipe files).
835 835
836 Consider this simple example for two recipes named "a" and "b" that 836 Consider this simple example for two recipes named "a" and "b" that
@@ -847,16 +847,16 @@ overview of their function and contents.
847 For information on runtime dependencies, see the :term:`RDEPENDS` 847 For information on runtime dependencies, see the :term:`RDEPENDS`
848 variable. 848 variable.
849 849
850 DESCRIPTION 850 :term:`DESCRIPTION`
851 A long description for the recipe. 851 A long description for the recipe.
852 852
853 DL_DIR 853 :term:`DL_DIR`
854 The central download directory used by the build process to store 854 The central download directory used by the build process to store
855 downloads. By default, ``DL_DIR`` gets files suitable for mirroring for 855 downloads. By default, ``DL_DIR`` gets files suitable for mirroring for
856 everything except Git repositories. If you want tarballs of Git 856 everything except Git repositories. If you want tarballs of Git
857 repositories, use the :term:`BB_GENERATE_MIRROR_TARBALLS` variable. 857 repositories, use the :term:`BB_GENERATE_MIRROR_TARBALLS` variable.
858 858
859 EXCLUDE_FROM_WORLD 859 :term:`EXCLUDE_FROM_WORLD`
860 Directs BitBake to exclude a recipe from world builds (i.e. 860 Directs BitBake to exclude a recipe from world builds (i.e.
861 ``bitbake world``). During world builds, BitBake locates, parses and 861 ``bitbake world``). During world builds, BitBake locates, parses and
862 builds all recipes found in every layer exposed in the 862 builds all recipes found in every layer exposed in the
@@ -872,68 +872,68 @@ overview of their function and contents.
872 recipe to ``EXCLUDE_FROM_WORLD`` only ensures that the recipe is not 872 recipe to ``EXCLUDE_FROM_WORLD`` only ensures that the recipe is not
873 explicitly added to the list of build targets in a world build. 873 explicitly added to the list of build targets in a world build.
874 874
875 FAKEROOT 875 :term:`FAKEROOT`
876 Contains the command to use when running a shell script in a fakeroot 876 Contains the command to use when running a shell script in a fakeroot
877 environment. The ``FAKEROOT`` variable is obsolete and has been 877 environment. The ``FAKEROOT`` variable is obsolete and has been
878 replaced by the other ``FAKEROOT*`` variables. See these entries in 878 replaced by the other ``FAKEROOT*`` variables. See these entries in
879 the glossary for more information. 879 the glossary for more information.
880 880
881 FAKEROOTBASEENV 881 :term:`FAKEROOTBASEENV`
882 Lists environment variables to set when executing the command defined 882 Lists environment variables to set when executing the command defined
883 by :term:`FAKEROOTCMD` that starts the 883 by :term:`FAKEROOTCMD` that starts the
884 bitbake-worker process in the fakeroot environment. 884 bitbake-worker process in the fakeroot environment.
885 885
886 FAKEROOTCMD 886 :term:`FAKEROOTCMD`
887 Contains the command that starts the bitbake-worker process in the 887 Contains the command that starts the bitbake-worker process in the
888 fakeroot environment. 888 fakeroot environment.
889 889
890 FAKEROOTDIRS 890 :term:`FAKEROOTDIRS`
891 Lists directories to create before running a task in the fakeroot 891 Lists directories to create before running a task in the fakeroot
892 environment. 892 environment.
893 893
894 FAKEROOTENV 894 :term:`FAKEROOTENV`
895 Lists environment variables to set when running a task in the 895 Lists environment variables to set when running a task in the
896 fakeroot environment. For additional information on environment 896 fakeroot environment. For additional information on environment
897 variables and the fakeroot environment, see the 897 variables and the fakeroot environment, see the
898 :term:`FAKEROOTBASEENV` variable. 898 :term:`FAKEROOTBASEENV` variable.
899 899
900 FAKEROOTNOENV 900 :term:`FAKEROOTNOENV`
901 Lists environment variables to set when running a task that is not in 901 Lists environment variables to set when running a task that is not in
902 the fakeroot environment. For additional information on environment 902 the fakeroot environment. For additional information on environment
903 variables and the fakeroot environment, see the 903 variables and the fakeroot environment, see the
904 :term:`FAKEROOTENV` variable. 904 :term:`FAKEROOTENV` variable.
905 905
906 FETCHCMD 906 :term:`FETCHCMD`
907 Defines the command the BitBake fetcher module executes when running 907 Defines the command the BitBake fetcher module executes when running
908 fetch operations. You need to use an override suffix when you use the 908 fetch operations. You need to use an override suffix when you use the
909 variable (e.g. ``FETCHCMD_git`` or ``FETCHCMD_svn``). 909 variable (e.g. ``FETCHCMD_git`` or ``FETCHCMD_svn``).
910 910
911 FILE 911 :term:`FILE`
912 Points at the current file. BitBake sets this variable during the 912 Points at the current file. BitBake sets this variable during the
913 parsing process to identify the file being parsed. BitBake also sets 913 parsing process to identify the file being parsed. BitBake also sets
914 this variable when a recipe is being executed to identify the recipe 914 this variable when a recipe is being executed to identify the recipe
915 file. 915 file.
916 916
917 FILESPATH 917 :term:`FILESPATH`
918 Specifies directories BitBake uses when searching for patches and 918 Specifies directories BitBake uses when searching for patches and
919 files. The "local" fetcher module uses these directories when 919 files. The "local" fetcher module uses these directories when
920 handling ``file://`` URLs. The variable behaves like a shell ``PATH`` 920 handling ``file://`` URLs. The variable behaves like a shell ``PATH``
921 environment variable. The value is a colon-separated list of 921 environment variable. The value is a colon-separated list of
922 directories that are searched left-to-right in order. 922 directories that are searched left-to-right in order.
923 923
924 GITDIR 924 :term:`GITDIR`
925 The directory in which a local copy of a Git repository is stored 925 The directory in which a local copy of a Git repository is stored
926 when it is cloned. 926 when it is cloned.
927 927
928 HGDIR 928 :term:`HGDIR`
929 The directory in which files checked out of a Mercurial system are 929 The directory in which files checked out of a Mercurial system are
930 stored. 930 stored.
931 931
932 HOMEPAGE 932 :term:`HOMEPAGE`
933 Website where more information about the software the recipe is 933 Website where more information about the software the recipe is
934 building can be found. 934 building can be found.
935 935
936 INHERIT 936 :term:`INHERIT`
937 Causes the named class or classes to be inherited globally. Anonymous 937 Causes the named class or classes to be inherited globally. Anonymous
938 functions in the class or classes are not executed for the base 938 functions in the class or classes are not executed for the base
939 configuration and in each individual recipe. The OpenEmbedded build 939 configuration and in each individual recipe. The OpenEmbedded build
@@ -943,7 +943,7 @@ overview of their function and contents.
943 ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`" 943 ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`"
944 section. 944 section.
945 945
946 LAYERDEPENDS 946 :term:`LAYERDEPENDS`
947 Lists the layers, separated by spaces, upon which this recipe 947 Lists the layers, separated by spaces, upon which this recipe
948 depends. Optionally, you can specify a specific layer version for a 948 depends. Optionally, you can specify a specific layer version for a
949 dependency by adding it to the end of the layer name with a colon, 949 dependency by adding it to the end of the layer name with a colon,
@@ -956,20 +956,20 @@ overview of their function and contents.
956 use the specific layer name as a suffix to the variable (e.g. 956 use the specific layer name as a suffix to the variable (e.g.
957 ``LAYERDEPENDS_mylayer``). 957 ``LAYERDEPENDS_mylayer``).
958 958
959 LAYERDIR 959 :term:`LAYERDIR`
960 When used inside the ``layer.conf`` configuration file, this variable 960 When used inside the ``layer.conf`` configuration file, this variable
961 provides the path of the current layer. This variable is not 961 provides the path of the current layer. This variable is not
962 available outside of ``layer.conf`` and references are expanded 962 available outside of ``layer.conf`` and references are expanded
963 immediately when parsing of the file completes. 963 immediately when parsing of the file completes.
964 964
965 LAYERDIR_RE 965 :term:`LAYERDIR_RE`
966 When used inside the ``layer.conf`` configuration file, this variable 966 When used inside the ``layer.conf`` configuration file, this variable
967 provides the path of the current layer, escaped for use in a regular 967 provides the path of the current layer, escaped for use in a regular
968 expression (:term:`BBFILE_PATTERN`). This 968 expression (:term:`BBFILE_PATTERN`). This
969 variable is not available outside of ``layer.conf`` and references 969 variable is not available outside of ``layer.conf`` and references
970 are expanded immediately when parsing of the file completes. 970 are expanded immediately when parsing of the file completes.
971 971
972 LAYERVERSION 972 :term:`LAYERVERSION`
973 Optionally specifies the version of a layer as a single number. You 973 Optionally specifies the version of a layer as a single number. You
974 can use this variable within 974 can use this variable within
975 :term:`LAYERDEPENDS` for another layer in 975 :term:`LAYERDEPENDS` for another layer in
@@ -979,10 +979,10 @@ overview of their function and contents.
979 use the specific layer name as a suffix to the variable (e.g. 979 use the specific layer name as a suffix to the variable (e.g.
980 ``LAYERDEPENDS_mylayer``). 980 ``LAYERDEPENDS_mylayer``).
981 981
982 LICENSE 982 :term:`LICENSE`
983 The list of source licenses for the recipe. 983 The list of source licenses for the recipe.
984 984
985 MIRRORS 985 :term:`MIRRORS`
986 Specifies additional paths from which BitBake gets source code. When 986 Specifies additional paths from which BitBake gets source code. When
987 the build system searches for source code, it first tries the local 987 the build system searches for source code, it first tries the local
988 download directory. If that location fails, the build system tries 988 download directory. If that location fails, the build system tries
@@ -990,7 +990,7 @@ overview of their function and contents.
990 upstream source, and then locations specified by ``MIRRORS`` in that 990 upstream source, and then locations specified by ``MIRRORS`` in that
991 order. 991 order.
992 992
993 MULTI_PROVIDER_WHITELIST 993 :term:`MULTI_PROVIDER_WHITELIST`
994 Allows you to suppress BitBake warnings caused when building two 994 Allows you to suppress BitBake warnings caused when building two
995 separate recipes that provide the same output. 995 separate recipes that provide the same output.
996 996
@@ -1003,7 +1003,7 @@ overview of their function and contents.
1003 To use the variable, list provider names (e.g. recipe names, 1003 To use the variable, list provider names (e.g. recipe names,
1004 ``virtual/kernel``, and so forth). 1004 ``virtual/kernel``, and so forth).
1005 1005
1006 OVERRIDES 1006 :term:`OVERRIDES`
1007 BitBake uses ``OVERRIDES`` to control what variables are overridden 1007 BitBake uses ``OVERRIDES`` to control what variables are overridden
1008 after BitBake parses recipes and configuration files. 1008 after BitBake parses recipes and configuration files.
1009 1009
@@ -1013,14 +1013,14 @@ overview of their function and contents.
1013 ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax 1013 ":ref:`bitbake-user-manual/bitbake-user-manual-metadata:conditional syntax
1014 (overrides)`" section. 1014 (overrides)`" section.
1015 1015
1016 P4DIR 1016 :term:`P4DIR`
1017 The directory in which a local copy of a Perforce depot is stored 1017 The directory in which a local copy of a Perforce depot is stored
1018 when it is fetched. 1018 when it is fetched.
1019 1019
1020 PACKAGES 1020 :term:`PACKAGES`
1021 The list of packages the recipe creates. 1021 The list of packages the recipe creates.
1022 1022
1023 PACKAGES_DYNAMIC 1023 :term:`PACKAGES_DYNAMIC`
1024 A promise that your recipe satisfies runtime dependencies for 1024 A promise that your recipe satisfies runtime dependencies for
1025 optional modules that are found in other recipes. 1025 optional modules that are found in other recipes.
1026 ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it 1026 ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it
@@ -1030,29 +1030,29 @@ overview of their function and contents.
1030 ``PACKAGES_DYNAMIC`` variable, but a package with the module name is 1030 ``PACKAGES_DYNAMIC`` variable, but a package with the module name is
1031 never actually produced, then the other package will be broken. 1031 never actually produced, then the other package will be broken.
1032 1032
1033 PE 1033 :term:`PE`
1034 The epoch of the recipe. By default, this variable is unset. The 1034 The epoch of the recipe. By default, this variable is unset. The
1035 variable is used to make upgrades possible when the versioning scheme 1035 variable is used to make upgrades possible when the versioning scheme
1036 changes in some backwards incompatible way. 1036 changes in some backwards incompatible way.
1037 1037
1038 PERSISTENT_DIR 1038 :term:`PERSISTENT_DIR`
1039 Specifies the directory BitBake uses to store data that should be 1039 Specifies the directory BitBake uses to store data that should be
1040 preserved between builds. In particular, the data stored is the data 1040 preserved between builds. In particular, the data stored is the data
1041 that uses BitBake's persistent data API and the data used by the PR 1041 that uses BitBake's persistent data API and the data used by the PR
1042 Server and PR Service. 1042 Server and PR Service.
1043 1043
1044 PF 1044 :term:`PF`
1045 Specifies the recipe or package name and includes all version and 1045 Specifies the recipe or package name and includes all version and
1046 revision numbers (i.e. ``eglibc-2.13-r20+svnr15508/`` and 1046 revision numbers (i.e. ``eglibc-2.13-r20+svnr15508/`` and
1047 ``bash-4.2-r1/``). 1047 ``bash-4.2-r1/``).
1048 1048
1049 PN 1049 :term:`PN`
1050 The recipe name. 1050 The recipe name.
1051 1051
1052 PR 1052 :term:`PR`
1053 The revision of the recipe. 1053 The revision of the recipe.
1054 1054
1055 PREFERRED_PROVIDER 1055 :term:`PREFERRED_PROVIDER`
1056 Determines which recipe should be given preference when multiple 1056 Determines which recipe should be given preference when multiple
1057 recipes provide the same item. You should always suffix the variable 1057 recipes provide the same item. You should always suffix the variable
1058 with the name of the provided item, and you should set it to the 1058 with the name of the provided item, and you should set it to the
@@ -1063,7 +1063,7 @@ overview of their function and contents.
1063 PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86" 1063 PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86"
1064 PREFERRED_PROVIDER_virtual/libgl ?= "mesa" 1064 PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
1065 1065
1066 PREFERRED_PROVIDERS 1066 :term:`PREFERRED_PROVIDERS`
1067 Determines which recipe should be given preference for cases where 1067 Determines which recipe should be given preference for cases where
1068 multiple recipes provide the same item. Functionally, 1068 multiple recipes provide the same item. Functionally,
1069 ``PREFERRED_PROVIDERS`` is identical to 1069 ``PREFERRED_PROVIDERS`` is identical to
@@ -1078,7 +1078,7 @@ overview of their function and contents.
1078 PREFERRED_PROVIDER_xxx = "yyy" 1078 PREFERRED_PROVIDER_xxx = "yyy"
1079 PREFERRED_PROVIDER_aaa = "bbb" 1079 PREFERRED_PROVIDER_aaa = "bbb"
1080 1080
1081 PREFERRED_VERSION 1081 :term:`PREFERRED_VERSION`
1082 If there are multiple versions of recipes available, this variable 1082 If there are multiple versions of recipes available, this variable
1083 determines which recipe should be given preference. You must always 1083 determines which recipe should be given preference. You must always
1084 suffix the variable with the :term:`PN` you want to 1084 suffix the variable with the :term:`PN` you want to
@@ -1100,7 +1100,7 @@ overview of their function and contents.
1100 end of the string. You cannot use the wildcard character in any other 1100 end of the string. You cannot use the wildcard character in any other
1101 location of the string. 1101 location of the string.
1102 1102
1103 PREMIRRORS 1103 :term:`PREMIRRORS`
1104 Specifies additional paths from which BitBake gets source code. When 1104 Specifies additional paths from which BitBake gets source code. When
1105 the build system searches for source code, it first tries the local 1105 the build system searches for source code, it first tries the local
1106 download directory. If that location fails, the build system tries 1106 download directory. If that location fails, the build system tries
@@ -1122,7 +1122,7 @@ overview of their function and contents.
1122 use ``file://`` URLs to point to local directories or network shares as 1122 use ``file://`` URLs to point to local directories or network shares as
1123 well. 1123 well.
1124 1124
1125 PROVIDES 1125 :term:`PROVIDES`
1126 A list of aliases by which a particular recipe can be known. By 1126 A list of aliases by which a particular recipe can be known. By
1127 default, a recipe's own ``PN`` is implicitly already in its 1127 default, a recipe's own ``PN`` is implicitly already in its
1128 ``PROVIDES`` list. If a recipe uses ``PROVIDES``, the additional 1128 ``PROVIDES`` list. If a recipe uses ``PROVIDES``, the additional
@@ -1151,7 +1151,7 @@ overview of their function and contents.
1151 "virtual/function" (e.g. "virtual/kernel"). The slash is simply part 1151 "virtual/function" (e.g. "virtual/kernel"). The slash is simply part
1152 of the name and has no syntactical significance. 1152 of the name and has no syntactical significance.
1153 1153
1154 PRSERV_HOST 1154 :term:`PRSERV_HOST`
1155 The network based :term:`PR` service host and port. 1155 The network based :term:`PR` service host and port.
1156 1156
1157 Following is an example of how the ``PRSERV_HOST`` variable is set: :: 1157 Following is an example of how the ``PRSERV_HOST`` variable is set: ::
@@ -1162,10 +1162,10 @@ overview of their function and contents.
1162 service. You can set ``PRSERV_HOST`` to other values to use a remote PR 1162 service. You can set ``PRSERV_HOST`` to other values to use a remote PR
1163 service. 1163 service.
1164 1164
1165 PV 1165 :term:`PV`
1166 The version of the recipe. 1166 The version of the recipe.
1167 1167
1168 RDEPENDS 1168 :term:`RDEPENDS`
1169 Lists a package's runtime dependencies (i.e. other packages) that 1169 Lists a package's runtime dependencies (i.e. other packages) that
1170 must be installed in order for the built package to run correctly. If 1170 must be installed in order for the built package to run correctly. If
1171 a package in this list cannot be found during the build, you will get 1171 a package in this list cannot be found during the build, you will get
@@ -1206,11 +1206,11 @@ overview of their function and contents.
1206 For information on build-time dependencies, see the :term:`DEPENDS` 1206 For information on build-time dependencies, see the :term:`DEPENDS`
1207 variable. 1207 variable.
1208 1208
1209 REPODIR 1209 :term:`REPODIR`
1210 The directory in which a local copy of a ``google-repo`` directory is 1210 The directory in which a local copy of a ``google-repo`` directory is
1211 stored when it is synced. 1211 stored when it is synced.
1212 1212
1213 RPROVIDES 1213 :term:`RPROVIDES`
1214 A list of package name aliases that a package also provides. These 1214 A list of package name aliases that a package also provides. These
1215 aliases are useful for satisfying runtime dependencies of other 1215 aliases are useful for satisfying runtime dependencies of other
1216 packages both during the build and on the target (as specified by 1216 packages both during the build and on the target (as specified by
@@ -1222,7 +1222,7 @@ overview of their function and contents.
1222 1222
1223 RPROVIDES_${PN} = "widget-abi-2" 1223 RPROVIDES_${PN} = "widget-abi-2"
1224 1224
1225 RRECOMMENDS 1225 :term:`RRECOMMENDS`
1226 A list of packages that extends the usability of a package being 1226 A list of packages that extends the usability of a package being
1227 built. The package being built does not depend on this list of 1227 built. The package being built does not depend on this list of
1228 packages in order to successfully build, but needs them for the 1228 packages in order to successfully build, but needs them for the
@@ -1249,10 +1249,10 @@ overview of their function and contents.
1249 1249
1250 RRECOMMENDS_${PN} = "foo (>= 1.2)" 1250 RRECOMMENDS_${PN} = "foo (>= 1.2)"
1251 1251
1252 SECTION 1252 :term:`SECTION`
1253 The section in which packages should be categorized. 1253 The section in which packages should be categorized.
1254 1254
1255 SRC_URI 1255 :term:`SRC_URI`
1256 The list of source files - local or remote. This variable tells 1256 The list of source files - local or remote. This variable tells
1257 BitBake which bits to pull for the build and how to pull them. For 1257 BitBake which bits to pull for the build and how to pull them. For
1258 example, if the recipe or append file needs to fetch a single tarball 1258 example, if the recipe or append file needs to fetch a single tarball
@@ -1316,12 +1316,12 @@ overview of their function and contents.
1316 - ``downloadfilename`` : Specifies the filename used when storing 1316 - ``downloadfilename`` : Specifies the filename used when storing
1317 the downloaded file. 1317 the downloaded file.
1318 1318
1319 SRCDATE 1319 :term:`SRCDATE`
1320 The date of the source code used to build the package. This variable 1320 The date of the source code used to build the package. This variable
1321 applies only if the source was fetched from a Source Code Manager 1321 applies only if the source was fetched from a Source Code Manager
1322 (SCM). 1322 (SCM).
1323 1323
1324 SRCREV 1324 :term:`SRCREV`
1325 The revision of the source code used to build the package. This 1325 The revision of the source code used to build the package. This
1326 variable applies only when using Subversion, Git, Mercurial and 1326 variable applies only when using Subversion, Git, Mercurial and
1327 Bazaar. If you want to build a fixed revision and you want to avoid 1327 Bazaar. If you want to build a fixed revision and you want to avoid
@@ -1329,7 +1329,7 @@ overview of their function and contents.
1329 your recipe, you should specify a ``SRCREV`` that is a full revision 1329 your recipe, you should specify a ``SRCREV`` that is a full revision
1330 identifier and not just a tag. 1330 identifier and not just a tag.
1331 1331
1332 SRCREV_FORMAT 1332 :term:`SRCREV_FORMAT`
1333 Helps construct valid :term:`SRCREV` values when 1333 Helps construct valid :term:`SRCREV` values when
1334 multiple source controlled URLs are used in 1334 multiple source controlled URLs are used in
1335 :term:`SRC_URI`. 1335 :term:`SRC_URI`.
@@ -1343,30 +1343,30 @@ overview of their function and contents.
1343 ``AUTOINC`` placeholder is added and if needed. And, this placeholder 1343 ``AUTOINC`` placeholder is added and if needed. And, this placeholder
1344 is placed at the start of the returned string. 1344 is placed at the start of the returned string.
1345 1345
1346 STAMP 1346 :term:`STAMP`
1347 Specifies the base path used to create recipe stamp files. The path 1347 Specifies the base path used to create recipe stamp files. The path
1348 to an actual stamp file is constructed by evaluating this string and 1348 to an actual stamp file is constructed by evaluating this string and
1349 then appending additional information. 1349 then appending additional information.
1350 1350
1351 STAMPCLEAN 1351 :term:`STAMPCLEAN`
1352 Specifies the base path used to create recipe stamp files. Unlike the 1352 Specifies the base path used to create recipe stamp files. Unlike the
1353 :term:`STAMP` variable, ``STAMPCLEAN`` can contain 1353 :term:`STAMP` variable, ``STAMPCLEAN`` can contain
1354 wildcards to match the range of files a clean operation should 1354 wildcards to match the range of files a clean operation should
1355 remove. BitBake uses a clean operation to remove any other stamps it 1355 remove. BitBake uses a clean operation to remove any other stamps it
1356 should be removing when creating a new stamp. 1356 should be removing when creating a new stamp.
1357 1357
1358 SUMMARY 1358 :term:`SUMMARY`
1359 A short summary for the recipe, which is 72 characters or less. 1359 A short summary for the recipe, which is 72 characters or less.
1360 1360
1361 SVNDIR 1361 :term:`SVNDIR`
1362 The directory in which files checked out of a Subversion system are 1362 The directory in which files checked out of a Subversion system are
1363 stored. 1363 stored.
1364 1364
1365 T 1365 :term:`T`
1366 Points to a directory were BitBake places temporary files, which 1366 Points to a directory were BitBake places temporary files, which
1367 consist mostly of task logs and scripts, when building a particular 1367 consist mostly of task logs and scripts, when building a particular
1368 recipe. 1368 recipe.
1369 1369
1370 TOPDIR 1370 :term:`TOPDIR`
1371 Points to the build directory. BitBake automatically sets this 1371 Points to the build directory. BitBake automatically sets this
1372 variable. 1372 variable.