summaryrefslogtreecommitdiffstats
path: root/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
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/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
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/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst102
1 files changed, 51 insertions, 51 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst
index 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.