Inclusive language: Difference between revisions
From Yocto Project
Jump to navigationJump to search
| (20 intermediate revisions by 6 users not shown) | |||
| Line 4: | Line 4: | ||
https://lists.openembedded.org/g/openembedded-architecture/topic/inclusive_language_summary/75821819 | https://lists.openembedded.org/g/openembedded-architecture/topic/inclusive_language_summary/75821819 | ||
This is an attempt to collate Inclusive Language for OpenEmbedded and the Yocto Project in regards to code. | This is an attempt to collate Inclusive Language for OpenEmbedded and the Yocto Project in regards to code. This is an attempt to improve these variables, comments, and terminology to be more descriptive and also inclusive/ not offensive. | ||
For reference: https://inclusivenaming.org/word-lists/overview/ | For reference: https://inclusivenaming.org/word-lists/overview/ | ||
= Game play= | = Game play= | ||
| Line 34: | Line 34: | ||
=Exceptions= | =Exceptions= | ||
Exceptions for introducing new usage is limited upstream sources outside the control of The Yocto Project and OpenEmbedded. | Exceptions for introducing new usage is limited upstream sources outside the control of The Yocto Project and OpenEmbedded. | ||
Branch names, like master, are not being handled on the initial phase of this task | |||
=Classes= | =Classes= | ||
| Line 40: | Line 42: | ||
!Repo | !Repo | ||
!Current name | !Current name | ||
! | !Approved rename | ||
!Recommended by | !Recommended by | ||
|- | |- | ||
|core | |core | ||
| Line 48: | Line 49: | ||
|excludelist.bbclass | |excludelist.bbclass | ||
| Armin | | Armin | ||
|- | |- | ||
|core | |core | ||
| Line 54: | Line 54: | ||
|forcerecipeskip.bbclass | |forcerecipeskip.bbclass | ||
|Saul | |Saul | ||
|} | |} | ||
| Line 62: | Line 61: | ||
!Repo | !Repo | ||
!Current name | !Current name | ||
! | !Approved rename | ||
!Recommended by | !Recommended by | ||
! | !Volunteer Developer | ||
!Notes | !Notes | ||
|- | |- | ||
| Line 71: | Line 70: | ||
|"HALT", "NO_NEW_TASKS" or "WARN" | |"HALT", "NO_NEW_TASKS" or "WARN" | ||
|Richard Purdie | |Richard Purdie | ||
| | |Scott Murray | ||
| | | | ||
|- | |- | ||
| Line 78: | Line 77: | ||
|Should be changed in the code | |Should be changed in the code | ||
|Richard Purdie | |Richard Purdie | ||
| | |Scott Murray | ||
| | | | ||
|- | |- | ||
| Line 85: | Line 84: | ||
|BB_ENV_PASSTHROUGH | |BB_ENV_PASSTHROUGH | ||
|Richard Purdie | |Richard Purdie | ||
| | |Scott Murray | ||
| | | | ||
|- | |- | ||
|Bitbake | |Bitbake | ||
|BB_ENV_EXTRAWHITE | |BB_ENV_EXTRAWHITE | ||
|BB_ENV_PASSTHROUGH_ADDITIONS | |BB_ENV_PASSTHROUGH_ADDITIONS | ||
|Richard Purdie | |Richard Purdie | ||
| | |Scott Murray | ||
| | | | ||
|- | |- | ||
| Line 99: | Line 98: | ||
|BB_HASHCONFIG_IGNORE_VARS | |BB_HASHCONFIG_IGNORE_VARS | ||
|Richard Purdie | |Richard Purdie | ||
| | |Scott Murray | ||
| | | | ||
|- | |- | ||
| Line 113: | Line 112: | ||
|BB_SETSCENE_ENFORCE_IGNORE_TASKS | |BB_SETSCENE_ENFORCE_IGNORE_TASKS | ||
|Richard Purdie | |Richard Purdie | ||
| | |Scott Murray | ||
| | | | ||
|- | |- | ||
| Line 120: | Line 119: | ||
|BB_BASEHASH_IGNORE_VARS | |BB_BASEHASH_IGNORE_VARS | ||
|Richard Purdie | |Richard Purdie | ||
| | |Scott Murray | ||
| | |||
|- | |||
|Bitbake | |||
|BB_HASHTASK_WHITELIST | |||
|BB_TASKHASH_IGNORE_TASKS | |||
|Richard Purdie | |||
|Scott Murray | |||
| | | | ||
|- | |- | ||
| Line 127: | Line 133: | ||
|BB_MULTI_PROVIDER_ALLOWED | |BB_MULTI_PROVIDER_ALLOWED | ||
|Richard Purdie | |Richard Purdie | ||
| | |Scott Murray | ||
|- | |- | ||
|Bitbake | |Bitbake | ||
| Line 133: | Line 139: | ||
| | | | ||
| | | | ||
| | |Scott Murray | ||
| | | | ||
|- | |- | ||
| Line 140: | Line 146: | ||
| | | | ||
| | | | ||
| | |Scott Murray | ||
| | | | ||
|- | |- | ||
| Line 154: | Line 160: | ||
|See notes | |See notes | ||
|Richard Purdie | |Richard Purdie | ||
| | |Saul | ||
|For PNBLACKLIST and blacklist.bbclass, I think we need to take the opportunity | |For PNBLACKLIST and blacklist.bbclass, I think we need to take the opportunity | ||
to use "recipe" instead of "pn". For blacklist.bbclass, perhaps we just merge | to use "recipe" instead of "pn". For blacklist.bbclass, perhaps we just merge | ||
| Line 182: | Line 188: | ||
|core | |core | ||
|SSTATE_DUPWHITELIST | |SSTATE_DUPWHITELIST | ||
| | |SSTATE_ALLOW_OVERLAP_FILES | ||
| | |Richard Purdie | ||
| | |Saul | ||
| | | | ||
|- | |- | ||
|core | |core | ||
|CVE_CHECK_PN_WHITELIST | |CVE_CHECK_PN_WHITELIST | ||
| | |CVE_CHECK_SKIP_RECIPE | ||
| | |Richard Purdie | ||
|Marta | |||
| | | | ||
|- | |||
|core | |||
|CVE_CHECK_WHITELIST | |||
|CVE_CHECK_IGNORE | |||
|Richard Purdie | |||
|Marta | |||
| | | | ||
|- | |- | ||
| Line 199: | Line 212: | ||
| Michael Opdenacker | | Michael Opdenacker | ||
| | | | ||
| | |Should be removed | ||
|- | |- | ||
|core | |core | ||
| Line 206: | Line 219: | ||
| Michael Opdenacker | | Michael Opdenacker | ||
| | | | ||
| | |Should be removed | ||
|- | |- | ||
|core | |core | ||
| Line 213: | Line 226: | ||
| Michael Opdenacker | | Michael Opdenacker | ||
| | | | ||
| | |Should be removed | ||
|- | |- | ||
|core | |core | ||
|SYSROOT_DIRS_BLACKLIST | |SYSROOT_DIRS_BLACKLIST | ||
| | |SYSROOT_DIRS_IGNORE | ||
| | |Richard Purdie | ||
| | |Marta | ||
| | | | ||
|- | |- | ||
|core | |core | ||
|INHERIT_BLACKLIST | |INHERIT_BLACKLIST | ||
| | |INHERIT_RECIPE_SKIP | ||
|Saul | |Saul | ||
| | |Saul | ||
| | |if we drop the blacklist class, we can drop this too (RP) | ||
|- | |- | ||
|core | |core | ||
|SDK_LOCAL_CONF_BLACKLIST | |SDK_LOCAL_CONF_BLACKLIST | ||
| | |ESDK_LOCALCONF_REMOVE | ||
|Richard Purdie | |||
|Saul | |Saul | ||
| | | | ||
|- | |- | ||
|core | |core | ||
|SDK_LOCAL_CONF_WHITELIST | |SDK_LOCAL_CONF_WHITELIST | ||
| | |ESDK_LOCALCONF_ALLOW | ||
|Richard Purdie | |||
|Saul | |Saul | ||
| | | | ||
|- | |- | ||
|core | |core | ||
|SDK_INHERIT_BLACKLIST | |SDK_INHERIT_BLACKLIST | ||
| | |ESDK_CLASS_INHERIT_DISABLE | ||
|Richard Purdie | |||
|Saul | |Saul | ||
| | | | ||
|- | |- | ||
|core | |core | ||
| | |WHITELIST_(ANY LICENSE) | ||
| | | | ||
|Saul | |Saul | ||
|Saul | |Saul | ||
| | | Should be removed and replaced with INCOMPATIBLE_LICENSE_ALLOWED_RECIPES, which would be a list of recipes which are of a blocked license that is now being overridden | ||
|- | |- | ||
|core | |core | ||
|LICENSE_FLAGS_WHITELIST | |LICENSE_FLAGS_WHITELIST | ||
| | |LICENSE_FLAGS_ACCEPTED (and BLOCKED) | ||
|Saul | |||
|Saul | |Saul | ||
| | | Should be changed to | ||
|- | |- | ||
|core | |core | ||
|UNKNOWN_CONFIGURE_WHITELIST | |UNKNOWN_CONFIGURE_WHITELIST | ||
| | |UNKNOWN_CONFIGURE_OPT_IGNORE | ||
|Richard Purdie | |||
|Saul | |Saul | ||
| | |||
|- | |||
| | |||
|TUNEABI_WHITELIST | |||
| | |||
| | | | ||
| | | | ||
|Removed | |||
|- | |- | ||
|} | |} | ||
| Line 295: | Line 301: | ||
!Approved name | !Approved name | ||
|- | |- | ||
| | |Bitbake | ||
|test_setscenewhitelist | |test_setscenewhitelist | ||
| | | | ||
| Line 311: | Line 317: | ||
!Recommended by | !Recommended by | ||
!Approved name | !Approved name | ||
!Volunteer | |||
|- | |- | ||
|core | |core | ||
| Line 317: | Line 324: | ||
|11_tcpd_blocklist.patch | |11_tcpd_blocklist.patch | ||
|Saul Wold | |Saul Wold | ||
| | |as recommended | ||
|Saul | |||
|- | |- | ||
|core | |core | ||
| Line 324: | Line 332: | ||
|mount.disallow | |mount.disallow | ||
|Saul Wold | |Saul Wold | ||
| | |as recommended | ||
|Saul | |||
|- | |- | ||
|oe | |oe | ||
| Line 331: | Line 340: | ||
|0001-lxdm.conf.in-deny-root-for-release-images.patch | |0001-lxdm.conf.in-deny-root-for-release-images.patch | ||
|Saul Wold | |Saul Wold | ||
| | |as recommended | ||
|Saul | |||
|- | |- | ||
|oe | |oe | ||
| Line 338: | Line 348: | ||
|022-RH-Remove-the-default-property-exception-builtin.patch | |022-RH-Remove-the-default-property-exception-builtin.patch | ||
|Saul Wold | |Saul Wold | ||
| | |as recommended | ||
|Saul | |||
|- | |- | ||
|oe | |oe | ||
| Line 345: | Line 356: | ||
|0001-Cargo.toml-do-not-exit-on-panic.patch | |0001-Cargo.toml-do-not-exit-on-panic.patch | ||
|Saul Wold | |Saul Wold | ||
| | |as recommended | ||
|Saul | |||
|- | |- | ||
|oe | |oe | ||
| Line 352: | Line 364: | ||
|0004-Cargo.toml-do-not-exit-on-panic.patch | |0004-Cargo.toml-do-not-exit-on-panic.patch | ||
|Saul Wold | |Saul Wold | ||
| | |as recommended | ||
|Saul | |||
|- | |- | ||
|meta-integrity | |meta-integrity | ||
| Line 359: | Line 372: | ||
|ima_signing_blocklist | |ima_signing_blocklist | ||
|Saul Wold | |Saul Wold | ||
| | |as recommended | ||
|Saul | |||
|- | |- | ||
|meta-efi-secure-boot | |meta-efi-secure-boot | ||
| Line 366: | Line 380: | ||
|Fix-the-wrong-dependency-esl-file.patch | |Fix-the-wrong-dependency-esl-file.patch | ||
|Saul Wold | |Saul Wold | ||
| | |as recommended | ||
|Saul | |||
|- | |- | ||
|meta-raspberrypi | |meta-raspberrypi | ||
| Line 373: | Line 388: | ||
|0005-Don-t-return-gst_omx_video_dec_set_format-if-there-s-.patch | |0005-Don-t-return-gst_omx_video_dec_set_format-if-there-s-.patch | ||
|Saul Wold | |Saul Wold | ||
| | |as recommended | ||
|Saul | |||
|} | |} | ||
=Migration= | |||
A warning mechanism will be added to bitbake to detect the issue (post processing), except for BB_ENV issues. | |||
A (limited) conversation script will be created to help with the migration. For those instances where a 1-1 mapping is not achievable, a list of the occurrences and what it should be changed to will occur. | |||
=Notes= | =Notes= | ||
Latest revision as of 15:34, 17 February 2022
Inclusive Language
First time topic was explored on mailing list. https://lists.openembedded.org/g/openembedded-architecture/topic/inclusive_language_summary/75821819
This is an attempt to collate Inclusive Language for OpenEmbedded and the Yocto Project in regards to code. This is an attempt to improve these variables, comments, and terminology to be more descriptive and also inclusive/ not offensive.
For reference: https://inclusivenaming.org/word-lists/overview/
Game play
If a BB variable has a local assignment, the rename should be transitive. Example: BB_HASHBASE_WHITELIST is changed to BB_HASHBASE_ALLOWLIST, then self.basewhitelist would become self.baseallowlist
Add an offending name in one of the three tables below. If you have a suggested replacement, please add. If the translation is approved, that will be noted in the same row. Approval process: TBD
Recommendations
Recommended replacements for 'blacklist/whitelist' are:
| blacklist | whitelist |
|---|---|
| denylist/disallowlist | allowlist |
| blocklist | passlist or welcomelist |
| excludes or excludelist | includes or includelist |
Exceptions
Exceptions for introducing new usage is limited upstream sources outside the control of The Yocto Project and OpenEmbedded.
Branch names, like master, are not being handled on the initial phase of this task
Classes
| Repo | Current name | Approved rename | Recommended by |
|---|---|---|---|
| core | blacklist.bbclass | excludelist.bbclass | Armin |
| core | blacklist.bbclass (alt) | forcerecipeskip.bbclass | Saul |
Variables
| Repo | Current name | Approved rename | Recommended by | Volunteer Developer | Notes |
|---|---|---|---|---|---|
| Bitbake | ABORT | "HALT", "NO_NEW_TASKS" or "WARN" | Richard Purdie | Scott Murray | |
| Bitbake | abort (comment or variable) | Should be changed in the code | Richard Purdie | Scott Murray | |
| Bitbake | BB_ENV_WHITELIST | BB_ENV_PASSTHROUGH | Richard Purdie | Scott Murray | |
| Bitbake | BB_ENV_EXTRAWHITE | BB_ENV_PASSTHROUGH_ADDITIONS | Richard Purdie | Scott Murray | |
| Bitbake | BB_HASHCONFIG_WHITELIST | BB_HASHCONFIG_IGNORE_VARS | Richard Purdie | Scott Murray | |
| Bitbake | BB_STAMP_WHITELIST | remove this along with BB_STAMP_POLICY | Richard Purdie | ||
| Bitbake | BB_SETSCENE_ENFORCE_WHITELIST | BB_SETSCENE_ENFORCE_IGNORE_TASKS | Richard Purdie | Scott Murray | |
| Bitbake | BB_HASHBASE_WHITELIST | BB_BASEHASH_IGNORE_VARS | Richard Purdie | Scott Murray | |
| Bitbake | BB_HASHTASK_WHITELIST | BB_TASKHASH_IGNORE_TASKS | Richard Purdie | Scott Murray | |
| Bitbake | MULTI_PROVIDER_WHITELIST | BB_MULTI_PROVIDER_ALLOWED | Richard Purdie | Scott Murray | |
| Bitbake | basewhitelist | Scott Murray | |||
| Bitbake | taskwhitelist | Scott Murray | |||
| core | abort (comment or variable) | based on context | Saul Wold | ||
| core | PNBLACKLIST | See notes | Richard Purdie | Saul | For PNBLACKLIST and blacklist.bbclass, I think we need to take the opportunity
to use "recipe" instead of "pn". For blacklist.bbclass, perhaps we just merge into base.bbclass and use SKIP_RECIPE[pn] ? |
| core | whitelist | allowlist | Saul | This could be change based on context | |
| core | whitelisted | allowed | Saul | Context sensitive | |
| core | whitelisting | allowing | Saul | ||
| core | SSTATE_DUPWHITELIST | SSTATE_ALLOW_OVERLAP_FILES | Richard Purdie | Saul | |
| core | CVE_CHECK_PN_WHITELIST | CVE_CHECK_SKIP_RECIPE | Richard Purdie | Marta | |
| core | CVE_CHECK_WHITELIST | CVE_CHECK_IGNORE | Richard Purdie | Marta | |
| core | ICECC_USER_CLASS_BL | ICECC_USER_CLASS_EXCLUDES | Michael Opdenacker | Should be removed | |
| core | ICECC_USER_PACKAGE_WL | ICECC_USER_CLASS_ALLOWLIST | Michael Opdenacker | Should be removed | |
| core | ICECC_USER_PACKAGE_BL | ICECC_USER_PACKAGE_EXCLUDES | Michael Opdenacker | Should be removed | |
| core | SYSROOT_DIRS_BLACKLIST | SYSROOT_DIRS_IGNORE | Richard Purdie | Marta | |
| core | INHERIT_BLACKLIST | INHERIT_RECIPE_SKIP | Saul | Saul | if we drop the blacklist class, we can drop this too (RP) |
| core | SDK_LOCAL_CONF_BLACKLIST | ESDK_LOCALCONF_REMOVE | Richard Purdie | Saul | |
| core | SDK_LOCAL_CONF_WHITELIST | ESDK_LOCALCONF_ALLOW | Richard Purdie | Saul | |
| core | SDK_INHERIT_BLACKLIST | ESDK_CLASS_INHERIT_DISABLE | Richard Purdie | Saul | |
| core | WHITELIST_(ANY LICENSE) | Saul | Saul | Should be removed and replaced with INCOMPATIBLE_LICENSE_ALLOWED_RECIPES, which would be a list of recipes which are of a blocked license that is now being overridden | |
| core | LICENSE_FLAGS_WHITELIST | LICENSE_FLAGS_ACCEPTED (and BLOCKED) | Saul | Saul | Should be changed to |
| core | UNKNOWN_CONFIGURE_WHITELIST | UNKNOWN_CONFIGURE_OPT_IGNORE | Richard Purdie | Saul | |
| TUNEABI_WHITELIST | Removed |
Functions
| Repo | Current name | Suggest rename | Recommended by | Approved name |
|---|---|---|---|---|
| Bitbake | test_setscenewhitelist |
Patch Files
| Repo | Recipe | Current name | Suggest rename | Recommended by | Approved name | Volunteer |
|---|---|---|---|---|---|---|
| core | tcp-wrappers | 11_tcpd_blacklist.patch | 11_tcpd_blocklist.patch | Saul Wold | as recommended | Saul |
| core | udev-extraconf | mount.blacklist | mount.disallow | Saul Wold | as recommended | Saul |
| oe | lxdm | 0001-lxdm.conf.in-blacklist-root-for-release-images.patch | 0001-lxdm.conf.in-deny-root-for-release-images.patch | Saul Wold | as recommended | Saul |
| oe | multipath-tools | 022-RH-Remove-the-property-blacklist-exception-builtin.patch | 022-RH-Remove-the-default-property-exception-builtin.patch | Saul Wold | as recommended | Saul |
| oe | mozjs | 0001-Cargo.toml-do-not-abort-on-panic.patch | 0001-Cargo.toml-do-not-exit-on-panic.patch | Saul Wold | as recommended | Saul |
| oe | mozjs | 0004-Cargo.toml-do-not-abort-on-panic.patch | 0004-Cargo.toml-do-not-exit-on-panic.patch | Saul Wold | as recommended | Saul |
| meta-integrity | files | ima_signing_blacklist | ima_signing_blocklist | Saul Wold | as recommended | Saul |
| meta-efi-secure-boot | efitools | Fix-the-wrong-dependency-for-blacklist.esl.patch | Fix-the-wrong-dependency-esl-file.patch | Saul Wold | as recommended | Saul |
| meta-raspberrypi | gstreamer1.0-omx | 0005-Don-t-abort-gst_omx_video_dec_set_format-if-there-s-.patch | 0005-Don-t-return-gst_omx_video_dec_set_format-if-there-s-.patch | Saul Wold | as recommended | Saul |
Migration
A warning mechanism will be added to bitbake to detect the issue (post processing), except for BB_ENV issues. A (limited) conversation script will be created to help with the migration. For those instances where a 1-1 mapping is not achievable, a list of the occurrences and what it should be changed to will occur.
Notes
Some upstream references:
[1][ Linux kernel]
[2][IETF: Terminology, Power and Inclusive Language: Draft v2]
[3][Why changing the terms blacklist and whitelist isn’t as easy as it might seem]
