Skip to contentSkip to conversation

doc: migration-3.5: extend the section on inclusive language

PATCH In review Marta Rybczynska 2 participants 2 messages Mar 30, 2022 – Mar 31, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: migration-3.5: extend the section on inclusive language

Add the list of renamed and removed variables, show how the renaming script works. Also mention the change in cve-check output.

---
 .../migration-guides/migration-3.5.rst        | 42 ++++++++++++++++++-
 1 file changed, 41 insertions(+), 1 deletion(-)
documentation/migration-guides/migration-3.5.rst +41 -1
index 8ce2306e4..6de7b3b0f 100644
@@ -12,10 +12,50 @@ Recipe changes
   deleted. BitBake will stop with an error when renamed or removed variables
   still exist in your recipes or configuration.
 
+  Please note that the change applies also to environmental variables, so
+  make sure you use a fresh environment for your build.
+
+  The following variables have changed their names:
+
+  - `BB_ENV_WHITELIST` became `BB_ENV_PASSTHROUGH`
+  - `BB_ENV_EXTRAWHITE` became `BB_ENV_PASSTHROUGH_ADDITIONS`
+  - `BB_HASHBASE_WHITELIST` became `BB_BASEHASH_IGNORE_VARS`
+  - `BB_HASHCONFIG_WHITELIST` became `BB_HASHCONFIG_IGNORE_VARS`
+  - `BB_HASHTASK_WHITELIST` became `BB_TASKHASH_IGNORE_TASKS`
+  - `BB_SETSCENE_ENFORCE_WHITELIST` became `BB_SETSCENE_ENFORCE_IGNORE_TASKS`
+  - `CVE_CHECK_PN_WHITELIST` became `CVE_CHECK_SKIP_RECIPE`
+  - `CVE_CHECK_WHITELIST` became `CVE_CHECK_IGNORE`
+  - `ICECC_USER_CLASS_BL` became `ICECC_CLASS_DISABLE`
+  - `ICECC_SYSTEM_CLASS_BL` became `ICECC_CLASS_DISABLE`
+  - `ICECC_USER_PACKAGE_WL` became `ICECC_RECIPE_ENABLE`
+  - `ICECC_USER_PACKAGE_BL` became `ICECC_RECIPE_DISABLE`
+  - `ICECC_SYSTEM_PACKAGE_BL` became `ICECC_RECIPE_DISABLE`
+  - `LICENSE_FLAGS_WHITELIST` became `LICENSE_FLAGS_ACCEPTED`
+  - `MULTI_PROVIDER_WHITELIST` became `BB_MULTI_PROVIDER_ALLOWED`
+  - `PNBLACKLIST` became `SKIP_RECIPE`
+  - `SDK_LOCAL_CONF_BLACKLIST` became `ESDK_LOCALCONF_REMOVE`
+  - `SDK_LOCAL_CONF_WHITELIST` became `ESDK_LOCALCONF_ALLOW`
+  - `SDK_INHERIT_BLACKLIST` became `ESDK_CLASS_INHERIT_DISABLE`
+  - `SSTATE_DUPWHITELIST` became `SSTATE_ALLOW_OVERLAP_FILES`
+  - `SYSROOT_DIRS_BLACKLIST` became `SYSROOT_DIRS_IGNORE`
+  - `UNKNOWN_CONFIGURE_WHITELIST` became `UNKNOWN_CONFIGURE_OPT_IGNORE`
+
+  In addition, `BB_STAMP_WHITELIST`, `BB_STAMP_POLICY`, `INHERIT_BLACKLIST`
+  and `TUNEABI_WHITELIST` have been removed.
+
+  Many internal variable names have been also renamed accordingly.
+
+  In addition, in the `cve-check` output, the CVE issue status `Whitelisted`
+  has been renamed to `Ignored`.
+
   A :oe_git:`convert-variable-renames.py
   </openembedded-core/tree/scripts/contrib/convert-variable-renames.py>`
   script is provided to convert your recipes and configuration,
-  and also warns you about the use of problematic words.
+  and also warns you about the use of problematic words. The script performs
+  changes and you need to review them before committing. An example warning
+  looks like::
+
+     poky/scripts/lib/devtool/upgrade.py needs further work at line 275 since it contains abort
 
 - Because of the uncertainty in future default branch names in git repositories,
   it is now required to add a branch name to all URLs described
Signature · 1 line
2.33.0
Reviewed-by on v1 1/1
#1 lore raw

Hi Marta

Quoted 54 lines · Marta Rybczynska

Add the list of renamed and removed variables, show how the renaming script works. Also mention the change in cve-check output.

---
 .../migration-guides/migration-3.5.rst        | 42 ++++++++++++++++++-
 1 file changed, 41 insertions(+), 1 deletion(-)
documentation/migration-guides/migration-3.5.rst +36 -0
index 8ce2306e4..6de7b3b0f 100644
@@ -12,10 +12,50 @@ Recipe changes
   deleted. BitBake will stop with an error when renamed or removed variables
   still exist in your recipes or configuration.
 
+  Please note that the change applies also to environmental variables, so
+  make sure you use a fresh environment for your build.
+
+  The following variables have changed their names:
+
+  - `BB_ENV_WHITELIST` became `BB_ENV_PASSTHROUGH`
+  - `BB_ENV_EXTRAWHITE` became `BB_ENV_PASSTHROUGH_ADDITIONS`
+  - `BB_HASHBASE_WHITELIST` became `BB_BASEHASH_IGNORE_VARS`
+  - `BB_HASHCONFIG_WHITELIST` became `BB_HASHCONFIG_IGNORE_VARS`
+  - `BB_HASHTASK_WHITELIST` became `BB_TASKHASH_IGNORE_TASKS`
+  - `BB_SETSCENE_ENFORCE_WHITELIST` became `BB_SETSCENE_ENFORCE_IGNORE_TASKS`
+  - `CVE_CHECK_PN_WHITELIST` became `CVE_CHECK_SKIP_RECIPE`
+  - `CVE_CHECK_WHITELIST` became `CVE_CHECK_IGNORE`
+  - `ICECC_USER_CLASS_BL` became `ICECC_CLASS_DISABLE`
+  - `ICECC_SYSTEM_CLASS_BL` became `ICECC_CLASS_DISABLE`
+  - `ICECC_USER_PACKAGE_WL` became `ICECC_RECIPE_ENABLE`
+  - `ICECC_USER_PACKAGE_BL` became `ICECC_RECIPE_DISABLE`
+  - `ICECC_SYSTEM_PACKAGE_BL` became `ICECC_RECIPE_DISABLE`
+  - `LICENSE_FLAGS_WHITELIST` became `LICENSE_FLAGS_ACCEPTED`
+  - `MULTI_PROVIDER_WHITELIST` became `BB_MULTI_PROVIDER_ALLOWED`
+  - `PNBLACKLIST` became `SKIP_RECIPE`
+  - `SDK_LOCAL_CONF_BLACKLIST` became `ESDK_LOCALCONF_REMOVE`
+  - `SDK_LOCAL_CONF_WHITELIST` became `ESDK_LOCALCONF_ALLOW`
+  - `SDK_INHERIT_BLACKLIST` became `ESDK_CLASS_INHERIT_DISABLE`
+  - `SSTATE_DUPWHITELIST` became `SSTATE_ALLOW_OVERLAP_FILES`
+  - `SYSROOT_DIRS_BLACKLIST` became `SYSROOT_DIRS_IGNORE`
+  - `UNKNOWN_CONFIGURE_WHITELIST` became `UNKNOWN_CONFIGURE_OPT_IGNORE`
+
+  In addition, `BB_STAMP_WHITELIST`, `BB_STAMP_POLICY`, `INHERIT_BLACKLIST`
+  and `TUNEABI_WHITELIST` have been removed.
+
+  Many internal variable names have been also renamed accordingly.
+
+  In addition, in the `cve-check` output, the CVE issue status `Whitelisted`
+  has been renamed to `Ignored`.
+
   A :oe_git:`convert-variable-renames.py
   </openembedded-core/tree/scripts/contrib/convert-variable-renames.py>`

documentation/migration-guides/migration-3.5.rst Recipe changes · line 61

Quoted 10 lines
documentation/migration-guides/migration-3.5.rst +5 -1
   script is provided to convert your recipes and configuration,
-  and also warns you about the use of problematic words.
+  and also warns you about the use of problematic words. The script performs
+  changes and you need to review them before committing. An example warning
+  looks like::
+
+     poky/scripts/lib/devtool/upgrade.py needs further work at line 275 since it contains abort
 
 - Because of the uncertainty in future default branch names in git repositories,
   it is now required to add a branch name to all URLs described

Many thanks for the update.

For your information, I modified the way you quoted the text and variables, using ``VAR`` instead of VAR, and even :term:VAR for documented variables.

By the way, this allowed to detect that three variables are currently undocumented, because the ones they replace were undocumented too:
BB_TASKHASH_IGNORE_TASKS, BB_SETSCENE_ENFORCE_IGNORE_TASKS, SSTATE_ALLOW_OVERLAP_FILES

I'll take care of those separately.

... and merged into "master-next".

Thanks again
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com