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>
This commit is contained in:
Quentin Schulz
2021-12-06 16:04:01 +01:00
committed by Richard Purdie
parent 99474e0d68
commit e71983bc7d
14 changed files with 151 additions and 159 deletions

View File

@@ -214,13 +214,13 @@ the class.
=====================
The ``blacklist`` class prevents the OpenEmbedded build system from
building specific recipes (blacklists them). To use this class, inherit
building specific recipes. To use this class, inherit
the class globally and set :term:`PNBLACKLIST` for
each recipe you wish to blacklist. Specify the :term:`PN`
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
example, if you want to blacklist a recipe called "exoticware", you add
the following to your ``local.conf`` or distribution configuration::
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."
@@ -845,10 +845,10 @@ provided by the recipe ``icecc-create-env-native.bb``.
icecc.
If you do not want the Icecream distributed compile support to apply to
specific recipes or classes, you can effectively "blacklist" them by
listing the recipes and classes using the
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_USER_CLASS_BL` variables,
respectively, in your ``local.conf`` file. Doing so causes the
OpenEmbedded build system to handle these compilations locally.

View File

@@ -112,7 +112,7 @@ Following is a list of supported recipes:
development headers and libraries to form a complete standalone SDK
and is suitable for development using the target.
- ``core-image-testmaster``: A "master" image designed to be used for
- ``core-image-testmaster``: A "controller" image designed to be used for
automated runtime testing. Provides a "known good" image that is
deployed to a separate partition so that you can boot into it and use
it to deploy a second image to be tested. You can find more

View File

@@ -404,7 +404,7 @@ universal, the list includes them just in case:
:term:`Upstream`
A reference to source code or repositories that are not
local to the development system but located in a master area that is
local to the development system but located in a remote area that is
controlled by the maintainer of the source code. For example, in
order for a developer to work on a particular piece of code, they
need to first get a copy of it from an "upstream" source.

View File

@@ -400,7 +400,7 @@ system and gives an overview of their function and contents.
where:
action is:
ABORT: Immediately abort the build when
ABORT: Immediately stop the build when
a threshold is broken.
STOPTASKS: Stop the build after the currently
executing tasks have finished when
@@ -438,7 +438,7 @@ system and gives an overview of their function and contents.
The first example works only if you also provide the
:term:`BB_DISKMON_WARNINTERVAL`
variable in the ``conf/local.conf``. This example causes the build
system to immediately abort when either the disk space in
system to immediately stop 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 issue a warning when the disk space
@@ -452,7 +452,7 @@ system and gives an 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 stops 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.
@@ -652,7 +652,7 @@ system and gives an 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:
.. code-block:: none
@@ -2894,9 +2894,9 @@ system and gives an overview of their function and contents.
:ref:`icecc <ref-classes-icecc>` class. You set this variable in
your ``local.conf`` file.
When you list classes using this variable, you are "blacklisting"
them from distributed compilation across remote hosts. Any classes
you list will be distributed and compiled locally.
When you list classes using this variable, the recipes inheriting
those classes will not benefit from distributed compilation across
remote hosts. Instead they will be built locally.
:term:`ICECC_USER_PACKAGE_BL`
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.
:ref:`icecc <ref-classes-icecc>` class. You set this variable in
your ``local.conf`` file.
When you list packages using this variable, you are "blacklisting"
them from distributed compilation across remote hosts. Any packages
you list will be distributed and compiled locally.
When you list recipes using this variable, you are excluding them
from distributed compilation across remote hosts. Instead they will
be built locally.
:term:`ICECC_USER_PACKAGE_WL`
Identifies user recipes that use an empty
@@ -4366,9 +4366,9 @@ system and gives an overview of their function and contents.
section in the Yocto Project Development Tasks Manual.
:term:`LICENSE_FLAGS`
Specifies additional flags for a recipe you must whitelist through
Specifies additional flags for a recipe you must allow through
:term:`LICENSE_FLAGS_WHITELIST` in
order to allow the recipe to be built. When providing multiple flags,
order for the recipe to be built. When providing multiple flags,
separate them with spaces.
This value is independent of :term:`LICENSE` and is
@@ -4381,8 +4381,7 @@ system and gives an overview of their function and contents.
:term:`LICENSE_FLAGS_WHITELIST`
Lists license flags that when specified in
:term:`LICENSE_FLAGS` within a recipe should not
prevent that recipe from being built. This practice is otherwise
known as "whitelisting" license flags. For more information, see the
prevent that recipe from being built. For more information, see the
":ref:`dev-manual/common-tasks:enabling commercially licensed recipes`"
section in the Yocto Project Development Tasks Manual.
@@ -5186,8 +5185,8 @@ system and gives an overview of their function and contents.
.. note::
You can use the :term:`PACKAGE_FEED_ARCHS`
variable to whitelist specific package architectures. If you do
not need to whitelist specific architectures, which is a common
variable to allow specific package architectures. If you do
not need to allow specific architectures, which is a common
case, you can omit this variable. Omitting the variable results in
all available architectures for the current machine being included
into remote package feeds.
@@ -6583,9 +6582,9 @@ system and gives an overview of their function and contents.
:ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class.
This list overrides the variables specified using the
:term:`SDK_LOCAL_CONF_BLACKLIST`
variable as well as any variables identified by automatic
blacklisting due to the "/" character being found at the start of the
:term:`SDK_LOCAL_CONF_BLACKLIST` variable as well as
other variables automatically added due to the "/" character
being found at the start of the
value, which is usually indicative of being a path and thus might not
be valid on the system where the SDK is installed.
@@ -8244,7 +8243,7 @@ system and gives an overview of their function and contents.
variable is used.
:term:`TUNEABI_WHITELIST`
A whitelist of permissible :term:`TUNEABI` values. If
A list of permissible :term:`TUNEABI` values. If
:term:`TUNEABI_WHITELIST` is not set, all tunes are allowed. Providers
that use prebuilt libraries can use the :term:`TUNEABI_WHITELIST`,
:term:`TUNEABI_OVERRIDE`, and :term:`TUNEABI`