summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
diff options
context:
space:
mode:
authorQuentin Schulz <quentin.schulz@theobroma-systems.com>2021-07-26 17:35:22 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-07-26 22:34:13 +0100
commiteb38dce0c1bf040f17b0ca5a6a1656634ddce0f7 (patch)
tree5a5c09d63febfded37ea7f81c05cff14affee25d /bitbake/doc
parentbf58b597d26de968bfba07ef3de8548fa0d62f04 (diff)
downloadpoky-eb38dce0c1bf040f17b0ca5a6a1656634ddce0f7.tar.gz
bitbake: doc: bitbake-user-manual: ref-variables: order alphabetically the glossary sources
This reorders a few entry so that they are alphabetically sorted. (Bitbake rev: 311350ed5cb164d975c2119e60255a409e27dffb) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Signed-off-by: Quentin Schulz <foss@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc')
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst54
1 files changed, 27 insertions, 27 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 2dca52c4a0..15de2276ea 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
@@ -231,23 +231,23 @@ overview of their function and contents.
231 based on the interval occur each time a respective interval is 231 based on the interval occur each time a respective interval is
232 reached beyond the initial warning (i.e. 1 Gbytes and 100 Kbytes). 232 reached beyond the initial warning (i.e. 1 Gbytes and 100 Kbytes).
233 233
234 :term:`BB_ENV_WHITELIST` 234 :term:`BB_ENV_EXTRAWHITE`
235 Specifies the internal whitelist of variables to allow through from 235 Specifies an additional set of variables to allow through (whitelist)
236 the external environment into BitBake's datastore. If the value of 236 from the external environment into BitBake's datastore. This list of
237 this variable is not specified (which is the default), the following 237 variables are on top of the internal list set in
238 list is used: :term:`BBPATH`, :term:`BB_PRESERVE_ENV`, 238 :term:`BB_ENV_WHITELIST`.
239 :term:`BB_ENV_WHITELIST`, and :term:`BB_ENV_EXTRAWHITE`.
240 239
241 .. note:: 240 .. note::
242 241
243 You must set this variable in the external environment in order 242 You must set this variable in the external environment in order
244 for it to work. 243 for it to work.
245 244
246 :term:`BB_ENV_EXTRAWHITE` 245 :term:`BB_ENV_WHITELIST`
247 Specifies an additional set of variables to allow through (whitelist) 246 Specifies the internal whitelist of variables to allow through from
248 from the external environment into BitBake's datastore. This list of 247 the external environment into BitBake's datastore. If the value of
249 variables are on top of the internal list set in 248 this variable is not specified (which is the default), the following
250 :term:`BB_ENV_WHITELIST`. 249 list is used: :term:`BBPATH`, :term:`BB_PRESERVE_ENV`,
250 :term:`BB_ENV_WHITELIST`, and :term:`BB_ENV_EXTRAWHITE`.
251 251
252 .. note:: 252 .. note::
253 253
@@ -276,18 +276,6 @@ overview of their function and contents.
276 276
277 BB_GENERATE_MIRROR_TARBALLS = "1" 277 BB_GENERATE_MIRROR_TARBALLS = "1"
278 278
279 :term:`BB_HASHCONFIG_WHITELIST`
280 Lists variables that are excluded from base configuration checksum,
281 which is used to determine if the cache can be reused.
282
283 One of the ways BitBake determines whether to re-parse the main
284 metadata is through checksums of the variables in the datastore of
285 the base configuration data. There are variables that you typically
286 want to exclude when checking whether or not to re-parse and thus
287 rebuild the cache. As an example, you would usually exclude ``TIME``
288 and ``DATE`` because these variables are always changing. If you did
289 not exclude them, BitBake would never reuse the cache.
290
291 :term:`BB_HASHBASE_WHITELIST` 279 :term:`BB_HASHBASE_WHITELIST`
292 Lists variables that are excluded from checksum and dependency data. 280 Lists variables that are excluded from checksum and dependency data.
293 Variables that are excluded can therefore change without affecting 281 Variables that are excluded can therefore change without affecting
@@ -309,6 +297,18 @@ overview of their function and contents.
309 However, the more accurate the data returned, the more efficient the 297 However, the more accurate the data returned, the more efficient the
310 build will be. 298 build will be.
311 299
300 :term:`BB_HASHCONFIG_WHITELIST`
301 Lists variables that are excluded from base configuration checksum,
302 which is used to determine if the cache can be reused.
303
304 One of the ways BitBake determines whether to re-parse the main
305 metadata is through checksums of the variables in the datastore of
306 the base configuration data. There are variables that you typically
307 want to exclude when checking whether or not to re-parse and thus
308 rebuild the cache. As an example, you would usually exclude ``TIME``
309 and ``DATE`` because these variables are always changing. If you did
310 not exclude them, BitBake would never reuse the cache.
311
312 :term:`BB_HASHSERVE` 312 :term:`BB_HASHSERVE`
313 Specifies the Hash Equivalence server to use. 313 Specifies the Hash Equivalence server to use.
314 314
@@ -357,15 +357,15 @@ overview of their function and contents.
357 running builds when not connected to the Internet, and when operating 357 running builds when not connected to the Internet, and when operating
358 in certain kinds of firewall environments. 358 in certain kinds of firewall environments.
359 359
360 :term:`BB_NUMBER_PARSE_THREADS`
361 Sets the number of threads BitBake uses when parsing. By default, the
362 number of threads is equal to the number of cores on the system.
363
360 :term:`BB_NUMBER_THREADS` 364 :term:`BB_NUMBER_THREADS`
361 The maximum number of tasks BitBake should run in parallel at any one 365 The maximum number of tasks BitBake should run in parallel at any one
362 time. If your host development system supports multiple cores, a good 366 time. If your host development system supports multiple cores, a good
363 rule of thumb is to set this variable to twice the number of cores. 367 rule of thumb is to set this variable to twice the number of cores.
364 368
365 :term:`BB_NUMBER_PARSE_THREADS`
366 Sets the number of threads BitBake uses when parsing. By default, the
367 number of threads is equal to the number of cores on the system.
368
369 :term:`BB_ORIGENV` 369 :term:`BB_ORIGENV`
370 Contains a copy of the original external environment in which BitBake 370 Contains a copy of the original external environment in which BitBake
371 was run. The copy is taken before any whitelisted variable values are 371 was run. The copy is taken before any whitelisted variable values are