diff options
Diffstat (limited to 'poky/bitbake/doc')
3 files changed, 40 insertions, 39 deletions
diff --git a/poky/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst b/poky/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst index 7b37f6615a..088eb818d6 100644 --- a/poky/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst +++ b/poky/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst @@ -79,8 +79,8 @@ directives. Prior to parsing configuration files, BitBake looks at certain variables, including: -- :term:`BB_ENV_WHITELIST` -- :term:`BB_ENV_EXTRAWHITE` +- :term:`BB_ENV_PASSTHROUGH` +- :term:`BB_ENV_PASSTHROUGH_ADDITIONS` - :term:`BB_PRESERVE_ENV` - :term:`BB_ORIGENV` - :term:`BITBAKE_UI` @@ -228,7 +228,7 @@ and then reload it. Where possible, subsequent BitBake commands reuse this cache of recipe information. The validity of this cache is determined by first computing a checksum of the base configuration data (see -:term:`BB_HASHCONFIG_WHITELIST`) and +:term:`BB_HASHCONFIG_IGNORE_VARS`) and then checking if the checksum matches. If that checksum matches what is in the cache and the recipe and class files have not changed, BitBake is able to use the cache. BitBake then reloads the cached information about @@ -477,7 +477,7 @@ changes because it should not affect the output for target packages. The simplistic approach for excluding the working directory is to set it to some fixed value and create the checksum for the "run" script. BitBake goes one step better and uses the -:term:`BB_HASHBASE_WHITELIST` variable +:term:`BB_BASEHASH_IGNORE_VARS` variable to define a list of variables that should never be included when generating the signatures. @@ -538,7 +538,7 @@ in a list of global variable dependency excludes - variables never included in any checksum. This example uses variables from OpenEmbedded to help illustrate the concept:: - BB_HASHBASE_WHITELIST ?= "TMPDIR FILE PATH PWD BB_TASKHASH BBPATH DL_DIR \ + BB_BASEHASH_IGNORE_VARS ?= "TMPDIR FILE PATH PWD BB_TASKHASH BBPATH DL_DIR \ SSTATE_DIR THISDIR FILESEXTRAPATHS FILE_DIRNAME HOME LOGNAME SHELL \ USER FILESPATH STAGING_DIR_HOST STAGING_DIR_TARGET COREBASE PRSERV_HOST \ PRSERV_DUMPDIR PRSERV_DUMPFILE PRSERV_LOCKDOWN PARALLEL_MAKE \ diff --git a/poky/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/poky/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst index 8496e1da53..174cac7818 100644 --- a/poky/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +++ b/poky/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst @@ -1343,8 +1343,8 @@ the build machine cannot influence the build. .. note:: By default, BitBake cleans the environment to include only those - things exported or listed in its whitelist to ensure that the build - environment is reproducible and consistent. You can prevent this + things exported or listed in its passthrough list to ensure that the + build environment is reproducible and consistent. You can prevent this "cleaning" by setting the :term:`BB_PRESERVE_ENV` variable. Consequently, if you do want something to get passed into the build task @@ -1352,14 +1352,14 @@ environment, you must take these two steps: #. Tell BitBake to load what you want from the environment into the datastore. You can do so through the - :term:`BB_ENV_WHITELIST` and - :term:`BB_ENV_EXTRAWHITE` variables. For + :term:`BB_ENV_PASSTHROUGH` and + :term:`BB_ENV_PASSTHROUGH_ADDITIONS` variables. For example, assume you want to prevent the build system from accessing - your ``$HOME/.ccache`` directory. The following command "whitelists" - the environment variable ``CCACHE_DIR`` causing BitBake to allow that - variable into the datastore:: + your ``$HOME/.ccache`` directory. The following command adds the + the environment variable ``CCACHE_DIR`` to BitBake's passthrough + list to allow that variable into the datastore:: - export BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE CCACHE_DIR" + export BB_ENV_PASSTHROUGH_ADDITIONS="$BB_ENV_PASSTHROUGH_ADDITIONS CCACHE_DIR" #. Tell BitBake to export what you have loaded into the datastore to the task environment of every running task. Loading something from the @@ -1376,7 +1376,7 @@ environment, you must take these two steps: A side effect of the previous steps is that BitBake records the variable as a dependency of the build process in things like the setscene checksums. If doing so results in unnecessary rebuilds of - tasks, you can whitelist the variable so that the setscene code + tasks, you can also flag the variable so that the setscene code ignores the dependency when it creates checksums. Sometimes, it is useful to be able to obtain information from the diff --git a/poky/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/poky/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst index 1bb55fc501..59a9de2fb8 100644 --- a/poky/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/poky/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst @@ -138,7 +138,7 @@ overview of their function and contents. where: <action> is: - ABORT: Immediately abort the build when + HALT: Immediately halt the build when a threshold is broken. STOPTASKS: Stop the build after the currently executing tasks have finished when @@ -169,13 +169,13 @@ overview of their function and contents. Here are some examples:: - BB_DISKMON_DIRS = "ABORT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K" + BB_DISKMON_DIRS = "HALT,${TMPDIR},1G,100K WARN,${SSTATE_DIR},1G,100K" BB_DISKMON_DIRS = "STOPTASKS,${TMPDIR},1G" - BB_DISKMON_DIRS = "ABORT,${TMPDIR},,100K" + BB_DISKMON_DIRS = "HALT,${TMPDIR},,100K" The first example works only if you also set the :term:`BB_DISKMON_WARNINTERVAL` - variable. This example causes the build system to immediately abort + variable. This example causes the build system to immediately halt when either the disk space in ``${TMPDIR}`` drops below 1 Gbyte or the available free inodes drops below 100 Kbytes. Because two directories are provided with the variable, the build system also @@ -189,7 +189,7 @@ overview of their function and contents. directory drops below 1 Gbyte. No disk monitoring occurs for the free inodes in this case. - The final example immediately aborts the build when the number of + The final example immediately halts the build when the number of free inodes in the ``${TMPDIR}`` directory drops below 100 Kbytes. No disk space monitoring for the directory itself occurs in this case. @@ -236,23 +236,23 @@ overview of their function and contents. based on the interval occur each time a respective interval is reached beyond the initial warning (i.e. 1 Gbytes and 100 Kbytes). - :term:`BB_ENV_EXTRAWHITE` - Specifies an additional set of variables to allow through (whitelist) - from the external environment into BitBake's datastore. This list of - variables are on top of the internal list set in - :term:`BB_ENV_WHITELIST`. + :term:`BB_ENV_PASSTHROUGH_ADDITIONS` + Specifies an additional set of variables to allow through from the + external environment into BitBake's datastore. This list of variables + are on top of the internal list set in + :term:`BB_ENV_PASSTHROUGH`. .. note:: You must set this variable in the external environment in order for it to work. - :term:`BB_ENV_WHITELIST` - Specifies the internal whitelist of variables to allow through from + :term:`BB_ENV_PASSTHROUGH` + Specifies the internal list of variables to allow through from the external environment into BitBake's datastore. If the value of this variable is not specified (which is the default), the following list is used: :term:`BBPATH`, :term:`BB_PRESERVE_ENV`, - :term:`BB_ENV_WHITELIST`, and :term:`BB_ENV_EXTRAWHITE`. + :term:`BB_ENV_PASSTHROUGH`, and :term:`BB_ENV_PASSTHROUGH_ADDITIONS`. .. note:: @@ -337,7 +337,7 @@ overview of their function and contents. For example usage, see :term:`BB_GIT_SHALLOW`. - :term:`BB_HASHBASE_WHITELIST` + :term:`BB_BASEHASH_IGNORE_VARS` Lists variables that are excluded from checksum and dependency data. Variables that are excluded can therefore change without affecting the checksum mechanism. A common example would be the variable for @@ -358,7 +358,7 @@ overview of their function and contents. However, the more accurate the data returned, the more efficient the build will be. - :term:`BB_HASHCONFIG_WHITELIST` + :term:`BB_HASHCONFIG_IGNORE_VARS` Lists variables that are excluded from base configuration checksum, which is used to determine if the cache can be reused. @@ -452,8 +452,9 @@ overview of their function and contents. :term:`BB_ORIGENV` Contains a copy of the original external environment in which BitBake - was run. The copy is taken before any whitelisted variable values are - filtered into BitBake's datastore. + was run. The copy is taken before any variable values configured to + pass through from the external environment are filtered into BitBake's + datastore. .. note:: @@ -461,8 +462,8 @@ overview of their function and contents. queried using the normal datastore operations. :term:`BB_PRESERVE_ENV` - Disables whitelisting and instead allows all variables through from - the external environment into BitBake's datastore. + Disables environment filtering and instead allows all variables through + from the external environment into BitBake's datastore. .. note:: @@ -734,7 +735,7 @@ overview of their function and contents. " This next example shows an error message that occurs because invalid - entries are found, which cause parsing to abort:: + entries are found, which cause parsing to fail:: ERROR: BBFILES_DYNAMIC entries must be of the form {!}<collection name>:<filename pattern>, not: /work/my-layer/bbappends/meta-security-isafw/*/*/*.bbappend @@ -1053,7 +1054,7 @@ overview of their function and contents. upstream source, and then locations specified by :term:`MIRRORS` in that order. - :term:`MULTI_PROVIDER_WHITELIST` + :term:`BB_MULTI_PROVIDER_ALLOWED` Allows you to suppress BitBake warnings caused when building two separate recipes that provide the same output. @@ -1179,10 +1180,10 @@ overview of their function and contents. your configuration:: PREMIRRORS:prepend = "\ - git://.*/.* http://downloads.yoctoproject.org/mirror/sources/ \n \ - ftp://.*/.* http://downloads.yoctoproject.org/mirror/sources/ \n \ - http://.*/.* http://downloads.yoctoproject.org/mirror/sources/ \n \ - https://.*/.* http://downloads.yoctoproject.org/mirror/sources/ \n" + git://.*/.* http://downloads.yoctoproject.org/mirror/sources/ \ + ftp://.*/.* http://downloads.yoctoproject.org/mirror/sources/ \ + http://.*/.* http://downloads.yoctoproject.org/mirror/sources/ \ + https://.*/.* http://downloads.yoctoproject.org/mirror/sources/" These changes cause the build system to intercept Git, FTP, HTTP, and HTTPS requests and direct them to the ``http://`` sources mirror. You can |