summaryrefslogtreecommitdiffstats
path: root/bitbake/doc
diff options
context:
space:
mode:
authorScott Murray <scott.murray@konsulko.com>2022-02-13 15:37:07 -0500
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-02-21 23:37:26 +0000
commit8e5a8a2b532214f605eb56375e183b0bc7408797 (patch)
tree36e5c58afa0879f48f0d8e3957250f5b304856f4 /bitbake/doc
parent8a16bf5321a51f440b9b5dcc29bc498d1eb0bf28 (diff)
downloadpoky-8e5a8a2b532214f605eb56375e183b0bc7408797.tar.gz
bitbake: bitbake: Rename environment filtering variables
In line with the inclusive language migration defined at: https://wiki.yoctoproject.org/wiki/Inclusive_language rename: BB_ENV_WHITELIST -> BB_ENV_PASSTHROUGH BB_ENV_EXTRAWHITE -> BB_ENV_PASSTHROUGH_ADDITIONS (Bitbake rev: fe60627839d4280cf0117ed1afbfccdff1181b6a) (Bitbake rev: 87104b6a167188921da157c7dba45938849fb22a) Signed-off-by: Scott Murray <scott.murray@konsulko.com> 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-execution.rst4
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst18
-rw-r--r--bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst25
3 files changed, 24 insertions, 23 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 f99001bc76..31ee4e349e 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst
@@ -79,8 +79,8 @@ directives.
79Prior to parsing configuration files, BitBake looks at certain 79Prior to parsing configuration files, BitBake looks at certain
80variables, including: 80variables, including:
81 81
82- :term:`BB_ENV_WHITELIST` 82- :term:`BB_ENV_PASSTHROUGH`
83- :term:`BB_ENV_EXTRAWHITE` 83- :term:`BB_ENV_PASSTHROUGH_ADDITIONS`
84- :term:`BB_PRESERVE_ENV` 84- :term:`BB_PRESERVE_ENV`
85- :term:`BB_ORIGENV` 85- :term:`BB_ORIGENV`
86- :term:`BITBAKE_UI` 86- :term:`BITBAKE_UI`
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 8496e1da53..174cac7818 100644
--- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
+++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst
@@ -1343,8 +1343,8 @@ the build machine cannot influence the build.
1343.. note:: 1343.. note::
1344 1344
1345 By default, BitBake cleans the environment to include only those 1345 By default, BitBake cleans the environment to include only those
1346 things exported or listed in its whitelist to ensure that the build 1346 things exported or listed in its passthrough list to ensure that the
1347 environment is reproducible and consistent. You can prevent this 1347 build environment is reproducible and consistent. You can prevent this
1348 "cleaning" by setting the :term:`BB_PRESERVE_ENV` variable. 1348 "cleaning" by setting the :term:`BB_PRESERVE_ENV` variable.
1349 1349
1350Consequently, if you do want something to get passed into the build task 1350Consequently, if you do want something to get passed into the build task
@@ -1352,14 +1352,14 @@ environment, you must take these two steps:
1352 1352
1353#. Tell BitBake to load what you want from the environment into the 1353#. Tell BitBake to load what you want from the environment into the
1354 datastore. You can do so through the 1354 datastore. You can do so through the
1355 :term:`BB_ENV_WHITELIST` and 1355 :term:`BB_ENV_PASSTHROUGH` and
1356 :term:`BB_ENV_EXTRAWHITE` variables. For 1356 :term:`BB_ENV_PASSTHROUGH_ADDITIONS` variables. For
1357 example, assume you want to prevent the build system from accessing 1357 example, assume you want to prevent the build system from accessing
1358 your ``$HOME/.ccache`` directory. The following command "whitelists" 1358 your ``$HOME/.ccache`` directory. The following command adds the
1359 the environment variable ``CCACHE_DIR`` causing BitBake to allow that 1359 the environment variable ``CCACHE_DIR`` to BitBake's passthrough
1360 variable into the datastore:: 1360 list to allow that variable into the datastore::
1361 1361
1362 export BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE CCACHE_DIR" 1362 export BB_ENV_PASSTHROUGH_ADDITIONS="$BB_ENV_PASSTHROUGH_ADDITIONS CCACHE_DIR"
1363 1363
1364#. Tell BitBake to export what you have loaded into the datastore to the 1364#. Tell BitBake to export what you have loaded into the datastore to the
1365 task environment of every running task. Loading something from the 1365 task environment of every running task. Loading something from the
@@ -1376,7 +1376,7 @@ environment, you must take these two steps:
1376 A side effect of the previous steps is that BitBake records the 1376 A side effect of the previous steps is that BitBake records the
1377 variable as a dependency of the build process in things like the 1377 variable as a dependency of the build process in things like the
1378 setscene checksums. If doing so results in unnecessary rebuilds of 1378 setscene checksums. If doing so results in unnecessary rebuilds of
1379 tasks, you can whitelist the variable so that the setscene code 1379 tasks, you can also flag the variable so that the setscene code
1380 ignores the dependency when it creates checksums. 1380 ignores the dependency when it creates checksums.
1381 1381
1382Sometimes, it is useful to be able to obtain information from the 1382Sometimes, it is useful to be able to obtain information from the
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 bdd4127a48..b2379e62af 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
@@ -236,23 +236,23 @@ overview of their function and contents.
236 based on the interval occur each time a respective interval is 236 based on the interval occur each time a respective interval is
237 reached beyond the initial warning (i.e. 1 Gbytes and 100 Kbytes). 237 reached beyond the initial warning (i.e. 1 Gbytes and 100 Kbytes).
238 238
239 :term:`BB_ENV_EXTRAWHITE` 239 :term:`BB_ENV_PASSTHROUGH_ADDITIONS`
240 Specifies an additional set of variables to allow through (whitelist) 240 Specifies an additional set of variables to allow through from the
241 from the external environment into BitBake's datastore. This list of 241 external environment into BitBake's datastore. This list of variables
242 variables are on top of the internal list set in 242 are on top of the internal list set in
243 :term:`BB_ENV_WHITELIST`. 243 :term:`BB_ENV_PASSTHROUGH`.
244 244
245 .. note:: 245 .. note::
246 246
247 You must set this variable in the external environment in order 247 You must set this variable in the external environment in order
248 for it to work. 248 for it to work.
249 249
250 :term:`BB_ENV_WHITELIST` 250 :term:`BB_ENV_PASSTHROUGH`
251 Specifies the internal whitelist of variables to allow through from 251 Specifies the internal list of variables to allow through from
252 the external environment into BitBake's datastore. If the value of 252 the external environment into BitBake's datastore. If the value of
253 this variable is not specified (which is the default), the following 253 this variable is not specified (which is the default), the following
254 list is used: :term:`BBPATH`, :term:`BB_PRESERVE_ENV`, 254 list is used: :term:`BBPATH`, :term:`BB_PRESERVE_ENV`,
255 :term:`BB_ENV_WHITELIST`, and :term:`BB_ENV_EXTRAWHITE`. 255 :term:`BB_ENV_PASSTHROUGH`, and :term:`BB_ENV_PASSTHROUGH_ADDITIONS`.
256 256
257 .. note:: 257 .. note::
258 258
@@ -452,8 +452,9 @@ overview of their function and contents.
452 452
453 :term:`BB_ORIGENV` 453 :term:`BB_ORIGENV`
454 Contains a copy of the original external environment in which BitBake 454 Contains a copy of the original external environment in which BitBake
455 was run. The copy is taken before any whitelisted variable values are 455 was run. The copy is taken before any variable values configured to
456 filtered into BitBake's datastore. 456 pass through from the external environment are filtered into BitBake's
457 datastore.
457 458
458 .. note:: 459 .. note::
459 460
@@ -461,8 +462,8 @@ overview of their function and contents.
461 queried using the normal datastore operations. 462 queried using the normal datastore operations.
462 463
463 :term:`BB_PRESERVE_ENV` 464 :term:`BB_PRESERVE_ENV`
464 Disables whitelisting and instead allows all variables through from 465 Disables environment filtering and instead allows all variables through
465 the external environment into BitBake's datastore. 466 from the external environment into BitBake's datastore.
466 467
467 .. note:: 468 .. note::
468 469