diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-03-07 15:41:51 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-03-16 14:25:01 +0000 |
commit | 809b96e9316076909345d0fa7866f5155aeee767 (patch) | |
tree | 16dff3a5e07aa005066bd11efccaea746a0752a9 /documentation/ref-manual | |
parent | 88e368dca48957314bca2a9a369dcde515953633 (diff) | |
download | poky-809b96e9316076909345d0fa7866f5155aeee767.tar.gz |
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.
(From yocto-docs rev: 1a35380ca80509fee036018a2bbb22ba9b44d47a)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/classes.rst | 8 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 38 |
2 files changed, 23 insertions, 23 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index e1e61c9c9f..e26e4343a1 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -828,13 +828,13 @@ provided by the recipe ``icecc-create-env-native.bb``. | |||
828 | If you do not want the Icecream distributed compile support to apply to | 828 | If you do not want the Icecream distributed compile support to apply to |
829 | specific recipes or classes, you can ask them to be ignored by Icecream | 829 | specific recipes or classes, you can ask them to be ignored by Icecream |
830 | by listing the recipes and classes using the | 830 | by listing the recipes and classes using the |
831 | :term:`ICECC_USER_PACKAGE_BL` and | 831 | :term:`ICECC_RECIPE_DISABLE` and |
832 | :term:`ICECC_USER_CLASS_BL` variables, | 832 | :term:`ICECC_CLASS_DISABLE` variables, |
833 | respectively, in your ``local.conf`` file. Doing so causes the | 833 | respectively, in your ``local.conf`` file. Doing so causes the |
834 | OpenEmbedded build system to handle these compilations locally. | 834 | OpenEmbedded build system to handle these compilations locally. |
835 | 835 | ||
836 | Additionally, you can list recipes using the | 836 | Additionally, you can list recipes using the |
837 | :term:`ICECC_USER_PACKAGE_WL` variable in | 837 | :term:`ICECC_RECIPE_ENABLE` variable in |
838 | your ``local.conf`` file to force ``icecc`` to be enabled for recipes | 838 | your ``local.conf`` file to force ``icecc`` to be enabled for recipes |
839 | using an empty :term:`PARALLEL_MAKE` variable. | 839 | using an empty :term:`PARALLEL_MAKE` variable. |
840 | 840 | ||
@@ -2497,7 +2497,7 @@ stages: | |||
2497 | subset of files is controlled by the | 2497 | subset of files is controlled by the |
2498 | :term:`SYSROOT_DIRS`, | 2498 | :term:`SYSROOT_DIRS`, |
2499 | :term:`SYSROOT_DIRS_NATIVE`, and | 2499 | :term:`SYSROOT_DIRS_NATIVE`, and |
2500 | :term:`SYSROOT_DIRS_BLACKLIST` | 2500 | :term:`SYSROOT_DIRS_IGNORE` |
2501 | variables. | 2501 | variables. |
2502 | 2502 | ||
2503 | .. note:: | 2503 | .. note:: |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index ee77ee27af..81a6a0b240 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -1472,16 +1472,16 @@ system and gives an overview of their function and contents. | |||
1472 | variable only in certain contexts (e.g. when building for kernel | 1472 | variable only in certain contexts (e.g. when building for kernel |
1473 | and kernel module recipes). | 1473 | and kernel module recipes). |
1474 | 1474 | ||
1475 | :term:`CVE_CHECK_PN_WHITELIST` | 1475 | :term:`CVE_CHECK_SKIP_RECIPE` |
1476 | The list of package names (:term:`PN`) for which | 1476 | The list of package names (:term:`PN`) for which |
1477 | CVEs (Common Vulnerabilities and Exposures) are ignored. | 1477 | CVEs (Common Vulnerabilities and Exposures) are ignored. |
1478 | 1478 | ||
1479 | :term:`CVE_CHECK_WHITELIST` | 1479 | :term:`CVE_CHECK_IGNORE` |
1480 | The list of CVE IDs which are ignored. Here is | 1480 | The list of CVE IDs which are ignored. Here is |
1481 | an example from the :oe_layerindex:`Python3 recipe</layerindex/recipe/23823>`:: | 1481 | an example from the :oe_layerindex:`Python3 recipe</layerindex/recipe/23823>`:: |
1482 | 1482 | ||
1483 | # This is windows only issue. | 1483 | # This is windows only issue. |
1484 | CVE_CHECK_WHITELIST += "CVE-2020-15523" | 1484 | CVE_CHECK_IGNORE += "CVE-2020-15523" |
1485 | 1485 | ||
1486 | :term:`CVE_PRODUCT` | 1486 | :term:`CVE_PRODUCT` |
1487 | In a recipe, defines the name used to match the recipe name | 1487 | In a recipe, defines the name used to match the recipe name |
@@ -2879,7 +2879,7 @@ system and gives an overview of their function and contents. | |||
2879 | this variable, the :ref:`icecc <ref-classes-icecc>` class attempts | 2879 | this variable, the :ref:`icecc <ref-classes-icecc>` class attempts |
2880 | to define it by locating ``icecc`` using ``which``. | 2880 | to define it by locating ``icecc`` using ``which``. |
2881 | 2881 | ||
2882 | :term:`ICECC_USER_CLASS_BL` | 2882 | :term:`ICECC_CLASS_DISABLE` |
2883 | Identifies user classes that you do not want the Icecream distributed | 2883 | Identifies user classes that you do not want the Icecream distributed |
2884 | compile support to consider. This variable is used by the | 2884 | compile support to consider. This variable is used by the |
2885 | :ref:`icecc <ref-classes-icecc>` class. You set this variable in | 2885 | :ref:`icecc <ref-classes-icecc>` class. You set this variable in |
@@ -2889,7 +2889,7 @@ system and gives an overview of their function and contents. | |||
2889 | those classes will not benefit from distributed compilation across | 2889 | those classes will not benefit from distributed compilation across |
2890 | remote hosts. Instead they will be built locally. | 2890 | remote hosts. Instead they will be built locally. |
2891 | 2891 | ||
2892 | :term:`ICECC_USER_PACKAGE_BL` | 2892 | :term:`ICECC_RECIPE_DISABLE` |
2893 | Identifies user recipes that you do not want the Icecream distributed | 2893 | Identifies user recipes that you do not want the Icecream distributed |
2894 | compile support to consider. This variable is used by the | 2894 | compile support to consider. This variable is used by the |
2895 | :ref:`icecc <ref-classes-icecc>` class. You set this variable in | 2895 | :ref:`icecc <ref-classes-icecc>` class. You set this variable in |
@@ -2899,7 +2899,7 @@ system and gives an overview of their function and contents. | |||
2899 | from distributed compilation across remote hosts. Instead they will | 2899 | from distributed compilation across remote hosts. Instead they will |
2900 | be built locally. | 2900 | be built locally. |
2901 | 2901 | ||
2902 | :term:`ICECC_USER_PACKAGE_WL` | 2902 | :term:`ICECC_RECIPE_ENABLE` |
2903 | Identifies user recipes that use an empty | 2903 | Identifies user recipes that use an empty |
2904 | :term:`PARALLEL_MAKE` variable that you want to | 2904 | :term:`PARALLEL_MAKE` variable that you want to |
2905 | force remote distributed compilation on using the Icecream | 2905 | force remote distributed compilation on using the Icecream |
@@ -4375,7 +4375,7 @@ system and gives an overview of their function and contents. | |||
4375 | 4375 | ||
4376 | :term:`LICENSE_FLAGS` | 4376 | :term:`LICENSE_FLAGS` |
4377 | Specifies additional flags for a recipe you must allow through | 4377 | Specifies additional flags for a recipe you must allow through |
4378 | :term:`LICENSE_FLAGS_WHITELIST` in | 4378 | :term:`LICENSE_FLAGS_ACCEPTED` in |
4379 | order for the recipe to be built. When providing multiple flags, | 4379 | order for the recipe to be built. When providing multiple flags, |
4380 | separate them with spaces. | 4380 | separate them with spaces. |
4381 | 4381 | ||
@@ -4386,7 +4386,7 @@ system and gives an overview of their function and contents. | |||
4386 | ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" | 4386 | ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" |
4387 | section in the Yocto Project Development Tasks Manual. | 4387 | section in the Yocto Project Development Tasks Manual. |
4388 | 4388 | ||
4389 | :term:`LICENSE_FLAGS_WHITELIST` | 4389 | :term:`LICENSE_FLAGS_ACCEPTED` |
4390 | Lists license flags that when specified in | 4390 | Lists license flags that when specified in |
4391 | :term:`LICENSE_FLAGS` within a recipe should not | 4391 | :term:`LICENSE_FLAGS` within a recipe should not |
4392 | prevent that recipe from being built. For more information, see the | 4392 | prevent that recipe from being built. For more information, see the |
@@ -6548,13 +6548,13 @@ system and gives an overview of their function and contents. | |||
6548 | :term:`SDK_EXT_TYPE` is set to "minimal", and defaults to "1" if | 6548 | :term:`SDK_EXT_TYPE` is set to "minimal", and defaults to "1" if |
6549 | :term:`SDK_EXT_TYPE` is set to "full". | 6549 | :term:`SDK_EXT_TYPE` is set to "full". |
6550 | 6550 | ||
6551 | :term:`SDK_INHERIT_BLACKLIST` | 6551 | :term:`ESDK_CLASS_INHERIT_DISABLE` |
6552 | A list of classes to remove from the :term:`INHERIT` | 6552 | A list of classes to remove from the :term:`INHERIT` |
6553 | value globally within the extensible SDK configuration. The | 6553 | value globally within the extensible SDK configuration. The |
6554 | :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the | 6554 | :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the |
6555 | default value:: | 6555 | default value:: |
6556 | 6556 | ||
6557 | SDK_INHERIT_BLACKLIST ?= "buildhistory icecc" | 6557 | ESDK_CLASS_INHERIT_DISABLE ?= "buildhistory icecc" |
6558 | 6558 | ||
6559 | Some classes are not generally applicable within the extensible SDK | 6559 | Some classes are not generally applicable within the extensible SDK |
6560 | context. You can use this variable to disable those classes. | 6560 | context. You can use this variable to disable those classes. |
@@ -6565,14 +6565,14 @@ system and gives an overview of their function and contents. | |||
6565 | section in the Yocto Project Application Development and the | 6565 | section in the Yocto Project Application Development and the |
6566 | Extensible Software Development Kit (eSDK) manual. | 6566 | Extensible Software Development Kit (eSDK) manual. |
6567 | 6567 | ||
6568 | :term:`SDK_LOCAL_CONF_BLACKLIST` | 6568 | :term:`ESDK_LOCALCONF_REMOVE` |
6569 | A list of variables not allowed through from the OpenEmbedded build | 6569 | A list of variables not allowed through from the OpenEmbedded build |
6570 | system configuration into the extensible SDK configuration. Usually, | 6570 | system configuration into the extensible SDK configuration. Usually, |
6571 | these are variables that are specific to the machine on which the | 6571 | these are variables that are specific to the machine on which the |
6572 | build system is running and thus would be potentially problematic | 6572 | build system is running and thus would be potentially problematic |
6573 | within the extensible SDK. | 6573 | within the extensible SDK. |
6574 | 6574 | ||
6575 | By default, :term:`SDK_LOCAL_CONF_BLACKLIST` is set in the | 6575 | By default, :term:`ESDK_LOCALCONF_REMOVE` is set in the |
6576 | :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class and | 6576 | :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class and |
6577 | excludes the following variables: | 6577 | excludes the following variables: |
6578 | 6578 | ||
@@ -6591,14 +6591,14 @@ system and gives an overview of their function and contents. | |||
6591 | section in the Yocto Project Application Development and the | 6591 | section in the Yocto Project Application Development and the |
6592 | Extensible Software Development Kit (eSDK) manual. | 6592 | Extensible Software Development Kit (eSDK) manual. |
6593 | 6593 | ||
6594 | :term:`SDK_LOCAL_CONF_WHITELIST` | 6594 | :term:`ESDK_LOCALCONF_ALLOW` |
6595 | A list of variables allowed through from the OpenEmbedded build | 6595 | A list of variables allowed through from the OpenEmbedded build |
6596 | system configuration into the extensible SDK configuration. By | 6596 | system configuration into the extensible SDK configuration. By |
6597 | default, the list of variables is empty and is set in the | 6597 | default, the list of variables is empty and is set in the |
6598 | :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class. | 6598 | :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class. |
6599 | 6599 | ||
6600 | This list overrides the variables specified using the | 6600 | This list overrides the variables specified using the |
6601 | :term:`SDK_LOCAL_CONF_BLACKLIST` variable as well as | 6601 | :term:`ESDK_LOCALCONF_REMOVE` variable as well as |
6602 | other variables automatically added due to the "/" character | 6602 | other variables automatically added due to the "/" character |
6603 | being found at the start of the | 6603 | being found at the start of the |
6604 | value, which is usually indicative of being a path and thus might not | 6604 | value, which is usually indicative of being a path and thus might not |
@@ -7506,14 +7506,14 @@ system and gives an overview of their function and contents. | |||
7506 | /sysroot-only \ | 7506 | /sysroot-only \ |
7507 | " | 7507 | " |
7508 | 7508 | ||
7509 | :term:`SYSROOT_DIRS_BLACKLIST` | 7509 | :term:`SYSROOT_DIRS_IGNORE` |
7510 | Directories that are not staged into the sysroot by the | 7510 | Directories that are not staged into the sysroot by the |
7511 | :ref:`ref-tasks-populate_sysroot` task. You | 7511 | :ref:`ref-tasks-populate_sysroot` task. You |
7512 | can use this variable to exclude certain subdirectories of | 7512 | can use this variable to exclude certain subdirectories of |
7513 | directories listed in :term:`SYSROOT_DIRS` from | 7513 | directories listed in :term:`SYSROOT_DIRS` from |
7514 | staging. By default, the following directories are not staged:: | 7514 | staging. By default, the following directories are not staged:: |
7515 | 7515 | ||
7516 | SYSROOT_DIRS_BLACKLIST = " \ | 7516 | SYSROOT_DIRS_IGNORE = " \ |
7517 | ${mandir} \ | 7517 | ${mandir} \ |
7518 | ${docdir} \ | 7518 | ${docdir} \ |
7519 | ${infodir} \ | 7519 | ${infodir} \ |
@@ -8426,7 +8426,7 @@ system and gives an overview of their function and contents. | |||
8426 | passes and uses "all" for the target during the U-Boot building | 8426 | passes and uses "all" for the target during the U-Boot building |
8427 | process. | 8427 | process. |
8428 | 8428 | ||
8429 | :term:`UNKNOWN_CONFIGURE_WHITELIST` | 8429 | :term:`UNKNOWN_CONFIGURE_OPT_IGNORE` |
8430 | Specifies a list of options that, if reported by the configure script | 8430 | Specifies a list of options that, if reported by the configure script |
8431 | as being invalid, should not generate a warning during the | 8431 | as being invalid, should not generate a warning during the |
8432 | :ref:`ref-tasks-configure` task. Normally, invalid | 8432 | :ref:`ref-tasks-configure` task. Normally, invalid |
@@ -8436,10 +8436,10 @@ system and gives an overview of their function and contents. | |||
8436 | However, there are common options that are passed to all | 8436 | However, there are common options that are passed to all |
8437 | configure scripts at a class level, but might not be valid for some | 8437 | configure scripts at a class level, but might not be valid for some |
8438 | configure scripts. Therefore warnings about these options are useless. | 8438 | configure scripts. Therefore warnings about these options are useless. |
8439 | For these cases, the options are added to :term:`UNKNOWN_CONFIGURE_WHITELIST`. | 8439 | For these cases, the options are added to :term:`UNKNOWN_CONFIGURE_OPT_IGNORE`. |
8440 | 8440 | ||
8441 | The configure arguments check that uses | 8441 | The configure arguments check that uses |
8442 | :term:`UNKNOWN_CONFIGURE_WHITELIST` is part of the | 8442 | :term:`UNKNOWN_CONFIGURE_OPT_IGNORE` is part of the |
8443 | :ref:`insane <ref-classes-insane>` class and is only enabled if the | 8443 | :ref:`insane <ref-classes-insane>` class and is only enabled if the |
8444 | recipe inherits the :ref:`autotools <ref-classes-autotools>` class. | 8444 | recipe inherits the :ref:`autotools <ref-classes-autotools>` class. |
8445 | 8445 | ||