summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-03-15 15:21:22 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-03-15 17:29:29 +0000
commita5fd7b3424ea1705132aab0f110a934737d80b50 (patch)
treeb0b3d0eb2c1507fea616753c80763b3cb3dcf8c3
parenta21649109374fde44cf77de845cfb3cb6cbfb138 (diff)
downloadpoky-a5fd7b3424ea1705132aab0f110a934737d80b50.tar.gz
bitbake: doc: bitbake-user-manual: reorder variable definitions
By alphabetical order, to get the same order as in the HTML output, sorted thanks to the ":sorted:" directive. (Bitbake rev: 8b97af89316a4407dd07649e8aadd495edd86ee4) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst62
1 files changed, 31 insertions, 31 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 59a9de2fb8..25af563dbf 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
@@ -93,6 +93,13 @@ overview of their function and contents.
93 fetcher does not attempt to use the host listed in :term:`SRC_URI` after 93 fetcher does not attempt to use the host listed in :term:`SRC_URI` after
94 a successful fetch from the :term:`PREMIRRORS` occurs. 94 a successful fetch from the :term:`PREMIRRORS` occurs.
95 95
96 :term:`BB_BASEHASH_IGNORE_VARS`
97 Lists variables that are excluded from checksum and dependency data.
98 Variables that are excluded can therefore change without affecting
99 the checksum mechanism. A common example would be the variable for
100 the path of the build. BitBake's output should not (and usually does
101 not) depend on the directory in which it was built.
102
96 :term:`BB_CHECK_SSL_CERTS` 103 :term:`BB_CHECK_SSL_CERTS`
97 Specifies if SSL certificates should be checked when fetching. The default 104 Specifies if SSL certificates should be checked when fetching. The default
98 value is ``1`` and certificates are not checked if the value is set to ``0``. 105 value is ``1`` and certificates are not checked if the value is set to ``0``.
@@ -236,17 +243,6 @@ overview of their function and contents.
236 based on the interval occur each time a respective interval is 243 based on the interval occur each time a respective interval is
237 reached beyond the initial warning (i.e. 1 Gbytes and 100 Kbytes). 244 reached beyond the initial warning (i.e. 1 Gbytes and 100 Kbytes).
238 245
239 :term:`BB_ENV_PASSTHROUGH_ADDITIONS`
240 Specifies an additional set of variables to allow through from the
241 external environment into BitBake's datastore. This list of variables
242 are on top of the internal list set in
243 :term:`BB_ENV_PASSTHROUGH`.
244
245 .. note::
246
247 You must set this variable in the external environment in order
248 for it to work.
249
250 :term:`BB_ENV_PASSTHROUGH` 246 :term:`BB_ENV_PASSTHROUGH`
251 Specifies the internal list of variables to allow through from 247 Specifies the internal list of variables to allow through from
252 the external environment into BitBake's datastore. If the value of 248 the external environment into BitBake's datastore. If the value of
@@ -259,6 +255,17 @@ overview of their function and contents.
259 You must set this variable in the external environment in order 255 You must set this variable in the external environment in order
260 for it to work. 256 for it to work.
261 257
258 :term:`BB_ENV_PASSTHROUGH_ADDITIONS`
259 Specifies an additional set of variables to allow through from the
260 external environment into BitBake's datastore. This list of variables
261 are on top of the internal list set in
262 :term:`BB_ENV_PASSTHROUGH`.
263
264 .. note::
265
266 You must set this variable in the external environment in order
267 for it to work.
268
262 :term:`BB_FETCH_PREMIRRORONLY` 269 :term:`BB_FETCH_PREMIRRORONLY`
263 When set to "1", causes BitBake's fetcher module to only search 270 When set to "1", causes BitBake's fetcher module to only search
264 :term:`PREMIRRORS` for files. BitBake will not 271 :term:`PREMIRRORS` for files. BitBake will not
@@ -337,13 +344,6 @@ overview of their function and contents.
337 344
338 For example usage, see :term:`BB_GIT_SHALLOW`. 345 For example usage, see :term:`BB_GIT_SHALLOW`.
339 346
340 :term:`BB_BASEHASH_IGNORE_VARS`
341 Lists variables that are excluded from checksum and dependency data.
342 Variables that are excluded can therefore change without affecting
343 the checksum mechanism. A common example would be the variable for
344 the path of the build. BitBake's output should not (and usually does
345 not) depend on the directory in which it was built.
346
347 :term:`BB_HASHCHECK_FUNCTION` 347 :term:`BB_HASHCHECK_FUNCTION`
348 Specifies the name of the function to call during the "setscene" part 348 Specifies the name of the function to call during the "setscene" part
349 of the task's execution in order to validate the list of task hashes. 349 of the task's execution in order to validate the list of task hashes.
@@ -426,6 +426,19 @@ overview of their function and contents.
426 If you want to force log files to take a specific name, you can set this 426 If you want to force log files to take a specific name, you can set this
427 variable in a configuration file. 427 variable in a configuration file.
428 428
429 :term:`BB_MULTI_PROVIDER_ALLOWED`
430 Allows you to suppress BitBake warnings caused when building two
431 separate recipes that provide the same output.
432
433 BitBake normally issues a warning when building two different recipes
434 where each provides the same output. This scenario is usually
435 something the user does not want. However, cases do exist where it
436 makes sense, particularly in the ``virtual/*`` namespace. You can use
437 this variable to suppress BitBake's warnings.
438
439 To use the variable, list provider names (e.g. recipe names,
440 ``virtual/kernel``, and so forth).
441
429 :term:`BB_NICE_LEVEL` 442 :term:`BB_NICE_LEVEL`
430 Allows BitBake to run at a specific priority (i.e. nice level). 443 Allows BitBake to run at a specific priority (i.e. nice level).
431 System permissions usually mean that BitBake can reduce its priority 444 System permissions usually mean that BitBake can reduce its priority
@@ -1054,19 +1067,6 @@ overview of their function and contents.
1054 upstream source, and then locations specified by :term:`MIRRORS` in that 1067 upstream source, and then locations specified by :term:`MIRRORS` in that
1055 order. 1068 order.
1056 1069
1057 :term:`BB_MULTI_PROVIDER_ALLOWED`
1058 Allows you to suppress BitBake warnings caused when building two
1059 separate recipes that provide the same output.
1060
1061 BitBake normally issues a warning when building two different recipes
1062 where each provides the same output. This scenario is usually
1063 something the user does not want. However, cases do exist where it
1064 makes sense, particularly in the ``virtual/*`` namespace. You can use
1065 this variable to suppress BitBake's warnings.
1066
1067 To use the variable, list provider names (e.g. recipe names,
1068 ``virtual/kernel``, and so forth).
1069
1070 :term:`OVERRIDES` 1070 :term:`OVERRIDES`
1071 BitBake uses :term:`OVERRIDES` to control what variables are overridden 1071 BitBake uses :term:`OVERRIDES` to control what variables are overridden
1072 after BitBake parses recipes and configuration files. 1072 after BitBake parses recipes and configuration files.