manuals: inclusive language updates
PATCH 1/1 manuals: inclusive language updates
Changes identified by OE core's scripts/contrib/convert-variable-renames.py script
Original variable names are kept in old migration notes, but references to the new ones are provided.
Signed-off-by Michael Opdenacker <[email protected]>
--- documentation/bsp-guide/bsp.rst | 10 ++--- documentation/dev-manual/common-tasks.rst | 44 +++++++++---------- .../migration-guides/migration-2.2.rst | 4 +- .../migration-guides/migration-3.0.rst | 2 +- .../migration-guides/migration-3.4.rst | 3 +- documentation/overview-manual/concepts.rst | 8 ++-- documentation/ref-manual/classes.rst | 12 ++--- documentation/ref-manual/variables.rst | 44 +++++++++---------- .../sdk-manual/appendix-customizing.rst | 20 ++++----- 9 files changed, 74 insertions(+), 73 deletions(-)
documentation/bsp-guide/bsp.rst +5 -5
@@ -1113,7 +1113,7 @@ list describes them in order of preference: #. *Use the LICENSE_FLAGS Variable to Define the Recipes that Have Commercial or Other Types of Specially-Licensed Packages:* For each of those recipes, you can specify a matching license string in a ``local.conf`` variable named - :term:`LICENSE_FLAGS_WHITELIST`. + :term:`LICENSE_FLAGS_ACCEPTED`. Specifying the matching license string signifies that you agree to the license. Thus, the build system can build the corresponding recipe and include the component in the image. See the
@@ -1122,15 +1122,15 @@ list describes them in order of preference: how to use these variables. If you build as you normally would, without specifying any recipes in - the :term:`LICENSE_FLAGS_WHITELIST` variable, the build stops and provides + the :term:`LICENSE_FLAGS_ACCEPTED` variable, the build stops and provides you with the list of recipes that you have tried to include in the image - that need entries in the :term:`LICENSE_FLAGS_WHITELIST` variable. Once you + that need entries in the :term:`LICENSE_FLAGS_ACCEPTED` variable. Once you enter the appropriate license flags into it, restart the build to continue where it left off. During the build, the prompt will not appear again since you have satisfied the requirement. Once the appropriate license flags are on the white list in the - :term:`LICENSE_FLAGS_WHITELIST` variable, you can build the encumbered + :term:`LICENSE_FLAGS_ACCEPTED` variable, you can build the encumbered image with no change at all to the normal build process. #. *Get a Pre-Built Version of the BSP:* You can get this type of BSP by
@@ -1143,7 +1143,7 @@ list describes them in order of preference: click-through license agreements presented by the website. If you want to build the image yourself using the recipes contained within the BSP tarball, you will still need to create an appropriate - :term:`LICENSE_FLAGS_WHITELIST` to match the encumbered recipes in the + :term:`LICENSE_FLAGS_ACCEPTED` to match the encumbered recipes in the BSP. .. note::
documentation/dev-manual/common-tasks.rst +22 -22
146 lines not on this page · raw message
documentation/migration-guides/migration-2.2.rst +2 -2
@@ -26,8 +26,8 @@ Staging Directories in Sysroot Has Been Simplified The way directories are staged in sysroot has been simplified and introduces the new :term:`SYSROOT_DIRS`, -:term:`SYSROOT_DIRS_NATIVE`, and -:term:`SYSROOT_DIRS_BLACKLIST`. See the +:term:`SYSROOT_DIRS_NATIVE`, and ``SYSROOT_DIRS_BLACKLIST`` +(replaced by :term:`SYSROOT_DIRS_IGNORE` in version 3.5). See the :oe_lists:`v2 patch series on the OE-Core Mailing List </pipermail/openembedded-core/2016-May/121365.html>` for additional information.
documentation/migration-guides/migration-3.0.rst +1 -1
@@ -148,7 +148,7 @@ XML feeds that ``cve-check-tool`` was using, supports CVSSv3 scoring, and makes other improvements. Additionally, the ``CVE_CHECK_CVE_WHITELIST`` variable has been replaced -by ``CVE_CHECK_WHITELIST``. +by ``CVE_CHECK_WHITELIST`` (replaced by :term:`CVE_CHECK_IGNORE` in version 3.5). .. _migration-3.0-bitbake-changes:
documentation/migration-guides/migration-3.4.rst +2 -1
@@ -255,7 +255,8 @@ Miscellaneous - The previously deprecated ``COMPRESS_CMD`` and ``CVE_CHECK_CVE_WHITELIST`` variables have been removed. Use - ``CONVERSION_CMD`` and :term:`CVE_CHECK_WHITELIST` respectively + ``CONVERSION_CMD`` and ``CVE_CHECK_WHITELIST`` (replaced by + :term:`CVE_CHECK_IGNORE` in version 3.5) respectively instead. - The obsolete ``oe_machinstall`` function previously provided in the
documentation/overview-manual/concepts.rst +4 -4
@@ -1377,15 +1377,15 @@ associated with an extensible SDK: Specifies whether or not the toolchain is included when building the extensible SDK. -- :term:`SDK_LOCAL_CONF_WHITELIST`: +- :term:`ESDK_LOCALCONF_ALLOW`: A list of variables allowed through from the build system configuration into the extensible SDK configuration. -- :term:`SDK_LOCAL_CONF_BLACKLIST`: +- :term:`ESDK_LOCALCONF_REMOVE`: A list of variables not allowed through from the build system configuration into the extensible SDK configuration. -- :term:`SDK_INHERIT_BLACKLIST`: +- :term:`ESDK_CLASS_INHERIT_DISABLE`: A list of classes to remove from the :term:`INHERIT` value globally within the extensible SDK configuration.
@@ -1727,7 +1727,7 @@ it construct the basehash. The following statement effectively results in a list of global variable dependency excludes (i.e. variables never included in any checksum):: - 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 TERM \\ USER FILESPATH STAGING_DIR_HOST STAGING_DIR_TARGET COREBASE PRSERV_HOST \\ PRSERV_DUMPDIR PRSERV_DUMPFILE PRSERV_LOCKDOWN PARALLEL_MAKE \\
documentation/ref-manual/classes.rst +6 -6
@@ -215,7 +215,7 @@ the class. The ``blacklist`` class prevents the OpenEmbedded build system from building specific recipes. To use this class, inherit -the class globally and set :term:`PNBLACKLIST` for +the class globally and set :term:`SKIP_RECIPE` for each recipe you wish to ignore. Specify the :term:`PN` value as a variable flag (varflag) and provide a reason, which is reported, if the package is requested to be built as the value. For
@@ -223,7 +223,7 @@ example, if you want to ignore a recipe called "exoticware", you add the following to your ``local.conf`` or distribution configuration:: INHERIT += "blacklist" - PNBLACKLIST[exoticware] = "Not supported by our organization." + SKIP_RECIPE[exoticware] = "Not supported by our organization." .. _ref-classes-buildhistory:
@@ -846,13 +846,13 @@ provided by the recipe ``icecc-create-env-native.bb``. If you do not want the Icecream distributed compile support to apply to specific recipes or classes, you can ask them to be ignored by Icecream by listing the recipes and classes using the -:term:`ICECC_USER_PACKAGE_BL` and -:term:`ICECC_USER_CLASS_BL` variables, +:term:`ICECC_RECIPE_DISABLE` and +:term:`ICECC_CLASS_DISABLE` variables, respectively, in your ``local.conf`` file. Doing so causes the OpenEmbedded build system to handle these compilations locally. Additionally, you can list recipes using the -:term:`ICECC_USER_PACKAGE_WL` variable in +:term:`ICECC_RECIPE_ENABLE` variable in your ``local.conf`` file to force ``icecc`` to be enabled for recipes using an empty :term:`PARALLEL_MAKE` variable.
@@ -2515,7 +2515,7 @@ stages: subset of files is controlled by the :term:`SYSROOT_DIRS`, :term:`SYSROOT_DIRS_NATIVE`, and - :term:`SYSROOT_DIRS_BLACKLIST` + :term:`SYSROOT_DIRS_IGNORE` variables. .. note::
documentation/ref-manual/variables.rst +22 -22
162 lines not on this page · raw message
documentation/sdk-manual/appendix-customizing.rst +10 -10
@@ -21,7 +21,7 @@ build system applies them against ``local.conf`` and ``auto.conf``: specific to the :term:`Build Host`. - Variables listed in - :term:`SDK_LOCAL_CONF_BLACKLIST` + :term:`ESDK_LOCALCONF_REMOVE` are excluded. These variables are not allowed through from the OpenEmbedded build system configuration into the extensible SDK configuration. Typically, these variables are specific to the machine
@@ -29,19 +29,19 @@ build system applies them against ``local.conf`` and ``auto.conf``: of the extensible SDK configuration. For a list of the variables excluded by default, see the - :term:`SDK_LOCAL_CONF_BLACKLIST` + :term:`ESDK_LOCALCONF_REMOVE` in the glossary of the Yocto Project Reference Manual. - Variables listed in - :term:`SDK_LOCAL_CONF_WHITELIST` + :term:`ESDK_LOCALCONF_ALLOW` are included. Including a variable in the value of - :term:`SDK_LOCAL_CONF_WHITELIST` overrides either of the previous two + :term:`ESDK_LOCALCONF_ALLOW` overrides either of the previous two filters. The default value is blank. - Classes inherited globally with :term:`INHERIT` that are listed in - :term:`SDK_INHERIT_BLACKLIST` - are disabled. Using :term:`SDK_INHERIT_BLACKLIST` to disable these + :term:`ESDK_CLASS_INHERIT_DISABLE` + are disabled. Using :term:`ESDK_CLASS_INHERIT_DISABLE` to disable these classes is the typical method to disable classes that are problematic or unnecessary in the SDK context. The default value disables the :ref:`buildhistory <ref-classes-buildhistory>`
@@ -63,13 +63,13 @@ adjustments: - If your SDK configuration inherits additional classes using the :term:`INHERIT` variable and you do not need or want those classes enabled in the SDK, you can - disable them by adding them to the :term:`SDK_INHERIT_BLACKLIST` + disable them by adding them to the :term:`ESDK_CLASS_INHERIT_DISABLE` variable as described in the previous section. .. note:: The default value of - SDK_INHERIT_BLACKLIST + ESDK_CLASS_INHERIT_DISABLE is set using the "?=" operator. Consequently, you will need to either define the entire list by using the "=" operator, or you will need to append a value using either ":append" or the "+="
@@ -92,7 +92,7 @@ adjustments: - Disable the tasks if they are added by a class and you do not need the functionality the class provides in the extensible SDK. To - disable the tasks, add the class to the :term:`SDK_INHERIT_BLACKLIST` + disable the tasks, add the class to the :term:`ESDK_CLASS_INHERIT_DISABLE` variable as described in the previous section. - Generally, you want to have a shared state mirror set up so users of
@@ -277,7 +277,7 @@ source, you need to do a number of things: configuration file. You can then pass the variable to the SDK by adding the following:: - SDK_LOCAL_CONF_WHITELIST = "SSTATE_MIRRORS" + ESDK_LOCALCONF_ALLOW = "SSTATE_MIRRORS" - Alternatively, if you just want to set the :term:`SSTATE_MIRRORS` variable's value for the SDK alone, create a
Signature · 1 line
2.25.1