summaryrefslogtreecommitdiffstats
path: root/bitbake
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-30 16:18:27 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-16 18:14:07 +0100
commit2df3190f13b23c8423adf907e8ce025d04b3f781 (patch)
tree948b0ab64c521d540db82ff077371bdaf4f79713 /bitbake
parent623ea7f3fe9fe8c972b5c6c3bcbe6fc0c4798182 (diff)
downloadpoky-2df3190f13b23c8423adf907e8ce025d04b3f781.tar.gz
bitbake: sphinx: fixup for links
Since we converted the list of variables into a Sphinx glossary, the automatic conversion from Pandoc does not produce proper links. We fix them up using a Python regexp. Similarly some http links were not converted correctly, and can also be fixed up with a regexp. This patch was generated by running the following regexp: line = re.sub("` <(https?://.*)>`__", "\\1", line) line = re.sub("`+(\w+)`* <#var-bb-\\1>`__", ":term:`\\1`", line) (Bitbake rev: 57300955beb200c81762880f44f1a499451b7432) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst74
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst44
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst24
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.rst2
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst74
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst102
6 files changed, 160 insertions, 160 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst
index 9488ea9bae..d97fea42ad 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst
@@ -20,7 +20,7 @@ Command <#bitbake-user-manual-command>`__" section.
20 20
21 Prior to executing BitBake, you should take advantage of available 21 Prior to executing BitBake, you should take advantage of available
22 parallel thread execution on your build host by setting the 22 parallel thread execution on your build host by setting the
23 ```BB_NUMBER_THREADS`` <#var-bb-BB_NUMBER_THREADS>`__ variable in 23 :term:`BB_NUMBER_THREADS` variable in
24 your project's ``local.conf`` configuration file. 24 your project's ``local.conf`` configuration file.
25 25
26 A common method to determine this value for your build host is to run 26 A common method to determine this value for your build host is to run
@@ -52,7 +52,7 @@ data itself is of various types:
52 together. 52 together.
53 53
54The ``layer.conf`` files are used to construct key variables such as 54The ``layer.conf`` files are used to construct key variables such as
55```BBPATH`` <#var-bb-BBPATH>`__ and ```BBFILES`` <#var-bb-BBFILES>`__. 55:term:`BBPATH` and :term:`BBFILES`.
56``BBPATH`` is used to search for configuration and class files under the 56``BBPATH`` is used to search for configuration and class files under the
57``conf`` and ``classes`` directories, respectively. ``BBFILES`` is used 57``conf`` and ``classes`` directories, respectively. ``BBFILES`` is used
58to locate both recipe and recipe append files (``.bb`` and 58to locate both recipe and recipe append files (``.bb`` and
@@ -67,15 +67,15 @@ directives.
67Prior to parsing configuration files, BitBake looks at certain 67Prior to parsing configuration files, BitBake looks at certain
68variables, including: 68variables, including:
69 69
70- ```BB_ENV_WHITELIST`` <#var-bb-BB_ENV_WHITELIST>`__ 70- :term:`BB_ENV_WHITELIST`
71 71
72- ```BB_ENV_EXTRAWHITE`` <#var-bb-BB_ENV_EXTRAWHITE>`__ 72- :term:`BB_ENV_EXTRAWHITE`
73 73
74- ```BB_PRESERVE_ENV`` <#var-bb-BB_PRESERVE_ENV>`__ 74- :term:`BB_PRESERVE_ENV`
75 75
76- ```BB_ORIGENV`` <#var-bb-BB_ORIGENV>`__ 76- :term:`BB_ORIGENV`
77 77
78- ```BITBAKE_UI`` <#var-bb-BITBAKE_UI>`__ 78- :term:`BITBAKE_UI`
79 79
80The first four variables in this list relate to how BitBake treats shell 80The first four variables in this list relate to how BitBake treats shell
81environment variables during task execution. By default, BitBake cleans 81environment variables during task execution. By default, BitBake cleans
@@ -93,16 +93,16 @@ recipes and tasks that are executed.
93 93
94BitBake first searches the current working directory for an optional 94BitBake first searches the current working directory for an optional
95``conf/bblayers.conf`` configuration file. This file is expected to 95``conf/bblayers.conf`` configuration file. This file is expected to
96contain a ```BBLAYERS`` <#var-bb-BBLAYERS>`__ variable that is a 96contain a :term:`BBLAYERS` variable that is a
97space-delimited list of 'layer' directories. Recall that if BitBake 97space-delimited list of 'layer' directories. Recall that if BitBake
98cannot find a ``bblayers.conf`` file, then it is assumed the user has 98cannot find a ``bblayers.conf`` file, then it is assumed the user has
99set the ``BBPATH`` and ``BBFILES`` variables directly in the 99set the ``BBPATH`` and ``BBFILES`` variables directly in the
100environment. 100environment.
101 101
102For each directory (layer) in this list, a ``conf/layer.conf`` file is 102For each directory (layer) in this list, a ``conf/layer.conf`` file is
103located and parsed with the ```LAYERDIR`` <#var-bb-LAYERDIR>`__ variable 103located and parsed with the :term:`LAYERDIR` variable
104being set to the directory where the layer was found. The idea is these 104being set to the directory where the layer was found. The idea is these
105files automatically set up ```BBPATH`` <#var-bb-BBPATH>`__ and other 105files automatically set up :term:`BBPATH` and other
106variables correctly for a given build directory. 106variables correctly for a given build directory.
107 107
108BitBake then expects to find the ``conf/bitbake.conf`` file somewhere in 108BitBake then expects to find the ``conf/bitbake.conf`` file somewhere in
@@ -125,7 +125,7 @@ responsible for getting that class is encountered.
125 125
126The ``base.bbclass`` file is always included. Other classes that are 126The ``base.bbclass`` file is always included. Other classes that are
127specified in the configuration using the 127specified in the configuration using the
128```INHERIT`` <#var-bb-INHERIT>`__ variable are also included. BitBake 128:term:`INHERIT` variable are also included. BitBake
129searches for class files in a ``classes`` subdirectory under the paths 129searches for class files in a ``classes`` subdirectory under the paths
130in ``BBPATH`` in the same way as configuration files. 130in ``BBPATH`` in the same way as configuration files.
131 131
@@ -157,7 +157,7 @@ Locating and Parsing Recipes
157============================ 157============================
158 158
159During the configuration phase, BitBake will have set 159During the configuration phase, BitBake will have set
160```BBFILES`` <#var-bb-BBFILES>`__. BitBake now uses it to construct a 160:term:`BBFILES`. BitBake now uses it to construct a
161list of recipes to parse, along with any append files (``.bbappend``) to 161list of recipes to parse, along with any append files (``.bbappend``) to
162apply. ``BBFILES`` is a space-separated list of available files and 162apply. ``BBFILES`` is a space-separated list of available files and
163supports wildcards. An example would be: BBFILES = 163supports wildcards. An example would be: BBFILES =
@@ -174,13 +174,13 @@ various variables into the datastore.
174For each file, a fresh copy of the base configuration is made, then the 174For each file, a fresh copy of the base configuration is made, then the
175recipe is parsed line by line. Any inherit statements cause BitBake to 175recipe is parsed line by line. Any inherit statements cause BitBake to
176find and then parse class files (``.bbclass``) using 176find and then parse class files (``.bbclass``) using
177```BBPATH`` <#var-bb-BBPATH>`__ as the search path. Finally, BitBake 177:term:`BBPATH` as the search path. Finally, BitBake
178parses in order any append files found in ``BBFILES``. 178parses in order any append files found in ``BBFILES``.
179 179
180One common convention is to use the recipe filename to define pieces of 180One common convention is to use the recipe filename to define pieces of
181metadata. For example, in ``bitbake.conf`` the recipe name and version 181metadata. For example, in ``bitbake.conf`` the recipe name and version
182are used to set the variables ```PN`` <#var-bb-PN>`__ and 182are used to set the variables :term:`PN` and
183```PV`` <#var-bb-PV>`__: PN = 183:term:`PV`: PN =
184"${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] or 184"${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] or
185'defaultpkgname'}" PV = 185'defaultpkgname'}" PV =
186"${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[1] or 186"${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[1] or
@@ -201,7 +201,7 @@ and then reload it.
201Where possible, subsequent BitBake commands reuse this cache of recipe 201Where possible, subsequent BitBake commands reuse this cache of recipe
202information. The validity of this cache is determined by first computing 202information. The validity of this cache is determined by first computing
203a checksum of the base configuration data (see 203a checksum of the base configuration data (see
204```BB_HASHCONFIG_WHITELIST`` <#var-bb-BB_HASHCONFIG_WHITELIST>`__) and 204:term:`BB_HASHCONFIG_WHITELIST`) and
205then checking if the checksum matches. If that checksum matches what is 205then checking if the checksum matches. If that checksum matches what is
206in the cache and the recipe and class files have not changed, BitBake is 206in the cache and the recipe and class files have not changed, BitBake is
207able to use the cache. BitBake then reloads the cached information about 207able to use the cache. BitBake then reloads the cached information about
@@ -233,8 +233,8 @@ the recipe files have been parsed, BitBake starts to figure out how to
233build the target. BitBake looks through the ``PROVIDES`` list for each 233build the target. BitBake looks through the ``PROVIDES`` list for each
234of the recipes. A ``PROVIDES`` list is the list of names by which the 234of the recipes. A ``PROVIDES`` list is the list of names by which the
235recipe can be known. Each recipe's ``PROVIDES`` list is created 235recipe can be known. Each recipe's ``PROVIDES`` list is created
236implicitly through the recipe's ```PN`` <#var-bb-PN>`__ variable and 236implicitly through the recipe's :term:`PN` variable and
237explicitly through the recipe's ```PROVIDES`` <#var-bb-PROVIDES>`__ 237explicitly through the recipe's :term:`PROVIDES`
238variable, which is optional. 238variable, which is optional.
239 239
240When a recipe uses ``PROVIDES``, that recipe's functionality can be 240When a recipe uses ``PROVIDES``, that recipe's functionality can be
@@ -259,7 +259,7 @@ A common example in which a target has multiple providers is
259recipe. Each machine often selects the best kernel provider by using a 259recipe. Each machine often selects the best kernel provider by using a
260line similar to the following in the machine configuration file: 260line similar to the following in the machine configuration file:
261PREFERRED_PROVIDER_virtual/kernel = "linux-yocto" The default 261PREFERRED_PROVIDER_virtual/kernel = "linux-yocto" The default
262```PREFERRED_PROVIDER`` <#var-bb-PREFERRED_PROVIDER>`__ is the provider 262:term:`PREFERRED_PROVIDER` is the provider
263with the same name as the target. BitBake iterates through each target 263with the same name as the target. BitBake iterates through each target
264it needs to build and resolves them and their dependencies using this 264it needs to build and resolves them and their dependencies using this
265process. 265process.
@@ -268,9 +268,9 @@ Understanding how providers are chosen is made complicated by the fact
268that multiple versions might exist for a given provider. BitBake 268that multiple versions might exist for a given provider. BitBake
269defaults to the highest version of a provider. Version comparisons are 269defaults to the highest version of a provider. Version comparisons are
270made using the same method as Debian. You can use the 270made using the same method as Debian. You can use the
271```PREFERRED_VERSION`` <#var-bb-PREFERRED_VERSION>`__ variable to 271:term:`PREFERRED_VERSION` variable to
272specify a particular version. You can influence the order by using the 272specify a particular version. You can influence the order by using the
273```DEFAULT_PREFERENCE`` <#var-bb-DEFAULT_PREFERENCE>`__ variable. 273:term:`DEFAULT_PREFERENCE` variable.
274 274
275By default, files have a preference of "0". Setting 275By default, files have a preference of "0". Setting
276``DEFAULT_PREFERENCE`` to "-1" makes the recipe unlikely to be used 276``DEFAULT_PREFERENCE`` to "-1" makes the recipe unlikely to be used
@@ -283,15 +283,15 @@ undergone sufficient testing to be considered stable.
283When there are multiple “versions” of a given recipe, BitBake defaults 283When there are multiple “versions” of a given recipe, BitBake defaults
284to selecting the most recent version, unless otherwise specified. If the 284to selecting the most recent version, unless otherwise specified. If the
285recipe in question has a 285recipe in question has a
286```DEFAULT_PREFERENCE`` <#var-bb-DEFAULT_PREFERENCE>`__ set lower than 286:term:`DEFAULT_PREFERENCE` set lower than
287the other recipes (default is 0), then it will not be selected. This 287the other recipes (default is 0), then it will not be selected. This
288allows the person or persons maintaining the repository of recipe files 288allows the person or persons maintaining the repository of recipe files
289to specify their preference for the default selected version. 289to specify their preference for the default selected version.
290Additionally, the user can specify their preferred version. 290Additionally, the user can specify their preferred version.
291 291
292If the first recipe is named ``a_1.1.bb``, then the 292If the first recipe is named ``a_1.1.bb``, then the
293```PN`` <#var-bb-PN>`__ variable will be set to “a”, and the 293:term:`PN` variable will be set to “a”, and the
294```PV`` <#var-bb-PV>`__ variable will be set to 1.1. 294:term:`PV` variable will be set to 1.1.
295 295
296Thus, if a recipe named ``a_1.2.bb`` exists, BitBake will choose 1.2 by 296Thus, if a recipe named ``a_1.2.bb`` exists, BitBake will choose 1.2 by
297default. However, if you define the following variable in a ``.conf`` 297default. However, if you define the following variable in a ``.conf``
@@ -326,8 +326,8 @@ Dependencies are defined through several variables. You can find
326information about variables BitBake uses in the `Variables 326information about variables BitBake uses in the `Variables
327Glossary <#ref-bb-variables-glos>`__ near the end of this manual. At a 327Glossary <#ref-bb-variables-glos>`__ near the end of this manual. At a
328basic level, it is sufficient to know that BitBake uses the 328basic level, it is sufficient to know that BitBake uses the
329```DEPENDS`` <#var-bb-DEPENDS>`__ and 329:term:`DEPENDS` and
330```RDEPENDS`` <#var-bb-RDEPENDS>`__ variables when calculating 330:term:`RDEPENDS` variables when calculating
331dependencies. 331dependencies.
332 332
333For more information on how BitBake handles dependencies, see the 333For more information on how BitBake handles dependencies, see the
@@ -345,7 +345,7 @@ section has more information on how BitBake chooses which task to
345execute next. 345execute next.
346 346
347The build now starts with BitBake forking off threads up to the limit 347The build now starts with BitBake forking off threads up to the limit
348set in the ```BB_NUMBER_THREADS`` <#var-bb-BB_NUMBER_THREADS>`__ 348set in the :term:`BB_NUMBER_THREADS`
349variable. BitBake continues to fork threads as long as there are tasks 349variable. BitBake continues to fork threads as long as there are tasks
350ready to run, those tasks have all their dependencies met, and the 350ready to run, those tasks have all their dependencies met, and the
351thread threshold has not been exceeded. 351thread threshold has not been exceeded.
@@ -354,7 +354,7 @@ It is worth noting that you can greatly speed up the build time by
354properly setting the ``BB_NUMBER_THREADS`` variable. 354properly setting the ``BB_NUMBER_THREADS`` variable.
355 355
356As each task completes, a timestamp is written to the directory 356As each task completes, a timestamp is written to the directory
357specified by the ```STAMP`` <#var-bb-STAMP>`__ variable. On subsequent 357specified by the :term:`STAMP` variable. On subsequent
358runs, BitBake looks in the build directory within ``tmp/stamps`` and 358runs, BitBake looks in the build directory within ``tmp/stamps`` and
359does not rerun tasks that are already completed unless a timestamp is 359does not rerun tasks that are already completed unless a timestamp is
360found to be invalid. Currently, invalid timestamps are only considered 360found to be invalid. Currently, invalid timestamps are only considered
@@ -386,7 +386,7 @@ Executing Tasks
386 386
387Tasks can be either a shell task or a Python task. For shell tasks, 387Tasks can be either a shell task or a Python task. For shell tasks,
388BitBake writes a shell script to 388BitBake writes a shell script to
389``${``\ ```T`` <#var-bb-T>`__\ ``}/run.do_taskname.pid`` and then 389``${``\ :term:`T`\ ``}/run.do_taskname.pid`` and then
390executes the script. The generated shell script contains all the 390executes the script. The generated shell script contains all the
391exported variables, and the shell functions with all variables expanded. 391exported variables, and the shell functions with all variables expanded.
392Output from the shell script goes to the file 392Output from the shell script goes to the file
@@ -404,9 +404,9 @@ scheduler. It is possible to configure the scheduler and define custom
404implementations for specific use cases. For more information, see these 404implementations for specific use cases. For more information, see these
405variables that control the behavior: 405variables that control the behavior:
406 406
407- ```BB_SCHEDULER`` <#var-bb-BB_SCHEDULER>`__ 407- :term:`BB_SCHEDULER`
408 408
409- ```BB_SCHEDULERS`` <#var-bb-BB_SCHEDULERS>`__ 409- :term:`BB_SCHEDULERS`
410 410
411It is possible to have functions run before and after a task's main 411It is possible to have functions run before and after a task's main
412function. This is done using the ``[prefuncs]`` and ``[postfuncs]`` 412function. This is done using the ``[prefuncs]`` and ``[postfuncs]``
@@ -432,7 +432,7 @@ changes because it should not affect the output for target packages. The
432simplistic approach for excluding the working directory is to set it to 432simplistic approach for excluding the working directory is to set it to
433some fixed value and create the checksum for the "run" script. BitBake 433some fixed value and create the checksum for the "run" script. BitBake
434goes one step better and uses the 434goes one step better and uses the
435```BB_HASHBASE_WHITELIST`` <#var-bb-BB_HASHBASE_WHITELIST>`__ variable 435:term:`BB_HASHBASE_WHITELIST` variable
436to define a list of variables that should never be included when 436to define a list of variables that should never be included when
437generating the signatures. 437generating the signatures.
438 438
@@ -508,7 +508,7 @@ behavior is unchanged from previous versions. ``OE-Core`` uses the
508version but adds the task hash to the stamp files. This results in any 508version but adds the task hash to the stamp files. This results in any
509metadata change that changes the task hash, automatically causing the 509metadata change that changes the task hash, automatically causing the
510task to be run again. This removes the need to bump 510task to be run again. This removes the need to bump
511```PR`` <#var-bb-PR>`__ values, and changes to metadata automatically 511:term:`PR` values, and changes to metadata automatically
512ripple across the build. 512ripple across the build.
513 513
514It is also worth noting that the end result of these signature 514It is also worth noting that the end result of these signature
@@ -570,7 +570,7 @@ information is available, BitBake uses this information instead of
570running the main tasks. 570running the main tasks.
571 571
572BitBake first calls the function defined by the 572BitBake first calls the function defined by the
573```BB_HASHCHECK_FUNCTION`` <#var-bb-BB_HASHCHECK_FUNCTION>`__ variable 573:term:`BB_HASHCHECK_FUNCTION` variable
574with a list of tasks and corresponding hashes it wants to build. This 574with a list of tasks and corresponding hashes it wants to build. This
575function is designed to be fast and returns a list of the tasks for 575function is designed to be fast and returns a list of the tasks for
576which it believes in can obtain artifacts. 576which it believes in can obtain artifacts.
@@ -586,13 +586,13 @@ or failure.
586As previously mentioned, an artifact can cover more than one task. For 586As previously mentioned, an artifact can cover more than one task. For
587example, it is pointless to obtain a compiler if you already have the 587example, it is pointless to obtain a compiler if you already have the
588compiled binary. To handle this, BitBake calls the 588compiled binary. To handle this, BitBake calls the
589```BB_SETSCENE_DEPVALID`` <#var-bb-BB_SETSCENE_DEPVALID>`__ function for 589:term:`BB_SETSCENE_DEPVALID` function for
590each successful setscene task to know whether or not it needs to obtain 590each successful setscene task to know whether or not it needs to obtain
591the dependencies of that task. 591the dependencies of that task.
592 592
593Finally, after all the setscene tasks have executed, BitBake calls the 593Finally, after all the setscene tasks have executed, BitBake calls the
594function listed in 594function listed in
595```BB_SETSCENE_VERIFY_FUNCTION2`` <#var-bb-BB_SETSCENE_VERIFY_FUNCTION2>`__ 595:term:`BB_SETSCENE_VERIFY_FUNCTION2`
596with the list of tasks BitBake thinks has been "covered". The metadata 596with the list of tasks BitBake thinks has been "covered". The metadata
597can then ensure that this list is correct and can inform BitBake that it 597can then ensure that this list is correct and can inform BitBake that it
598wants specific tasks to be run regardless of the setscene result. 598wants specific tasks to be run regardless of the setscene result.
@@ -607,7 +607,7 @@ In addition to the standard command line option to control how verbose
607builds are when execute, bitbake also supports user defined 607builds are when execute, bitbake also supports user defined
608configuration of the `Python 608configuration of the `Python
609logging <https://docs.python.org/3/library/logging.html>`__ facilities 609logging <https://docs.python.org/3/library/logging.html>`__ facilities
610through the ```BB_LOGCONFIG`` <#var-bb-BB_LOGCONFIG>`__ variable. This 610through the :term:`BB_LOGCONFIG` variable. This
611variable defines a json or yaml `logging 611variable defines a json or yaml `logging
612configuration <https://docs.python.org/3/library/logging.config.html>`__ 612configuration <https://docs.python.org/3/library/logging.config.html>`__
613that will be intelligently merged into the default configuration. The 613that will be intelligently merged into the default configuration. The
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
index 4285a73afe..20451738a6 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-fetching.rst
@@ -26,7 +26,7 @@ The code to execute the first part of this process, a fetch, looks
26something like the following: src_uri = (d.getVar('SRC_URI') or 26something like the following: src_uri = (d.getVar('SRC_URI') or
27"").split() fetcher = bb.fetch2.Fetch(src_uri, d) fetcher.download() 27"").split() fetcher = bb.fetch2.Fetch(src_uri, d) fetcher.download()
28This code sets up an instance of the fetch class. The instance uses a 28This code sets up an instance of the fetch class. The instance uses a
29space-separated list of URLs from the ```SRC_URI`` <#var-bb-SRC_URI>`__ 29space-separated list of URLs from the :term:`SRC_URI`
30variable and then calls the ``download`` method to download the files. 30variable and then calls the ``download`` method to download the files.
31 31
32The instantiation of the fetch class is usually followed by: rootdir = 32The instantiation of the fetch class is usually followed by: rootdir =
@@ -51,13 +51,13 @@ URLs by looking for source files in a specific search order:
51 51
52- *Pre-mirror Sites:* BitBake first uses pre-mirrors to try and find 52- *Pre-mirror Sites:* BitBake first uses pre-mirrors to try and find
53 source files. These locations are defined using the 53 source files. These locations are defined using the
54 ```PREMIRRORS`` <#var-bb-PREMIRRORS>`__ variable. 54 :term:`PREMIRRORS` variable.
55 55
56- *Source URI:* If pre-mirrors fail, BitBake uses the original URL (e.g 56- *Source URI:* If pre-mirrors fail, BitBake uses the original URL (e.g
57 from ``SRC_URI``). 57 from ``SRC_URI``).
58 58
59- *Mirror Sites:* If fetch failures occur, BitBake next uses mirror 59- *Mirror Sites:* If fetch failures occur, BitBake next uses mirror
60 locations as defined by the ```MIRRORS`` <#var-bb-MIRRORS>`__ 60 locations as defined by the :term:`MIRRORS`
61 variable. 61 variable.
62 62
63For each URL passed to the fetcher, the fetcher calls the submodule that 63For each URL passed to the fetcher, the fetcher calls the submodule that
@@ -88,7 +88,7 @@ previous example does.
88Since network accesses are slow, BitBake maintains a cache of files 88Since network accesses are slow, BitBake maintains a cache of files
89downloaded from the network. Any source files that are not local (i.e. 89downloaded from the network. Any source files that are not local (i.e.
90downloaded from the Internet) are placed into the download directory, 90downloaded from the Internet) are placed into the download directory,
91which is specified by the ```DL_DIR`` <#var-bb-DL_DIR>`__ variable. 91which is specified by the :term:`DL_DIR` variable.
92 92
93File integrity is of key importance for reproducing builds. For 93File integrity is of key importance for reproducing builds. For
94non-local archive downloads, the fetcher code can verify SHA-256 and MD5 94non-local archive downloads, the fetcher code can verify SHA-256 and MD5
@@ -112,9 +112,9 @@ comparing a checksum for the file again.
112 It is assumed that local storage is safe from data corruption. If 112 It is assumed that local storage is safe from data corruption. If
113 this were not the case, there would be bigger issues to worry about. 113 this were not the case, there would be bigger issues to worry about.
114 114
115If ```BB_STRICT_CHECKSUM`` <#var-bb-BB_STRICT_CHECKSUM>`__ is set, any 115If :term:`BB_STRICT_CHECKSUM` is set, any
116download without a checksum triggers an error message. The 116download without a checksum triggers an error message. The
117```BB_NO_NETWORK`` <#var-bb-BB_NO_NETWORK>`__ variable can be used to 117:term:`BB_NO_NETWORK` variable can be used to
118make any attempted network access a fatal error, which is useful for 118make any attempted network access a fatal error, which is useful for
119checking that mirrors are complete as well as other things. 119checking that mirrors are complete as well as other things.
120 120
@@ -170,9 +170,9 @@ Local file fetcher (``file://``)
170This submodule handles URLs that begin with ``file://``. The filename 170This submodule handles URLs that begin with ``file://``. The filename
171you specify within the URL can be either an absolute or relative path to 171you specify within the URL can be either an absolute or relative path to
172a file. If the filename is relative, the contents of the 172a file. If the filename is relative, the contents of the
173```FILESPATH`` <#var-bb-FILESPATH>`__ variable is used in the same way 173:term:`FILESPATH` variable is used in the same way
174``PATH`` is used to find executables. If the file cannot be found, it is 174``PATH`` is used to find executables. If the file cannot be found, it is
175assumed that it is available in ```DL_DIR`` <#var-bb-DL_DIR>`__ by the 175assumed that it is available in :term:`DL_DIR` by the
176time the ``download()`` method is called. 176time the ``download()`` method is called.
177 177
178If you specify a directory, the entire directory is unpacked. 178If you specify a directory, the entire directory is unpacked.
@@ -194,7 +194,7 @@ The executable and parameters used are specified by the
194fetcher supports a parameter "downloadfilename" that allows the name of 194fetcher supports a parameter "downloadfilename" that allows the name of
195the downloaded file to be specified. Specifying the name of the 195the downloaded file to be specified. Specifying the name of the
196downloaded file is useful for avoiding collisions in 196downloaded file is useful for avoiding collisions in
197```DL_DIR`` <#var-bb-DL_DIR>`__ when dealing with multiple files that 197:term:`DL_DIR` when dealing with multiple files that
198have the same name. 198have the same name.
199 199
200Some example URLs are as follows: SRC_URI = 200Some example URLs are as follows: SRC_URI =
@@ -243,7 +243,7 @@ system. You can configure it using a number of different variables:
243 special value of "now" causes the checkout to be updated on every 243 special value of "now" causes the checkout to be updated on every
244 build. 244 build.
245 245
246- ```CVSDIR`` <#var-bb-CVSDIR>`__\ *:* Specifies where a temporary 246- :term:`CVSDIR`\ *:* Specifies where a temporary
247 checkout is saved. The location is often ``DL_DIR/cvs``. 247 checkout is saved. The location is often ``DL_DIR/cvs``.
248 248
249- *``CVS_PROXY_HOST``:* The name to use as a "proxy=" parameter to the 249- *``CVS_PROXY_HOST``:* The name to use as a "proxy=" parameter to the
@@ -269,14 +269,14 @@ The supported parameters are as follows:
269 default, the TAG is empty. 269 default, the TAG is empty.
270 270
271- *"date":* Specifies a date. If no "date" is specified, the 271- *"date":* Specifies a date. If no "date" is specified, the
272 ```SRCDATE`` <#var-bb-SRCDATE>`__ of the configuration is used to 272 :term:`SRCDATE` of the configuration is used to
273 checkout a specific date. The special value of "now" causes the 273 checkout a specific date. The special value of "now" causes the
274 checkout to be updated on every build. 274 checkout to be updated on every build.
275 275
276- *"localdir":* Used to rename the module. Effectively, you are 276- *"localdir":* Used to rename the module. Effectively, you are
277 renaming the output directory to which the module is unpacked. You 277 renaming the output directory to which the module is unpacked. You
278 are forcing the module into a special directory relative to 278 are forcing the module into a special directory relative to
279 ```CVSDIR`` <#var-bb-CVSDIR>`__. 279 :term:`CVSDIR`.
280 280
281- *"rsh"* Used in conjunction with the "method" parameter. 281- *"rsh"* Used in conjunction with the "method" parameter.
282 282
@@ -304,7 +304,7 @@ Subversion (SVN) Fetcher (``svn://``)
304This fetcher submodule fetches code from the Subversion source control 304This fetcher submodule fetches code from the Subversion source control
305system. The executable used is specified by ``FETCHCMD_svn``, which 305system. The executable used is specified by ``FETCHCMD_svn``, which
306defaults to "svn". The fetcher's temporary working directory is set by 306defaults to "svn". The fetcher's temporary working directory is set by
307```SVNDIR`` <#var-bb-SVNDIR>`__, which is usually ``DL_DIR/svn``. 307:term:`SVNDIR`, which is usually ``DL_DIR/svn``.
308 308
309The supported parameters are as follows: 309The supported parameters are as follows:
310 310
@@ -345,7 +345,7 @@ Git Fetcher (``git://``)
345 345
346This fetcher submodule fetches code from the Git source control system. 346This fetcher submodule fetches code from the Git source control system.
347The fetcher works by creating a bare clone of the remote into 347The fetcher works by creating a bare clone of the remote into
348```GITDIR`` <#var-bb-GITDIR>`__, which is usually ``DL_DIR/git2``. This 348:term:`GITDIR`, which is usually ``DL_DIR/git2``. This
349bare clone is then cloned into the work directory during the unpack 349bare clone is then cloned into the work directory during the unpack
350stage when a specific tree is checked out. This is done using alternates 350stage when a specific tree is checked out. This is done using alternates
351and by reference to minimize the amount of duplicate data on the disk 351and by reference to minimize the amount of duplicate data on the disk
@@ -416,7 +416,7 @@ Git Submodule Fetcher (``gitsm://``)
416 416
417This fetcher submodule inherits from the `Git fetcher <#git-fetcher>`__ 417This fetcher submodule inherits from the `Git fetcher <#git-fetcher>`__
418and extends that fetcher's behavior by fetching a repository's 418and extends that fetcher's behavior by fetching a repository's
419submodules. ```SRC_URI`` <#var-bb-SRC_URI>`__ is passed to the Git 419submodules. :term:`SRC_URI` is passed to the Git
420fetcher as described in the "`Git Fetcher 420fetcher as described in the "`Git Fetcher
421(``git://``) <#git-fetcher>`__" section. 421(``git://``) <#git-fetcher>`__" section.
422 422
@@ -441,8 +441,8 @@ This fetcher submodule fetches code from a
441repository. 441repository.
442 442
443To use this fetcher, make sure your recipe has proper 443To use this fetcher, make sure your recipe has proper
444```SRC_URI`` <#var-bb-SRC_URI>`__, ```SRCREV`` <#var-bb-SRCREV>`__, and 444:term:`SRC_URI`, :term:`SRCREV`, and
445```PV`` <#var-bb-PV>`__ settings. Here is an example: SRC_URI = 445:term:`PV` settings. Here is an example: SRC_URI =
446"ccrc://cc.example.org/ccrc;vob=/example_vob;module=/example_module" 446"ccrc://cc.example.org/ccrc;vob=/example_vob;module=/example_module"
447SRCREV = "EXAMPLE_CLEARCASE_TAG" PV = "${@d.getVar("SRCREV", 447SRCREV = "EXAMPLE_CLEARCASE_TAG" PV = "${@d.getVar("SRCREV",
448False).replace("/", "+")}" The fetcher uses the ``rcleartool`` or 448False).replace("/", "+")}" The fetcher uses the ``rcleartool`` or
@@ -510,15 +510,15 @@ This fetcher submodule fetches code from the
510`Perforce <https://www.perforce.com/>`__ source control system. The 510`Perforce <https://www.perforce.com/>`__ source control system. The
511executable used is specified by ``FETCHCMD_p4``, which defaults to "p4". 511executable used is specified by ``FETCHCMD_p4``, which defaults to "p4".
512The fetcher's temporary working directory is set by 512The fetcher's temporary working directory is set by
513```P4DIR`` <#var-bb-P4DIR>`__, which defaults to "DL_DIR/p4". 513:term:`P4DIR`, which defaults to "DL_DIR/p4".
514The fetcher does not make use of a perforce client, instead it 514The fetcher does not make use of a perforce client, instead it
515relies on ``p4 files`` to retrieve a list of 515relies on ``p4 files`` to retrieve a list of
516files and ``p4 print`` to transfer the content 516files and ``p4 print`` to transfer the content
517of those files locally. 517of those files locally.
518 518
519To use this fetcher, make sure your recipe has proper 519To use this fetcher, make sure your recipe has proper
520```SRC_URI`` <#var-bb-SRC_URI>`__, ```SRCREV`` <#var-bb-SRCREV>`__, and 520:term:`SRC_URI`, :term:`SRCREV`, and
521```PV`` <#var-bb-PV>`__ values. The p4 executable is able to use the 521:term:`PV` values. The p4 executable is able to use the
522config file defined by your system's ``P4CONFIG`` environment variable 522config file defined by your system's ``P4CONFIG`` environment variable
523in order to define the Perforce server URL and port, username, and 523in order to define the Perforce server URL and port, username, and
524password if you do not wish to keep those values in a recipe itself. If 524password if you do not wish to keep those values in a recipe itself. If
@@ -584,8 +584,8 @@ Repo Fetcher (``repo://``)
584 584
585This fetcher submodule fetches code from ``google-repo`` source control 585This fetcher submodule fetches code from ``google-repo`` source control
586system. The fetcher works by initiating and syncing sources of the 586system. The fetcher works by initiating and syncing sources of the
587repository into ```REPODIR`` <#var-bb-REPODIR>`__, which is usually 587repository into :term:`REPODIR`, which is usually
588```DL_DIR`` <#var-bb-DL_DIR>`__\ ``/repo``. 588:term:`DL_DIR`\ ``/repo``.
589 589
590This fetcher supports the following parameters: 590This fetcher supports the following parameters:
591 591
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
index 174c797ae1..32d5b7bbcc 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst
@@ -73,7 +73,7 @@ While every attempt is made to explain what is happening during the
73example, the descriptions cannot cover everything. You can find further 73example, the descriptions cannot cover everything. You can find further
74information throughout this manual. Also, you can actively participate 74information throughout this manual. Also, you can actively participate
75in the 75in the
76` <http://lists.openembedded.org/mailman/listinfo/bitbake-devel>`__ 76http://lists.openembedded.org/mailman/listinfo/bitbake-devel
77discussion mailing list about the BitBake build tool. 77discussion mailing list about the BitBake build tool.
78 78
79.. note:: 79.. note::
@@ -120,7 +120,7 @@ Following is the complete "Hello World" example.
120 ``conf/bblayers.conf`` file is relevant. 120 ``conf/bblayers.conf`` file is relevant.
121 121
122 When you run BitBake, it begins looking for metadata files. The 122 When you run BitBake, it begins looking for metadata files. The
123 ```BBPATH`` <#var-bb-BBPATH>`__ variable is what tells BitBake where 123 :term:`BBPATH` variable is what tells BitBake where
124 to look for those files. ``BBPATH`` is not set and you need to set 124 to look for those files. ``BBPATH`` is not set and you need to set
125 it. Without ``BBPATH``, BitBake cannot find any configuration files 125 it. Without ``BBPATH``, BitBake cannot find any configuration files
126 (``.conf``) or recipe files (``.bb``) at all. BitBake also cannot 126 (``.conf``) or recipe files (``.bb``) at all. BitBake also cannot
@@ -168,17 +168,17 @@ Following is the complete "Hello World" example.
168 recipe files. For this example, you need to create the file in your 168 recipe files. For this example, you need to create the file in your
169 project directory and define some key BitBake variables. For more 169 project directory and define some key BitBake variables. For more
170 information on the ``bitbake.conf`` file, see 170 information on the ``bitbake.conf`` file, see
171 ` <http://git.openembedded.org/bitbake/tree/conf/bitbake.conf>`__. 171 http://git.openembedded.org/bitbake/tree/conf/bitbake.conf.
172 172
173 Use the following commands to create the ``conf`` directory in the 173 Use the following commands to create the ``conf`` directory in the
174 project directory: $ mkdir conf From within the ``conf`` directory, 174 project directory: $ mkdir conf From within the ``conf`` directory,
175 use some editor to create the ``bitbake.conf`` so that it contains 175 use some editor to create the ``bitbake.conf`` so that it contains
176 the following: `PN <#var-bb-PN>`__ = 176 the following: :term:`PN` =
177 "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0] 177 "${@bb.parse.BBHandler.vars_from_file(d.getVar('FILE', False),d)[0]
178 or 'defaultpkgname'}" TMPDIR = "${`TOPDIR <#var-bb-TOPDIR>`__}/tmp" 178 or 'defaultpkgname'}" TMPDIR = "${:term:`TOPDIR`}/tmp"
179 `CACHE <#var-bb-CACHE>`__ = "${TMPDIR}/cache" 179 :term:`CACHE` = "${TMPDIR}/cache"
180 `STAMP <#var-bb-STAMP>`__ = "${TMPDIR}/${PN}/stamps" 180 :term:`STAMP` = "${TMPDIR}/${PN}/stamps"
181 `T <#var-bb-T>`__ = "${TMPDIR}/${PN}/work" `B <#var-bb-B>`__ = 181 :term:`T` = "${TMPDIR}/${PN}/work" :term:`B` =
182 "${TMPDIR}/${PN}" 182 "${TMPDIR}/${PN}"
183 183
184 .. note:: 184 .. note::
@@ -287,9 +287,9 @@ Following is the complete "Hello World" example.
287 and the ``conf`` directory: $ cd $HOME $ mkdir mylayer $ cd mylayer 287 and the ``conf`` directory: $ cd $HOME $ mkdir mylayer $ cd mylayer
288 $ mkdir conf Move to the ``conf`` directory and create a 288 $ mkdir conf Move to the ``conf`` directory and create a
289 ``layer.conf`` file that has the following: BBPATH .= 289 ``layer.conf`` file that has the following: BBPATH .=
290 ":${`LAYERDIR <#var-bb-LAYERDIR>`__}" `BBFILES <#var-bb-BBFILES>`__ 290 ":${:term:`LAYERDIR`}" :term:`BBFILES`
291 += "${LAYERDIR}/*.bb" 291 += "${LAYERDIR}/*.bb"
292 `BBFILE_COLLECTIONS <#var-bb-BBFILE_COLLECTIONS>`__ += "mylayer" 292 :term:`BBFILE_COLLECTIONS` += "mylayer"
293 `BBFILE_PATTERN_mylayer <#var-bb-BBFILE_PATTERN>`__ := 293 `BBFILE_PATTERN_mylayer <#var-bb-BBFILE_PATTERN>`__ :=
294 "^${LAYERDIR_RE}/" For information on these variables, click the 294 "^${LAYERDIR_RE}/" For information on these variables, click the
295 links to go to the definitions in the glossary. 295 links to go to the definitions in the glossary.
@@ -297,8 +297,8 @@ Following is the complete "Hello World" example.
297 You need to create the recipe file next. Inside your layer at the 297 You need to create the recipe file next. Inside your layer at the
298 top-level, use an editor and create a recipe file named 298 top-level, use an editor and create a recipe file named
299 ``printhello.bb`` that has the following: 299 ``printhello.bb`` that has the following:
300 `DESCRIPTION <#var-bb-DESCRIPTION>`__ = "Prints Hello World" 300 :term:`DESCRIPTION` = "Prints Hello World"
301 `PN <#var-bb-PN>`__ = 'printhello' `PV <#var-bb-PV>`__ = '1' python 301 :term:`PN` = 'printhello' :term:`PV` = '1' python
302 do_build() { bb.plain("********************"); bb.plain("\* \*"); 302 do_build() { bb.plain("********************"); bb.plain("\* \*");
303 bb.plain("\* Hello, World! \*"); bb.plain("\* \*"); 303 bb.plain("\* Hello, World! \*"); bb.plain("\* \*");
304 bb.plain("********************"); } The recipe file simply provides 304 bb.plain("********************"); } The recipe file simply provides
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
index 3c24e4e2cc..f040d81346 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-intro.rst
@@ -513,7 +513,7 @@ the builds.
513Aside from separate configuration files for each target, you must also 513Aside from separate configuration files for each target, you must also
514enable BitBake to perform multiple configuration builds. Enabling is 514enable BitBake to perform multiple configuration builds. Enabling is
515accomplished by setting the 515accomplished by setting the
516```BBMULTICONFIG`` <#var-bb-BBMULTICONFIG>`__ variable in the 516:term:`BBMULTICONFIG` variable in the
517``local.conf`` configuration file. As an example, suppose you had 517``local.conf`` configuration file. As an example, suppose you had
518configuration files for ``target1`` and ``target2`` defined in the build 518configuration files for ``target1`` and ``target2`` defined in the build
519directory. The following statement in the ``local.conf`` file both 519directory. The following statement in the ``local.conf`` file both
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
index 790065ef64..cea8d5ba25 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -397,7 +397,7 @@ Among the variables commonly exported to the environment are ``CC`` and
397Conditional Syntax (Overrides) 397Conditional Syntax (Overrides)
398============================== 398==============================
399 399
400BitBake uses ```OVERRIDES`` <#var-bb-OVERRIDES>`__ to control what 400BitBake uses :term:`OVERRIDES` to control what
401variables are overridden after BitBake parses recipes and configuration 401variables are overridden after BitBake parses recipes and configuration
402files. This section describes how you can use ``OVERRIDES`` as 402files. This section describes how you can use ``OVERRIDES`` as
403conditional metadata, talks about key expansion in relationship to 403conditional metadata, talks about key expansion in relationship to
@@ -463,7 +463,7 @@ variable.
463 463
464 Internally, this is implemented by prepending the task (e.g. 464 Internally, this is implemented by prepending the task (e.g.
465 "task-compile:") to the value of 465 "task-compile:") to the value of
466 ```OVERRIDES`` <#var-bb-OVERRIDES>`__ for the local datastore of the 466 :term:`OVERRIDES` for the local datastore of the
467 ``do_compile`` task. 467 ``do_compile`` task.
468 468
469 You can also use this syntax with other combinations (e.g. 469 You can also use this syntax with other combinations (e.g.
@@ -549,7 +549,7 @@ directives.
549Locating Include and Class Files 549Locating Include and Class Files
550-------------------------------- 550--------------------------------
551 551
552BitBake uses the ```BBPATH`` <#var-bb-BBPATH>`__ variable to locate 552BitBake uses the :term:`BBPATH` variable to locate
553needed include and class files. Additionally, BitBake searches the 553needed include and class files. Additionally, BitBake searches the
554current directory for ``include`` and ``require`` directives. 554current directory for ``include`` and ``require`` directives.
555 555
@@ -680,7 +680,7 @@ directive from within each recipe: require foo.inc
680----------------------------------- 680-----------------------------------
681 681
682When creating a configuration file (``.conf``), you can use the 682When creating a configuration file (``.conf``), you can use the
683```INHERIT`` <#var-bb-INHERIT>`__ configuration directive to inherit a 683:term:`INHERIT` configuration directive to inherit a
684class. BitBake only supports this directive when used within a 684class. BitBake only supports this directive when used within a
685configuration file. 685configuration file.
686 686
@@ -837,7 +837,7 @@ functions and regular Python functions defined with "def":
837 Python functions, but not on regular Python functions. 837 Python functions, but not on regular Python functions.
838 838
839- BitBake-style Python functions generate a separate 839- BitBake-style Python functions generate a separate
840 ``${``\ ```T`` <#var-bb-T>`__\ ``}/run.``\ function-name\ ``.``\ pid 840 ``${``\ :term:`T`\ ``}/run.``\ function-name\ ``.``\ pid
841 script that is executed to run the function, and also generate a log 841 script that is executed to run the function, and also generate a log
842 file in ``${T}/log.``\ function-name\ ``.``\ pid if they are executed 842 file in ``${T}/log.``\ function-name\ ``.``\ pid if they are executed
843 as tasks. 843 as tasks.
@@ -1090,8 +1090,8 @@ environment, you must take these two steps:
1090 1090
10911. Tell BitBake to load what you want from the environment into the 10911. Tell BitBake to load what you want from the environment into the
1092 datastore. You can do so through the 1092 datastore. You can do so through the
1093 ```BB_ENV_WHITELIST`` <#var-bb-BB_ENV_WHITELIST>`__ and 1093 :term:`BB_ENV_WHITELIST` and
1094 ```BB_ENV_EXTRAWHITE`` <#var-bb-BB_ENV_EXTRAWHITE>`__ variables. For 1094 :term:`BB_ENV_EXTRAWHITE` variables. For
1095 example, assume you want to prevent the build system from accessing 1095 example, assume you want to prevent the build system from accessing
1096 your ``$HOME/.ccache`` directory. The following command "whitelists" 1096 your ``$HOME/.ccache`` directory. The following command "whitelists"
1097 the environment variable ``CCACHE_DIR`` causing BitBake to allow that 1097 the environment variable ``CCACHE_DIR`` causing BitBake to allow that
@@ -1117,7 +1117,7 @@ environment, you must take these two steps:
1117Sometimes, it is useful to be able to obtain information from the 1117Sometimes, it is useful to be able to obtain information from the
1118original execution environment. BitBake saves a copy of the original 1118original execution environment. BitBake saves a copy of the original
1119environment into a special variable named 1119environment into a special variable named
1120```BB_ORIGENV`` <#var-bb-BB_ORIGENV>`__. 1120:term:`BB_ORIGENV`.
1121 1121
1122The ``BB_ORIGENV`` variable returns a datastore object that can be 1122The ``BB_ORIGENV`` variable returns a datastore object that can be
1123queried using the standard datastore operators such as 1123queried using the standard datastore operators such as
@@ -1149,12 +1149,12 @@ functionality of the task:
1149 recreated to empty them. 1149 recreated to empty them.
1150 1150
1151- *``[depends]``:* Controls inter-task dependencies. See the 1151- *``[depends]``:* Controls inter-task dependencies. See the
1152 ```DEPENDS`` <#var-bb-DEPENDS>`__ variable and the "`Inter-Task 1152 :term:`DEPENDS` variable and the "`Inter-Task
1153 Dependencies <#inter-task-dependencies>`__" section for more 1153 Dependencies <#inter-task-dependencies>`__" section for more
1154 information. 1154 information.
1155 1155
1156- *``[deptask]``:* Controls task build-time dependencies. See the 1156- *``[deptask]``:* Controls task build-time dependencies. See the
1157 ```DEPENDS`` <#var-bb-DEPENDS>`__ variable and the "`Build 1157 :term:`DEPENDS` variable and the "`Build
1158 Dependencies <#build-dependencies>`__" section for more information. 1158 Dependencies <#build-dependencies>`__" section for more information.
1159 1159
1160- *``[dirs]``:* Directories that should be created before the task 1160- *``[dirs]``:* Directories that should be created before the task
@@ -1189,7 +1189,7 @@ functionality of the task:
1189 your build host has a large number of cores but certain tasks need to 1189 your build host has a large number of cores but certain tasks need to
1190 be rate-limited due to various kinds of resource constraints (e.g. to 1190 be rate-limited due to various kinds of resource constraints (e.g. to
1191 avoid network throttling). ``number_threads`` works similarly to the 1191 avoid network throttling). ``number_threads`` works similarly to the
1192 ```BB_NUMBER_THREADS`` <#var-bb-BB_NUMBER_THREADS>`__ variable but is 1192 :term:`BB_NUMBER_THREADS` variable but is
1193 task-specific. 1193 task-specific.
1194 1194
1195 Set the value globally. For example, the following makes sure the 1195 Set the value globally. For example, the following makes sure the
@@ -1211,14 +1211,14 @@ functionality of the task:
1211- *``[prefuncs]``:* List of functions to call before the task executes. 1211- *``[prefuncs]``:* List of functions to call before the task executes.
1212 1212
1213- *``[rdepends]``:* Controls inter-task runtime dependencies. See the 1213- *``[rdepends]``:* Controls inter-task runtime dependencies. See the
1214 ```RDEPENDS`` <#var-bb-RDEPENDS>`__ variable, the 1214 :term:`RDEPENDS` variable, the
1215 ```RRECOMMENDS`` <#var-bb-RRECOMMENDS>`__ variable, and the 1215 :term:`RRECOMMENDS` variable, and the
1216 "`Inter-Task Dependencies <#inter-task-dependencies>`__" section for 1216 "`Inter-Task Dependencies <#inter-task-dependencies>`__" section for
1217 more information. 1217 more information.
1218 1218
1219- *``[rdeptask]``:* Controls task runtime dependencies. See the 1219- *``[rdeptask]``:* Controls task runtime dependencies. See the
1220 ```RDEPENDS`` <#var-bb-RDEPENDS>`__ variable, the 1220 :term:`RDEPENDS` variable, the
1221 ```RRECOMMENDS`` <#var-bb-RRECOMMENDS>`__ variable, and the "`Runtime 1221 :term:`RRECOMMENDS` variable, and the "`Runtime
1222 Dependencies <#runtime-dependencies>`__" section for more 1222 Dependencies <#runtime-dependencies>`__" section for more
1223 information. 1223 information.
1224 1224
@@ -1227,8 +1227,8 @@ functionality of the task:
1227 dependencies. 1227 dependencies.
1228 1228
1229- *``[recrdeptask]``:* Controls task recursive runtime dependencies. 1229- *``[recrdeptask]``:* Controls task recursive runtime dependencies.
1230 See the ```RDEPENDS`` <#var-bb-RDEPENDS>`__ variable, the 1230 See the :term:`RDEPENDS` variable, the
1231 ```RRECOMMENDS`` <#var-bb-RRECOMMENDS>`__ variable, and the 1231 :term:`RRECOMMENDS` variable, and the
1232 "`Recursive Dependencies <#recursive-dependencies>`__" section for 1232 "`Recursive Dependencies <#recursive-dependencies>`__" section for
1233 more information. 1233 more information.
1234 1234
@@ -1390,8 +1390,8 @@ Variants - Class Extension Mechanism
1390BitBake supports two features that facilitate creating from a single 1390BitBake supports two features that facilitate creating from a single
1391recipe file multiple incarnations of that recipe file where all 1391recipe file multiple incarnations of that recipe file where all
1392incarnations are buildable. These features are enabled through the 1392incarnations are buildable. These features are enabled through the
1393```BBCLASSEXTEND`` <#var-bb-BBCLASSEXTEND>`__ and 1393:term:`BBCLASSEXTEND` and
1394```BBVERSIONS`` <#var-bb-BBVERSIONS>`__ variables. 1394:term:`BBVERSIONS` variables.
1395 1395
1396.. note:: 1396.. note::
1397 1397
@@ -1420,7 +1420,7 @@ incarnations are buildable. These features are enabled through the
1420- *``BBVERSIONS``:* This variable allows a single recipe to build 1420- *``BBVERSIONS``:* This variable allows a single recipe to build
1421 multiple versions of a project from a single recipe file. You can 1421 multiple versions of a project from a single recipe file. You can
1422 also specify conditional metadata (using the 1422 also specify conditional metadata (using the
1423 ```OVERRIDES`` <#var-bb-OVERRIDES>`__ mechanism) for a single 1423 :term:`OVERRIDES` mechanism) for a single
1424 version, or an optionally named range of versions. Here is an 1424 version, or an optionally named range of versions. Here is an
1425 example: BBVERSIONS = "1.0 2.0 git" SRC_URI_git = 1425 example: BBVERSIONS = "1.0 2.0 git" SRC_URI_git =
1426 "git://someurl/somepath.git" BBVERSIONS = "1.0.[0-6]:1.0.0+ \\ 1426 "git://someurl/somepath.git" BBVERSIONS = "1.0.[0-6]:1.0.0+ \\
@@ -1432,7 +1432,7 @@ incarnations are buildable. These features are enabled through the
1432 name is not only placed into overrides, but it is also made available 1432 name is not only placed into overrides, but it is also made available
1433 for the metadata to use in the variable that defines the base recipe 1433 for the metadata to use in the variable that defines the base recipe
1434 versions for use in ``file://`` search paths 1434 versions for use in ``file://`` search paths
1435 (```FILESPATH`` <#var-bb-FILESPATH>`__). 1435 (:term:`FILESPATH`).
1436 1436
1437Dependencies 1437Dependencies
1438============ 1438============
@@ -1491,7 +1491,7 @@ task depends on the completion of the ``do_printdate`` task.
1491Build Dependencies 1491Build Dependencies
1492------------------ 1492------------------
1493 1493
1494BitBake uses the ```DEPENDS`` <#var-bb-DEPENDS>`__ variable to manage 1494BitBake uses the :term:`DEPENDS` variable to manage
1495build time dependencies. The ``[deptask]`` varflag for tasks signifies 1495build time dependencies. The ``[deptask]`` varflag for tasks signifies
1496the task of each item listed in ``DEPENDS`` that must complete before 1496the task of each item listed in ``DEPENDS`` that must complete before
1497that task can be executed. Here is an example: do_configure[deptask] = 1497that task can be executed. Here is an example: do_configure[deptask] =
@@ -1502,9 +1502,9 @@ execute.
1502Runtime Dependencies 1502Runtime Dependencies
1503-------------------- 1503--------------------
1504 1504
1505BitBake uses the ```PACKAGES`` <#var-bb-PACKAGES>`__, 1505BitBake uses the :term:`PACKAGES`,
1506```RDEPENDS`` <#var-bb-RDEPENDS>`__, and 1506:term:`RDEPENDS`, and
1507```RRECOMMENDS`` <#var-bb-RRECOMMENDS>`__ variables to manage runtime 1507:term:`RRECOMMENDS` variables to manage runtime
1508dependencies. 1508dependencies.
1509 1509
1510The ``PACKAGES`` variable lists runtime packages. Each of those packages 1510The ``PACKAGES`` variable lists runtime packages. Each of those packages
@@ -1670,7 +1670,7 @@ determine if a task needs to be run. This section describes the process.
1670To help understand how BitBake does this, the section assumes an 1670To help understand how BitBake does this, the section assumes an
1671OpenEmbedded metadata-based example. 1671OpenEmbedded metadata-based example.
1672 1672
1673These checksums are stored in ```STAMP`` <#var-bb-STAMP>`__. You can 1673These checksums are stored in :term:`STAMP`. You can
1674examine the checksums using the following BitBake command: $ 1674examine the checksums using the following BitBake command: $
1675bitbake-dumpsigs This command returns the signature data in a readable 1675bitbake-dumpsigs This command returns the signature data in a readable
1676format that allows you to examine the inputs used when the OpenEmbedded 1676format that allows you to examine the inputs used when the OpenEmbedded
@@ -1683,31 +1683,31 @@ Any changes to this variable would invalidate the stamp and cause the
1683 1683
1684The following list describes related variables: 1684The following list describes related variables:
1685 1685
1686- ```BB_HASHCHECK_FUNCTION`` <#var-bb-BB_HASHCHECK_FUNCTION>`__: 1686- :term:`BB_HASHCHECK_FUNCTION`:
1687 Specifies the name of the function to call during the "setscene" part 1687 Specifies the name of the function to call during the "setscene" part
1688 of the task's execution in order to validate the list of task hashes. 1688 of the task's execution in order to validate the list of task hashes.
1689 1689
1690- ```BB_SETSCENE_DEPVALID`` <#var-bb-BB_SETSCENE_DEPVALID>`__: 1690- :term:`BB_SETSCENE_DEPVALID`:
1691 Specifies a function BitBake calls that determines whether BitBake 1691 Specifies a function BitBake calls that determines whether BitBake
1692 requires a setscene dependency to be met. 1692 requires a setscene dependency to be met.
1693 1693
1694- ```BB_SETSCENE_VERIFY_FUNCTION2`` <#var-bb-BB_SETSCENE_VERIFY_FUNCTION2>`__: 1694- :term:`BB_SETSCENE_VERIFY_FUNCTION2`:
1695 Specifies a function to call that verifies the list of planned task 1695 Specifies a function to call that verifies the list of planned task
1696 execution before the main task execution happens. 1696 execution before the main task execution happens.
1697 1697
1698- ```BB_STAMP_POLICY`` <#var-bb-BB_STAMP_POLICY>`__: Defines the mode 1698- :term:`BB_STAMP_POLICY`: Defines the mode
1699 for comparing timestamps of stamp files. 1699 for comparing timestamps of stamp files.
1700 1700
1701- ```BB_STAMP_WHITELIST`` <#var-bb-BB_STAMP_WHITELIST>`__: Lists stamp 1701- :term:`BB_STAMP_WHITELIST`: Lists stamp
1702 files that are looked at when the stamp policy is "whitelist". 1702 files that are looked at when the stamp policy is "whitelist".
1703 1703
1704- ```BB_TASKHASH`` <#var-bb-BB_TASKHASH>`__: Within an executing task, 1704- :term:`BB_TASKHASH`: Within an executing task,
1705 this variable holds the hash of the task as returned by the currently 1705 this variable holds the hash of the task as returned by the currently
1706 enabled signature generator. 1706 enabled signature generator.
1707 1707
1708- ```STAMP`` <#var-bb-STAMP>`__: The base path to create stamp files. 1708- :term:`STAMP`: The base path to create stamp files.
1709 1709
1710- ```STAMPCLEAN`` <#var-bb-STAMPCLEAN>`__: Again, the base path to 1710- :term:`STAMPCLEAN`: Again, the base path to
1711 create stamp files but can use wildcards for matching a range of 1711 create stamp files but can use wildcards for matching a range of
1712 files for clean operations. 1712 files for clean operations.
1713 1713
@@ -1718,10 +1718,10 @@ Support for wildcard use in variables varies depending on the context in
1718which it is used. For example, some variables and file names allow 1718which it is used. For example, some variables and file names allow
1719limited use of wildcards through the "``%``" and "``*``" characters. 1719limited use of wildcards through the "``%``" and "``*``" characters.
1720Other variables or names support Python's 1720Other variables or names support Python's
1721```glob`` <https://docs.python.org/3/library/glob.html>`__ syntax, 1721```glob`https://docs.python.org/3/library/glob.html syntax,
1722```fnmatch`` <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__ 1722```fnmatch`https://docs.python.org/3/library/fnmatch.html#module-fnmatch
1723syntax, or 1723syntax, or
1724```Regular Expression (re)`` <https://docs.python.org/3/library/re.html#re>`__ 1724```Regular Expression (re)`https://docs.python.org/3/library/re.html#re
1725syntax. 1725syntax.
1726 1726
1727For variables that have wildcard suport, the documentation describes 1727For variables that have wildcard suport, the documentation describes
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 efc4960399..f81c01c064 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
@@ -26,7 +26,7 @@ overview of their function and contents.
26.. glossary:: 26.. glossary::
27 27
28 ASSUME_PROVIDED 28 ASSUME_PROVIDED
29 Lists recipe names (```PN`` <#var-bb-PN>`__ values) BitBake does not 29 Lists recipe names (:term:`PN` values) BitBake does not
30 attempt to build. Instead, BitBake assumes these recipes have already 30 attempt to build. Instead, BitBake assumes these recipes have already
31 been built. 31 been built.
32 32
@@ -45,7 +45,7 @@ overview of their function and contents.
45 considerations surrounding this variable: 45 considerations surrounding this variable:
46 46
47 - This host list is only used if 47 - This host list is only used if
48 ```BB_NO_NETWORK`` <#var-bb-BB_NO_NETWORK>`__ is either not set or 48 :term:`BB_NO_NETWORK` is either not set or
49 set to "0". 49 set to "0".
50 50
51 - Limited support for the "``*``" wildcard character for matching 51 - Limited support for the "``*``" wildcard character for matching
@@ -69,11 +69,11 @@ overview of their function and contents.
69 - Attempts to access networks not in the host list cause a failure. 69 - Attempts to access networks not in the host list cause a failure.
70 70
71 Using ``BB_ALLOWED_NETWORKS`` in conjunction with 71 Using ``BB_ALLOWED_NETWORKS`` in conjunction with
72 ```PREMIRRORS`` <#var-bb-PREMIRRORS>`__ is very useful. Adding the 72 :term:`PREMIRRORS` is very useful. Adding the
73 host you want to use to ``PREMIRRORS`` results in the source code 73 host you want to use to ``PREMIRRORS`` results in the source code
74 being fetched from an allowed location and avoids raising an error 74 being fetched from an allowed location and avoids raising an error
75 when a host that is not allowed is in a 75 when a host that is not allowed is in a
76 ```SRC_URI`` <#var-bb-SRC_URI>`__ statement. This is because the 76 :term:`SRC_URI` statement. This is because the
77 fetcher does not attempt to use the host listed in ``SRC_URI`` after 77 fetcher does not attempt to use the host listed in ``SRC_URI`` after
78 a successful fetch from the ``PREMIRRORS`` occurs. 78 a successful fetch from the ``PREMIRRORS`` occurs.
79 79
@@ -113,7 +113,7 @@ overview of their function and contents.
113 Stop the build after the currently executing tasks have finished when 113 Stop the build after the currently executing tasks have finished when
114 a threshold is broken. WARN: Issue a warning but continue the build 114 a threshold is broken. WARN: Issue a warning but continue the build
115 when a threshold is broken. Subsequent warnings are issued as defined 115 when a threshold is broken. Subsequent warnings are issued as defined
116 by the `BB_DISKMON_WARNINTERVAL <#var-bb-BB_DISKMON_WARNINTERVAL>`__ 116 by the :term:`BB_DISKMON_WARNINTERVAL`
117 variable, which must be defined. <dir> is: Any directory you choose. 117 variable, which must be defined. <dir> is: Any directory you choose.
118 You can specify one or more directories to monitor by separating the 118 You can specify one or more directories to monitor by separating the
119 groupings with a space. If two directories are on the same device, 119 groupings with a space. If two directories are on the same device,
@@ -128,7 +128,7 @@ overview of their function and contents.
128 WARN,${SSTATE_DIR},1G,100K" BB_DISKMON_DIRS = 128 WARN,${SSTATE_DIR},1G,100K" BB_DISKMON_DIRS =
129 "STOPTASKS,${TMPDIR},1G" BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" 129 "STOPTASKS,${TMPDIR},1G" BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K"
130 The first example works only if you also set the 130 The first example works only if you also set the
131 ```BB_DISKMON_WARNINTERVAL`` <#var-bb-BB_DISKMON_WARNINTERVAL>`__ 131 :term:`BB_DISKMON_WARNINTERVAL`
132 variable. This example causes the build system to immediately abort 132 variable. This example causes the build system to immediately abort
133 when either the disk space in ``${TMPDIR}`` drops below 1 Gbyte or 133 when either the disk space in ``${TMPDIR}`` drops below 1 Gbyte or
134 the available free inodes drops below 100 Kbytes. Because two 134 the available free inodes drops below 100 Kbytes. Because two
@@ -151,7 +151,7 @@ overview of their function and contents.
151 Defines the disk space and free inode warning intervals. 151 Defines the disk space and free inode warning intervals.
152 152
153 If you are going to use the ``BB_DISKMON_WARNINTERVAL`` variable, you 153 If you are going to use the ``BB_DISKMON_WARNINTERVAL`` variable, you
154 must also use the ```BB_DISKMON_DIRS`` <#var-bb-BB_DISKMON_DIRS>`__ 154 must also use the :term:`BB_DISKMON_DIRS`
155 variable and define its action as "WARN". During the build, 155 variable and define its action as "WARN". During the build,
156 subsequent warnings are issued each time disk space or number of free 156 subsequent warnings are issued each time disk space or number of free
157 inodes further reduces by the respective interval. 157 inodes further reduces by the respective interval.
@@ -182,10 +182,10 @@ overview of their function and contents.
182 Specifies the internal whitelist of variables to allow through from 182 Specifies the internal whitelist of variables to allow through from
183 the external environment into BitBake's datastore. If the value of 183 the external environment into BitBake's datastore. If the value of
184 this variable is not specified (which is the default), the following 184 this variable is not specified (which is the default), the following
185 list is used: ```BBPATH`` <#var-bb-BBPATH>`__, 185 list is used: :term:`BBPATH`,
186 ```BB_PRESERVE_ENV`` <#var-bb-BB_PRESERVE_ENV>`__, 186 :term:`BB_PRESERVE_ENV`,
187 ```BB_ENV_WHITELIST`` <#var-bb-BB_ENV_WHITELIST>`__, and 187 :term:`BB_ENV_WHITELIST`, and
188 ```BB_ENV_EXTRAWHITE`` <#var-bb-BB_ENV_EXTRAWHITE>`__. 188 :term:`BB_ENV_EXTRAWHITE`.
189 189
190 .. note:: 190 .. note::
191 191
@@ -196,7 +196,7 @@ overview of their function and contents.
196 Specifies an additional set of variables to allow through (whitelist) 196 Specifies an additional set of variables to allow through (whitelist)
197 from the external environment into BitBake's datastore. This list of 197 from the external environment into BitBake's datastore. This list of
198 variables are on top of the internal list set in 198 variables are on top of the internal list set in
199 ```BB_ENV_WHITELIST`` <#var-bb-BB_ENV_WHITELIST>`__. 199 :term:`BB_ENV_WHITELIST`.
200 200
201 .. note:: 201 .. note::
202 202
@@ -205,9 +205,9 @@ overview of their function and contents.
205 205
206 BB_FETCH_PREMIRRORONLY 206 BB_FETCH_PREMIRRORONLY
207 When set to "1", causes BitBake's fetcher module to only search 207 When set to "1", causes BitBake's fetcher module to only search
208 ```PREMIRRORS`` <#var-bb-PREMIRRORS>`__ for files. BitBake will not 208 :term:`PREMIRRORS` for files. BitBake will not
209 search the main ```SRC_URI`` <#var-bb-SRC_URI>`__ or 209 search the main :term:`SRC_URI` or
210 ```MIRRORS`` <#var-bb-MIRRORS>`__. 210 :term:`MIRRORS`.
211 211
212 BB_FILENAME 212 BB_FILENAME
213 Contains the filename of the recipe that owns the currently running 213 Contains the filename of the recipe that owns the currently running
@@ -256,7 +256,7 @@ overview of their function and contents.
256 256
257 BB_GENERATE_MIRROR_TARBALLS 257 BB_GENERATE_MIRROR_TARBALLS
258 Causes tarballs of the Git repositories, including the Git metadata, 258 Causes tarballs of the Git repositories, including the Git metadata,
259 to be placed in the ```DL_DIR`` <#var-bb-DL_DIR>`__ directory. Anyone 259 to be placed in the :term:`DL_DIR` directory. Anyone
260 wishing to create a source mirror would want to enable this variable. 260 wishing to create a source mirror would want to enable this variable.
261 261
262 For performance reasons, creating and placing tarballs of the Git 262 For performance reasons, creating and placing tarballs of the Git
@@ -308,7 +308,7 @@ overview of their function and contents.
308 308
309 BB_LOGFMT 309 BB_LOGFMT
310 Specifies the name of the log files saved into 310 Specifies the name of the log files saved into
311 ``${``\ ```T`` <#var-bb-T>`__\ ``}``. By default, the ``BB_LOGFMT`` 311 ``${``\ :term:`T`\ ``}``. By default, the ``BB_LOGFMT``
312 variable is undefined and the log file names get created using the 312 variable is undefined and the log file names get created using the
313 following form: log.{task}.{pid} If you want to force log files to 313 following form: log.{task}.{pid} If you want to force log files to
314 take a specific name, you can set this variable in a configuration 314 take a specific name, you can set this variable in a configuration
@@ -318,7 +318,7 @@ overview of their function and contents.
318 Allows BitBake to run at a specific priority (i.e. nice level). 318 Allows BitBake to run at a specific priority (i.e. nice level).
319 System permissions usually mean that BitBake can reduce its priority 319 System permissions usually mean that BitBake can reduce its priority
320 but not raise it again. See 320 but not raise it again. See
321 ```BB_TASK_NICE_LEVEL`` <#var-bb-BB_TASK_NICE_LEVEL>`__ for 321 :term:`BB_TASK_NICE_LEVEL` for
322 additional information. 322 additional information.
323 323
324 BB_NO_NETWORK 324 BB_NO_NETWORK
@@ -360,7 +360,7 @@ overview of their function and contents.
360 360
361 BB_RUNFMT 361 BB_RUNFMT
362 Specifies the name of the executable script files (i.e. run files) 362 Specifies the name of the executable script files (i.e. run files)
363 saved into ``${``\ ```T`` <#var-bb-T>`__\ ``}``. By default, the 363 saved into ``${``\ :term:`T`\ ``}``. By default, the
364 ``BB_RUNFMT`` variable is undefined and the run file names get 364 ``BB_RUNFMT`` variable is undefined and the run file names get
365 created using the following form: run.{task}.{pid} If you want to 365 created using the following form: run.{task}.{pid} If you want to
366 force run files to take a specific name, you can set this variable in 366 force run files to take a specific name, you can set this variable in
@@ -390,7 +390,7 @@ overview of their function and contents.
390 derived from the ``RunQueueScheduler`` class. 390 derived from the ``RunQueueScheduler`` class.
391 391
392 For information how to select a scheduler, see the 392 For information how to select a scheduler, see the
393 ```BB_SCHEDULER`` <#var-bb-BB_SCHEDULER>`__ variable. 393 :term:`BB_SCHEDULER` variable.
394 394
395 BB_SETSCENE_DEPVALID 395 BB_SETSCENE_DEPVALID
396 Specifies a function BitBake calls that determines whether BitBake 396 Specifies a function BitBake calls that determines whether BitBake
@@ -456,7 +456,7 @@ overview of their function and contents.
456 456
457 - *whitelist* - Identical to "full" mode except timestamp 457 - *whitelist* - Identical to "full" mode except timestamp
458 comparisons are made for recipes listed in the 458 comparisons are made for recipes listed in the
459 ```BB_STAMP_WHITELIST`` <#var-bb-BB_STAMP_WHITELIST>`__ variable. 459 :term:`BB_STAMP_WHITELIST` variable.
460 460
461 .. note:: 461 .. note::
462 462
@@ -466,7 +466,7 @@ overview of their function and contents.
466 BB_STAMP_WHITELIST 466 BB_STAMP_WHITELIST
467 Lists files whose stamp file timestamps are compared when the stamp 467 Lists files whose stamp file timestamps are compared when the stamp
468 policy mode is set to "whitelist". For information on stamp policies, 468 policy mode is set to "whitelist". For information on stamp policies,
469 see the ```BB_STAMP_POLICY`` <#var-bb-BB_STAMP_POLICY>`__ variable. 469 see the :term:`BB_STAMP_POLICY` variable.
470 470
471 BB_STRICT_CHECKSUM 471 BB_STRICT_CHECKSUM
472 Sets a more strict checksum mechanism for non-local URLs. Setting 472 Sets a more strict checksum mechanism for non-local URLs. Setting
@@ -555,7 +555,7 @@ overview of their function and contents.
555 Internally, the ``BBCLASSEXTEND`` mechanism generates recipe 555 Internally, the ``BBCLASSEXTEND`` mechanism generates recipe
556 variants by rewriting variable values and applying overrides such 556 variants by rewriting variable values and applying overrides such
557 as ``_class-native``. For example, to generate a native version of 557 as ``_class-native``. For example, to generate a native version of
558 a recipe, a ```DEPENDS`` <#var-bb-DEPENDS>`__ on "foo" is 558 a recipe, a :term:`DEPENDS` on "foo" is
559 rewritten to a ``DEPENDS`` on "foo-native". 559 rewritten to a ``DEPENDS`` on "foo-native".
560 560
561 Even when using ``BBCLASSEXTEND``, the recipe is only parsed once. 561 Even when using ``BBCLASSEXTEND``, the recipe is only parsed once.
@@ -580,7 +580,7 @@ overview of their function and contents.
580 580
581 BBFILE_PATTERN 581 BBFILE_PATTERN
582 Variable that expands to match files from 582 Variable that expands to match files from
583 ```BBFILES`` <#var-bb-BBFILES>`__ in a particular layer. This 583 :term:`BBFILES` in a particular layer. This
584 variable is used in the ``conf/layer.conf`` file and must be suffixed 584 variable is used in the ``conf/layer.conf`` file and must be suffixed
585 with the name of the specific layer (e.g. 585 with the name of the specific layer (e.g.
586 ``BBFILE_PATTERN_emenlow``). 586 ``BBFILE_PATTERN_emenlow``).
@@ -593,7 +593,7 @@ overview of their function and contents.
593 prioritize a layer against other layers that contain the same recipe 593 prioritize a layer against other layers that contain the same recipe
594 - effectively letting you control the precedence for the multiple 594 - effectively letting you control the precedence for the multiple
595 layers. The precedence established through this variable stands 595 layers. The precedence established through this variable stands
596 regardless of a recipe's version (```PV`` <#var-bb-PV>`__ variable). 596 regardless of a recipe's version (:term:`PV` variable).
597 For example, a layer that has a recipe with a higher ``PV`` value but 597 For example, a layer that has a recipe with a higher ``PV`` value but
598 for which the ``BBFILE_PRIORITY`` is set to have a lower precedence 598 for which the ``BBFILE_PRIORITY`` is set to have a lower precedence
599 still has a lower precedence. 599 still has a lower precedence.
@@ -617,7 +617,7 @@ overview of their function and contents.
617 software. 617 software.
618 618
619 When specifying recipe files, you can pattern match using Python's 619 When specifying recipe files, you can pattern match using Python's
620 ```glob`` <https://docs.python.org/3/library/glob.html>`__ syntax. 620 ```glob`https://docs.python.org/3/library/glob.html syntax.
621 For details on the syntax, see the documentation by following the 621 For details on the syntax, see the documentation by following the
622 previous link. 622 previous link.
623 623
@@ -630,7 +630,7 @@ overview of their function and contents.
630 failed task. 630 failed task.
631 631
632 BBINCLUDELOGS_LINES 632 BBINCLUDELOGS_LINES
633 If ```BBINCLUDELOGS`` <#var-bb-BBINCLUDELOGS>`__ is set, specifies 633 If :term:`BBINCLUDELOGS` is set, specifies
634 the maximum number of lines from the task log file to print when 634 the maximum number of lines from the task log file to print when
635 reporting a failed task. If you do not set ``BBINCLUDELOGS_LINES``, 635 reporting a failed task. If you do not set ``BBINCLUDELOGS_LINES``,
636 the entire log is printed. 636 the entire log is printed.
@@ -662,7 +662,7 @@ overview of their function and contents.
662 compiler. Consequently, the syntax follows Python's Regular 662 compiler. Consequently, the syntax follows Python's Regular
663 Expression (re) syntax. The expressions are compared against the full 663 Expression (re) syntax. The expressions are compared against the full
664 paths to the files. For complete syntax information, see Python's 664 paths to the files. For complete syntax information, see Python's
665 documentation at ` <http://docs.python.org/3/library/re.html#re>`__. 665 documentation at http://docs.python.org/3/library/re.html#re.
666 666
667 The following example uses a complete regular expression to tell 667 The following example uses a complete regular expression to tell
668 BitBake to ignore all recipe and recipe append files in the 668 BitBake to ignore all recipe and recipe append files in the
@@ -718,7 +718,7 @@ overview of their function and contents.
718 BBVERSIONS 718 BBVERSIONS
719 Allows a single recipe to build multiple versions of a project from a 719 Allows a single recipe to build multiple versions of a project from a
720 single recipe file. You also able to specify conditional metadata 720 single recipe file. You also able to specify conditional metadata
721 using the ```OVERRIDES`` <#var-bb-OVERRIDES>`__ mechanism for a 721 using the :term:`OVERRIDES` mechanism for a
722 single version or for an optionally named range of versions. 722 single version or for an optionally named range of versions.
723 723
724 For more information on ``BBVERSIONS``, see the "`Variants - Class 724 For more information on ``BBVERSIONS``, see the "`Variants - Class
@@ -780,7 +780,7 @@ overview of their function and contents.
780 "a" is configuring itself. 780 "a" is configuring itself.
781 781
782 For information on runtime dependencies, see the 782 For information on runtime dependencies, see the
783 ```RDEPENDS`` <#var-bb-RDEPENDS>`__ variable. 783 :term:`RDEPENDS` variable.
784 784
785 DESCRIPTION 785 DESCRIPTION
786 A long description for the recipe. 786 A long description for the recipe.
@@ -790,7 +790,7 @@ overview of their function and contents.
790 downloads. By default, ``DL_DIR`` gets files suitable for mirroring 790 downloads. By default, ``DL_DIR`` gets files suitable for mirroring
791 for everything except Git repositories. If you want tarballs of Git 791 for everything except Git repositories. If you want tarballs of Git
792 repositories, use the 792 repositories, use the
793 ```BB_GENERATE_MIRROR_TARBALLS`` <#var-bb-BB_GENERATE_MIRROR_TARBALLS>`__ 793 :term:`BB_GENERATE_MIRROR_TARBALLS`
794 variable. 794 variable.
795 795
796 EXCLUDE_FROM_WORLD 796 EXCLUDE_FROM_WORLD
@@ -820,7 +820,7 @@ overview of their function and contents.
820 820
821 FAKEROOTBASEENV 821 FAKEROOTBASEENV
822 Lists environment variables to set when executing the command defined 822 Lists environment variables to set when executing the command defined
823 by ```FAKEROOTCMD`` <#var-bb-FAKEROOTCMD>`__ that starts the 823 by :term:`FAKEROOTCMD` that starts the
824 bitbake-worker process in the fakeroot environment. 824 bitbake-worker process in the fakeroot environment.
825 825
826 FAKEROOTCMD 826 FAKEROOTCMD
@@ -835,13 +835,13 @@ overview of their function and contents.
835 Lists environment variables to set when running a task in the 835 Lists environment variables to set when running a task in the
836 fakeroot environment. For additional information on environment 836 fakeroot environment. For additional information on environment
837 variables and the fakeroot environment, see the 837 variables and the fakeroot environment, see the
838 ```FAKEROOTBASEENV`` <#var-bb-FAKEROOTBASEENV>`__ variable. 838 :term:`FAKEROOTBASEENV` variable.
839 839
840 FAKEROOTNOENV 840 FAKEROOTNOENV
841 Lists environment variables to set when running a task that is not in 841 Lists environment variables to set when running a task that is not in
842 the fakeroot environment. For additional information on environment 842 the fakeroot environment. For additional information on environment
843 variables and the fakeroot environment, see the 843 variables and the fakeroot environment, see the
844 ```FAKEROOTENV`` <#var-bb-FAKEROOTENV>`__ variable. 844 :term:`FAKEROOTENV` variable.
845 845
846 FETCHCMD 846 FETCHCMD
847 Defines the command the BitBake fetcher module executes when running 847 Defines the command the BitBake fetcher module executes when running
@@ -888,7 +888,7 @@ overview of their function and contents.
888 depends. Optionally, you can specify a specific layer version for a 888 depends. Optionally, you can specify a specific layer version for a
889 dependency by adding it to the end of the layer name with a colon, 889 dependency by adding it to the end of the layer name with a colon,
890 (e.g. "anotherlayer:3" to be compared against 890 (e.g. "anotherlayer:3" to be compared against
891 ```LAYERVERSION`` <#var-bb-LAYERVERSION>`__\ ``_anotherlayer`` in 891 :term:`LAYERVERSION`\ ``_anotherlayer`` in
892 this case). BitBake produces an error if any dependency is missing or 892 this case). BitBake produces an error if any dependency is missing or
893 the version numbers do not match exactly (if specified). 893 the version numbers do not match exactly (if specified).
894 894
@@ -905,14 +905,14 @@ overview of their function and contents.
905 LAYERDIR_RE 905 LAYERDIR_RE
906 When used inside the ``layer.conf`` configuration file, this variable 906 When used inside the ``layer.conf`` configuration file, this variable
907 provides the path of the current layer, escaped for use in a regular 907 provides the path of the current layer, escaped for use in a regular
908 expression (```BBFILE_PATTERN`` <#var-bb-BBFILE_PATTERN>`__). This 908 expression (:term:`BBFILE_PATTERN`). This
909 variable is not available outside of ``layer.conf`` and references 909 variable is not available outside of ``layer.conf`` and references
910 are expanded immediately when parsing of the file completes. 910 are expanded immediately when parsing of the file completes.
911 911
912 LAYERVERSION 912 LAYERVERSION
913 Optionally specifies the version of a layer as a single number. You 913 Optionally specifies the version of a layer as a single number. You
914 can use this variable within 914 can use this variable within
915 ```LAYERDEPENDS`` <#var-bb-LAYERDEPENDS>`__ for another layer in 915 :term:`LAYERDEPENDS` for another layer in
916 order to depend on a specific version of the layer. 916 order to depend on a specific version of the layer.
917 917
918 You use this variable in the ``conf/layer.conf`` file. You must also 918 You use this variable in the ``conf/layer.conf`` file. You must also
@@ -926,7 +926,7 @@ overview of their function and contents.
926 Specifies additional paths from which BitBake gets source code. When 926 Specifies additional paths from which BitBake gets source code. When
927 the build system searches for source code, it first tries the local 927 the build system searches for source code, it first tries the local
928 download directory. If that location fails, the build system tries 928 download directory. If that location fails, the build system tries
929 locations defined by ```PREMIRRORS`` <#var-bb-PREMIRRORS>`__, the 929 locations defined by :term:`PREMIRRORS`, the
930 upstream source, and then locations specified by ``MIRRORS`` in that 930 upstream source, and then locations specified by ``MIRRORS`` in that
931 order. 931 order.
932 932
@@ -964,7 +964,7 @@ overview of their function and contents.
964 optional modules that are found in other recipes. 964 optional modules that are found in other recipes.
965 ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it 965 ``PACKAGES_DYNAMIC`` does not actually satisfy the dependencies, it
966 only states that they should be satisfied. For example, if a hard, 966 only states that they should be satisfied. For example, if a hard,
967 runtime dependency (```RDEPENDS`` <#var-bb-RDEPENDS>`__) of another 967 runtime dependency (:term:`RDEPENDS`) of another
968 package is satisfied during the build through the 968 package is satisfied during the build through the
969 ``PACKAGES_DYNAMIC`` variable, but a package with the module name is 969 ``PACKAGES_DYNAMIC`` variable, but a package with the module name is
970 never actually produced, then the other package will be broken. 970 never actually produced, then the other package will be broken.
@@ -995,7 +995,7 @@ overview of their function and contents.
995 Determines which recipe should be given preference when multiple 995 Determines which recipe should be given preference when multiple
996 recipes provide the same item. You should always suffix the variable 996 recipes provide the same item. You should always suffix the variable
997 with the name of the provided item, and you should set it to the 997 with the name of the provided item, and you should set it to the
998 ```PN`` <#var-bb-PN>`__ of the recipe to which you want to give 998 :term:`PN` of the recipe to which you want to give
999 precedence. Some examples: PREFERRED_PROVIDER_virtual/kernel ?= 999 precedence. Some examples: PREFERRED_PROVIDER_virtual/kernel ?=
1000 "linux-yocto" PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86" 1000 "linux-yocto" PREFERRED_PROVIDER_virtual/xserver = "xserver-xf86"
1001 PREFERRED_PROVIDER_virtual/libgl ?= "mesa" 1001 PREFERRED_PROVIDER_virtual/libgl ?= "mesa"
@@ -1004,7 +1004,7 @@ overview of their function and contents.
1004 Determines which recipe should be given preference for cases where 1004 Determines which recipe should be given preference for cases where
1005 multiple recipes provide the same item. Functionally, 1005 multiple recipes provide the same item. Functionally,
1006 ``PREFERRED_PROVIDERS`` is identical to 1006 ``PREFERRED_PROVIDERS`` is identical to
1007 ```PREFERRED_PROVIDER`` <#var-bb-PREFERRED_PROVIDER>`__. However, the 1007 :term:`PREFERRED_PROVIDER`. However, the
1008 ``PREFERRED_PROVIDERS`` variable lets you define preferences for 1008 ``PREFERRED_PROVIDERS`` variable lets you define preferences for
1009 multiple situations using the following form: PREFERRED_PROVIDERS = 1009 multiple situations using the following form: PREFERRED_PROVIDERS =
1010 "xxx:yyy aaa:bbb ..." This form is a convenient replacement for the 1010 "xxx:yyy aaa:bbb ..." This form is a convenient replacement for the
@@ -1014,8 +1014,8 @@ overview of their function and contents.
1014 PREFERRED_VERSION 1014 PREFERRED_VERSION
1015 If there are multiple versions of recipes available, this variable 1015 If there are multiple versions of recipes available, this variable
1016 determines which recipe should be given preference. You must always 1016 determines which recipe should be given preference. You must always
1017 suffix the variable with the ```PN`` <#var-bb-PN>`__ you want to 1017 suffix the variable with the :term:`PN` you want to
1018 select, and you should set ```PV`` <#var-bb-PV>`__ accordingly for 1018 select, and you should set :term:`PV` accordingly for
1019 precedence. 1019 precedence.
1020 1020
1021 The ``PREFERRED_VERSION`` variable supports limited wildcard use 1021 The ``PREFERRED_VERSION`` variable supports limited wildcard use
@@ -1038,7 +1038,7 @@ overview of their function and contents.
1038 the build system searches for source code, it first tries the local 1038 the build system searches for source code, it first tries the local
1039 download directory. If that location fails, the build system tries 1039 download directory. If that location fails, the build system tries
1040 locations defined by ``PREMIRRORS``, the upstream source, and then 1040 locations defined by ``PREMIRRORS``, the upstream source, and then
1041 locations specified by ```MIRRORS`` <#var-bb-MIRRORS>`__ in that 1041 locations specified by :term:`MIRRORS` in that
1042 order. 1042 order.
1043 1043
1044 Typically, you would add a specific server for the build system to 1044 Typically, you would add a specific server for the build system to
@@ -1072,7 +1072,7 @@ overview of their function and contents.
1072 functionality (e.g. a Linux kernel). Recipes that provide the 1072 functionality (e.g. a Linux kernel). Recipes that provide the
1073 functionality in question list the virtual target in ``PROVIDES``. 1073 functionality in question list the virtual target in ``PROVIDES``.
1074 Recipes that depend on the functionality in question can include the 1074 Recipes that depend on the functionality in question can include the
1075 virtual target in ```DEPENDS`` <#var-bb-DEPENDS>`__ to leave the 1075 virtual target in :term:`DEPENDS` to leave the
1076 choice of provider open. 1076 choice of provider open.
1077 1077
1078 Conventionally, virtual targets have names on the form 1078 Conventionally, virtual targets have names on the form
@@ -1080,7 +1080,7 @@ overview of their function and contents.
1080 of the name and has no syntactical significance. 1080 of the name and has no syntactical significance.
1081 1081
1082 PRSERV_HOST 1082 PRSERV_HOST
1083 The network based ```PR`` <#var-bb-PR>`__ service host and port. 1083 The network based :term:`PR` service host and port.
1084 1084
1085 Following is an example of how the ``PRSERV_HOST`` variable is set: 1085 Following is an example of how the ``PRSERV_HOST`` variable is set:
1086 PRSERV_HOST = "localhost:0" You must set the variable if you want to 1086 PRSERV_HOST = "localhost:0" You must set the variable if you want to
@@ -1114,7 +1114,7 @@ overview of their function and contents.
1114 greater of the package ``foo``: RDEPENDS_${PN} = "foo (>= 1.2)" 1114 greater of the package ``foo``: RDEPENDS_${PN} = "foo (>= 1.2)"
1115 1115
1116 For information on build-time dependencies, see the 1116 For information on build-time dependencies, see the
1117 ```DEPENDS`` <#var-bb-DEPENDS>`__ variable. 1117 :term:`DEPENDS` variable.
1118 1118
1119 REPODIR 1119 REPODIR
1120 The directory in which a local copy of a ``google-repo`` directory is 1120 The directory in which a local copy of a ``google-repo`` directory is
@@ -1163,7 +1163,7 @@ overview of their function and contents.
1163 1163
1164 - *``file://`` -* Fetches files, which are usually files shipped 1164 - *``file://`` -* Fetches files, which are usually files shipped
1165 with the metadata, from the local machine. The path is relative to 1165 with the metadata, from the local machine. The path is relative to
1166 the ```FILESPATH`` <#var-bb-FILESPATH>`__ variable. 1166 the :term:`FILESPATH` variable.
1167 1167
1168 - *``bzr://`` -* Fetches files from a Bazaar revision control 1168 - *``bzr://`` -* Fetches files from a Bazaar revision control
1169 repository. 1169 repository.
@@ -1227,9 +1227,9 @@ overview of their function and contents.
1227 identifier and not just a tag. 1227 identifier and not just a tag.
1228 1228
1229 SRCREV_FORMAT 1229 SRCREV_FORMAT
1230 Helps construct valid ```SRCREV`` <#var-bb-SRCREV>`__ values when 1230 Helps construct valid :term:`SRCREV` values when
1231 multiple source controlled URLs are used in 1231 multiple source controlled URLs are used in
1232 ```SRC_URI`` <#var-bb-SRC_URI>`__. 1232 :term:`SRC_URI`.
1233 1233
1234 The system needs help constructing these values under these 1234 The system needs help constructing these values under these
1235 circumstances. Each component in the ``SRC_URI`` is assigned a name 1235 circumstances. Each component in the ``SRC_URI`` is assigned a name
@@ -1247,7 +1247,7 @@ overview of their function and contents.
1247 1247
1248 STAMPCLEAN 1248 STAMPCLEAN
1249 Specifies the base path used to create recipe stamp files. Unlike the 1249 Specifies the base path used to create recipe stamp files. Unlike the
1250 ```STAMP`` <#var-bb-STAMP>`__ variable, ``STAMPCLEAN`` can contain 1250 :term:`STAMP` variable, ``STAMPCLEAN`` can contain
1251 wildcards to match the range of files a clean operation should 1251 wildcards to match the range of files a clean operation should
1252 remove. BitBake uses a clean operation to remove any other stamps it 1252 remove. BitBake uses a clean operation to remove any other stamps it
1253 should be removing when creating a new stamp. 1253 should be removing when creating a new stamp.