Inclusive language
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.
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.
Classes
| Repo | Current name | Suggest rename | Recommended by | Approved name |
|---|---|---|---|---|
| core | blacklist.bbclass | excludelist.bbclass | Armin | |
| core | blacklist.bbclass (alt) | forcerecipeskip.bbclass | Saul |
Variables
| Repo | Current name | Suggest rename | Recommended by | Approved name | Notes |
|---|---|---|---|---|---|
| Bitbake | ABORT | FAIL_BUILD | Saul | ||
| Bitbake | abort (comment or variable) | based on context | Saul | ||
| Bitbake | BB_ENV_WHITELIST | BB_ENV_ALLOWLIST | Armin Kuster | ||
| Bitbake | BB_ENV_EXTRAWHITE | BB_ENV_EXTRA_ALLOWLIST | Saul | ||
| Bitbake | BB_HASHCONFIG_WHITELIST | BB_HASHCONFIG_EXCLUDE_FROM_CHECKSUM | Saul | ||
| Bitbake | BB_STAMP_WHITELIST | BB_STAMP_COMPARELIST | Saul | ||
| Bitbake | BB_SETSCENE_ENFORCE_WHITELIST | ||||
| Bitbake | BB_HASHBASE_WHITELIST | ||||
| Bitbake | MULTI_PROVIDER_WHITELIST | ||||
| Bitbake | basewhitelist | ||||
| Bitbake | taskwhitelist | ||||
| core | abort (comment or variable) | based on context | Saul Wold | ||
| core | PNBLACKLIST | PNFORCESKIP | Saul | The usage is a single recipe or PN | |
| core | whitelist | allowlist | Saul | This could be change based on context | |
| core | whitelisted | allowed | Saul | Context sensitve | |
| core | whitelisting | allowing | Saul | ||
| core | SSTATE_DUPWHITELIST | SSTATE_DUPSKIPLIST/SSTATE_IGN_OVERLAP | Armin/Saul | ||
| core | CVE_CHECK_PN_WHITELIST | CVE_CHECK_PN_SKIPIST | Armin | ||
| core | ICECC_USER_CLASS_BL | ICECC_USER_CLASS_EXCLUDES | Michael Opdenacker | ||
| core | ICECC_USER_PACKAGE_WL | ICECC_USER_CLASS_ALLOWLIST | Michael Opdenacker | ||
| core | ICECC_USER_PACKAGE_BL | ICECC_USER_PACKAGE_EXCLUDES | Michael Opdenacker | ||
| core | CVE_CHECK_WHITELIST | CVE_CHECK_IGNORELIST | Yuichi Ito | ||
| core | SYSROOT_DIRS_BLACKLIST | SYSROOT_DIRS_TOUNSTAGE | Saul | ||
| core | INHERIT_BLACKLIST | INHERIT_RECIPESKIP | Saul | ||
| core | SDK_LOCAL_CONF_BLACKLIST | SDK_LOCAL_CONF_EXCLUDELIST | Saul | ||
| core | SDK_LOCAL_CONF_WHITELIST | SDK_LOCAL_CONF_ALLOWLIST | Saul | ||
| core | SDK_INHERIT_BLACKLIST | SDK_REMOVE_INHERITS | Saul | ||
| core | WHITELIST_GPL-3.0 | GPL-3.0_ALLOWABLE | Saul | ||
| core | TUNEABI_WHITELIST | TUNEABI_ALLOWLIST | Saul | ||
| core | LICENSE_FLAGS_WHITELIST | LICENSE_FLAGS_ALLOWLIST | Saul | ||
| core | UNKNOWN_CONFIGURE_WHITELIST | UNKNOWN_CONFIGURE_ALLOWLIST | Saul |
Functions
| Repo | Current name | Suggest rename | Recommended by | Approved name |
|---|---|---|---|---|
| Bitabke | test_setscenewhitelist |
Patch Files
| Repo | Recipe | Current name | Suggest rename | Recommended by | Approved name |
|---|---|---|---|---|---|
| core | tcp-wrappers | 11_tcpd_blacklist.patch | 11_tcpd_blocklist.patch | Saul Wold | |
| core | udev-extraconf | mount.blacklist | mount.disallow | Saul Wold | |
| oe | lxdm | 0001-lxdm.conf.in-blacklist-root-for-release-images.patch | 0001-lxdm.conf.in-deny-root-for-release-images.patch | Saul Wold | |
| oe | multipath-tools | 022-RH-Remove-the-property-blacklist-exception-builtin.patch | 022-RH-Remove-the-default-property-exception-builtin.patch | Saul Wold | |
| oe | mozjs | 0001-Cargo.toml-do-not-abort-on-panic.patch | 0001-Cargo.toml-do-not-exit-on-panic.patch | Saul Wold | |
| oe | mozjs | 0004-Cargo.toml-do-not-abort-on-panic.patch | 0004-Cargo.toml-do-not-exit-on-panic.patch | Saul Wold | |
| meta-integrity | files | ima_signing_blacklist | ima_signing_blocklist | Saul Wold | |
| meta-efi-secure-boot | efitools | Fix-the-wrong-dependency-for-blacklist.esl.patch | Fix-the-wrong-dependency-esl-file.patch | Saul Wold | |
| 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 |
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]
