summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorQuentin Schulz <foss@0leil.net>2021-12-06 16:04:01 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-12-13 23:31:34 +0000
commite71983bc7dba65df6273faaad92c5a43afded0ff (patch)
treeb5882d468d58514fdf0e93a24c03fb916be63958 /documentation/ref-manual
parent99474e0d681cc9beb3604f214884054b3aec38a1 (diff)
downloadpoky-e71983bc7dba65df6273faaad92c5a43afded0ff.tar.gz
make the documentation a bit more inclusive
Except the name of variables which can't be changed only in the documentation for obvious reasons and workflow or developement explanations around the use of the "master" branch which cannot be replaced with "development" branch instead, most of the non-inclusive words that appear in https://inclusivenaming.org/word-lists/tier-1/ should have been replaced in this patch. (From yocto-docs rev: 2755f35060084f7af356091de9dc144f85530fe2) Signed-off-by: Quentin Schulz <foss+yocto@0leil.net> Reviewed-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.rst14
-rw-r--r--documentation/ref-manual/images.rst2
-rw-r--r--documentation/ref-manual/terms.rst2
-rw-r--r--documentation/ref-manual/variables.rst39
4 files changed, 28 insertions, 29 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index e258469dcb..2c191f407e 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -214,13 +214,13 @@ the class.
214===================== 214=====================
215 215
216The ``blacklist`` class prevents the OpenEmbedded build system from 216The ``blacklist`` class prevents the OpenEmbedded build system from
217building specific recipes (blacklists them). To use this class, inherit 217building specific recipes. To use this class, inherit
218the class globally and set :term:`PNBLACKLIST` for 218the class globally and set :term:`PNBLACKLIST` for
219each recipe you wish to blacklist. Specify the :term:`PN` 219each recipe you wish to ignore. Specify the :term:`PN`
220value as a variable flag (varflag) and provide a reason, which is 220value as a variable flag (varflag) and provide a reason, which is
221reported, if the package is requested to be built as the value. For 221reported, if the package is requested to be built as the value. For
222example, if you want to blacklist a recipe called "exoticware", you add 222example, if you want to ignore a recipe called "exoticware", you
223the following to your ``local.conf`` or distribution configuration:: 223add the following to your ``local.conf`` or distribution configuration::
224 224
225 INHERIT += "blacklist" 225 INHERIT += "blacklist"
226 PNBLACKLIST[exoticware] = "Not supported by our organization." 226 PNBLACKLIST[exoticware] = "Not supported by our organization."
@@ -845,10 +845,10 @@ provided by the recipe ``icecc-create-env-native.bb``.
845 icecc. 845 icecc.
846 846
847If you do not want the Icecream distributed compile support to apply to 847If you do not want the Icecream distributed compile support to apply to
848specific recipes or classes, you can effectively "blacklist" them by 848specific recipes or classes, you can ask them to be ignored by Icecream
849listing the recipes and classes using the 849by listing the recipes and classes using the
850:term:`ICECC_USER_PACKAGE_BL` and 850:term:`ICECC_USER_PACKAGE_BL` and
851:term:`ICECC_USER_CLASS_BL`, variables, 851:term:`ICECC_USER_CLASS_BL` variables,
852respectively, in your ``local.conf`` file. Doing so causes the 852respectively, in your ``local.conf`` file. Doing so causes the
853OpenEmbedded build system to handle these compilations locally. 853OpenEmbedded build system to handle these compilations locally.
854 854
diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst
index c6a7239c7e..0e3351bb7b 100644
--- a/documentation/ref-manual/images.rst
+++ b/documentation/ref-manual/images.rst
@@ -112,7 +112,7 @@ Following is a list of supported recipes:
112 development headers and libraries to form a complete standalone SDK 112 development headers and libraries to form a complete standalone SDK
113 and is suitable for development using the target. 113 and is suitable for development using the target.
114 114
115- ``core-image-testmaster``: A "master" image designed to be used for 115- ``core-image-testmaster``: A "controller" image designed to be used for
116 automated runtime testing. Provides a "known good" image that is 116 automated runtime testing. Provides a "known good" image that is
117 deployed to a separate partition so that you can boot into it and use 117 deployed to a separate partition so that you can boot into it and use
118 it to deploy a second image to be tested. You can find more 118 it to deploy a second image to be tested. You can find more
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index 89b140e3fe..09e0a98bb5 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -404,7 +404,7 @@ universal, the list includes them just in case:
404 404
405 :term:`Upstream` 405 :term:`Upstream`
406 A reference to source code or repositories that are not 406 A reference to source code or repositories that are not
407 local to the development system but located in a master area that is 407 local to the development system but located in a remote area that is
408 controlled by the maintainer of the source code. For example, in 408 controlled by the maintainer of the source code. For example, in
409 order for a developer to work on a particular piece of code, they 409 order for a developer to work on a particular piece of code, they
410 need to first get a copy of it from an "upstream" source. 410 need to first get a copy of it from an "upstream" source.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 83f39af2cf..e5216b3f36 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -400,7 +400,7 @@ system and gives an overview of their function and contents.
400 where: 400 where:
401 401
402 action is: 402 action is:
403 ABORT: Immediately abort the build when 403 ABORT: Immediately stop the build when
404 a threshold is broken. 404 a threshold is broken.
405 STOPTASKS: Stop the build after the currently 405 STOPTASKS: Stop the build after the currently
406 executing tasks have finished when 406 executing tasks have finished when
@@ -438,7 +438,7 @@ system and gives an overview of their function and contents.
438 The first example works only if you also provide the 438 The first example works only if you also provide the
439 :term:`BB_DISKMON_WARNINTERVAL` 439 :term:`BB_DISKMON_WARNINTERVAL`
440 variable in the ``conf/local.conf``. This example causes the build 440 variable in the ``conf/local.conf``. This example causes the build
441 system to immediately abort when either the disk space in 441 system to immediately stop when either the disk space in
442 ``${TMPDIR}`` drops below 1 Gbyte or the available free inodes drops 442 ``${TMPDIR}`` drops below 1 Gbyte or the available free inodes drops
443 below 100 Kbytes. Because two directories are provided with the 443 below 100 Kbytes. Because two directories are provided with the
444 variable, the build system also issue a warning when the disk space 444 variable, the build system also issue a warning when the disk space
@@ -452,7 +452,7 @@ system and gives an overview of their function and contents.
452 directory drops below 1 Gbyte. No disk monitoring occurs for the free 452 directory drops below 1 Gbyte. No disk monitoring occurs for the free
453 inodes in this case. 453 inodes in this case.
454 454
455 The final example immediately aborts the build when the number of 455 The final example immediately stops the build when the number of
456 free inodes in the ``${TMPDIR}`` directory drops below 100 Kbytes. No 456 free inodes in the ``${TMPDIR}`` directory drops below 100 Kbytes. No
457 disk space monitoring for the directory itself occurs in this case. 457 disk space monitoring for the directory itself occurs in this case.
458 458
@@ -652,7 +652,7 @@ system and gives an overview of their function and contents.
652 " 652 "
653 653
654 This next example shows an error message that occurs because invalid 654 This next example shows an error message that occurs because invalid
655 entries are found, which cause parsing to abort: 655 entries are found, which cause parsing to fail:
656 656
657 .. code-block:: none 657 .. code-block:: none
658 658
@@ -2894,9 +2894,9 @@ system and gives an overview of their function and contents.
2894 :ref:`icecc <ref-classes-icecc>` class. You set this variable in 2894 :ref:`icecc <ref-classes-icecc>` class. You set this variable in
2895 your ``local.conf`` file. 2895 your ``local.conf`` file.
2896 2896
2897 When you list classes using this variable, you are "blacklisting" 2897 When you list classes using this variable, the recipes inheriting
2898 them from distributed compilation across remote hosts. Any classes 2898 those classes will not benefit from distributed compilation across
2899 you list will be distributed and compiled locally. 2899 remote hosts. Instead they will be built locally.
2900 2900
2901 :term:`ICECC_USER_PACKAGE_BL` 2901 :term:`ICECC_USER_PACKAGE_BL`
2902 Identifies user recipes that you do not want the Icecream distributed 2902 Identifies user recipes that you do not want the Icecream distributed
@@ -2904,9 +2904,9 @@ system and gives an overview of their function and contents.
2904 :ref:`icecc <ref-classes-icecc>` class. You set this variable in 2904 :ref:`icecc <ref-classes-icecc>` class. You set this variable in
2905 your ``local.conf`` file. 2905 your ``local.conf`` file.
2906 2906
2907 When you list packages using this variable, you are "blacklisting" 2907 When you list recipes using this variable, you are excluding them
2908 them from distributed compilation across remote hosts. Any packages 2908 from distributed compilation across remote hosts. Instead they will
2909 you list will be distributed and compiled locally. 2909 be built locally.
2910 2910
2911 :term:`ICECC_USER_PACKAGE_WL` 2911 :term:`ICECC_USER_PACKAGE_WL`
2912 Identifies user recipes that use an empty 2912 Identifies user recipes that use an empty
@@ -4366,9 +4366,9 @@ system and gives an overview of their function and contents.
4366 section in the Yocto Project Development Tasks Manual. 4366 section in the Yocto Project Development Tasks Manual.
4367 4367
4368 :term:`LICENSE_FLAGS` 4368 :term:`LICENSE_FLAGS`
4369 Specifies additional flags for a recipe you must whitelist through 4369 Specifies additional flags for a recipe you must allow through
4370 :term:`LICENSE_FLAGS_WHITELIST` in 4370 :term:`LICENSE_FLAGS_WHITELIST` in
4371 order to allow the recipe to be built. When providing multiple flags, 4371 order for the recipe to be built. When providing multiple flags,
4372 separate them with spaces. 4372 separate them with spaces.
4373 4373
4374 This value is independent of :term:`LICENSE` and is 4374 This value is independent of :term:`LICENSE` and is
@@ -4381,8 +4381,7 @@ system and gives an overview of their function and contents.
4381 :term:`LICENSE_FLAGS_WHITELIST` 4381 :term:`LICENSE_FLAGS_WHITELIST`
4382 Lists license flags that when specified in 4382 Lists license flags that when specified in
4383 :term:`LICENSE_FLAGS` within a recipe should not 4383 :term:`LICENSE_FLAGS` within a recipe should not
4384 prevent that recipe from being built. This practice is otherwise 4384 prevent that recipe from being built. For more information, see the
4385 known as "whitelisting" license flags. For more information, see the
4386 ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`" 4385 ":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`"
4387 section in the Yocto Project Development Tasks Manual. 4386 section in the Yocto Project Development Tasks Manual.
4388 4387
@@ -5186,8 +5185,8 @@ system and gives an overview of their function and contents.
5186 .. note:: 5185 .. note::
5187 5186
5188 You can use the :term:`PACKAGE_FEED_ARCHS` 5187 You can use the :term:`PACKAGE_FEED_ARCHS`
5189 variable to whitelist specific package architectures. If you do 5188 variable to allow specific package architectures. If you do
5190 not need to whitelist specific architectures, which is a common 5189 not need to allow specific architectures, which is a common
5191 case, you can omit this variable. Omitting the variable results in 5190 case, you can omit this variable. Omitting the variable results in
5192 all available architectures for the current machine being included 5191 all available architectures for the current machine being included
5193 into remote package feeds. 5192 into remote package feeds.
@@ -6583,9 +6582,9 @@ system and gives an overview of their function and contents.
6583 :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class. 6582 :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class.
6584 6583
6585 This list overrides the variables specified using the 6584 This list overrides the variables specified using the
6586 :term:`SDK_LOCAL_CONF_BLACKLIST` 6585 :term:`SDK_LOCAL_CONF_BLACKLIST` variable as well as
6587 variable as well as any variables identified by automatic 6586 other variables automatically added due to the "/" character
6588 blacklisting due to the "/" character being found at the start of the 6587 being found at the start of the
6589 value, which is usually indicative of being a path and thus might not 6588 value, which is usually indicative of being a path and thus might not
6590 be valid on the system where the SDK is installed. 6589 be valid on the system where the SDK is installed.
6591 6590
@@ -8244,7 +8243,7 @@ system and gives an overview of their function and contents.
8244 variable is used. 8243 variable is used.
8245 8244
8246 :term:`TUNEABI_WHITELIST` 8245 :term:`TUNEABI_WHITELIST`
8247 A whitelist of permissible :term:`TUNEABI` values. If 8246 A list of permissible :term:`TUNEABI` values. If
8248 :term:`TUNEABI_WHITELIST` is not set, all tunes are allowed. Providers 8247 :term:`TUNEABI_WHITELIST` is not set, all tunes are allowed. Providers
8249 that use prebuilt libraries can use the :term:`TUNEABI_WHITELIST`, 8248 that use prebuilt libraries can use the :term:`TUNEABI_WHITELIST`,
8250 :term:`TUNEABI_OVERRIDE`, and :term:`TUNEABI` 8249 :term:`TUNEABI_OVERRIDE`, and :term:`TUNEABI`