summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMarta Rybczynska <rybczynska@gmail.com>2022-03-30 16:20:53 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-03-31 11:46:03 +0100
commit54b7b0561eaa4e6f3726c2f1cc2d4649676bba3e (patch)
tree0952def0d61271edbfa817d5d40313d569383d55 /documentation
parente16ad94999e981564102362953200f99a27dd1e2 (diff)
downloadpoky-54b7b0561eaa4e6f3726c2f1cc2d4649676bba3e.tar.gz
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. (From yocto-docs rev: a0b55789035c8d44426b6ff8267b4042ef0a58ba) Signed-off-by: Marta Rybczynska <marta.rybczynska@huawei.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/migration-guides/migration-3.5.rst42
1 files changed, 41 insertions, 1 deletions
diff --git a/documentation/migration-guides/migration-3.5.rst b/documentation/migration-guides/migration-3.5.rst
index 8ce2306e42..e6c7c413d1 100644
--- a/documentation/migration-guides/migration-3.5.rst
+++ b/documentation/migration-guides/migration-3.5.rst
@@ -12,10 +12,50 @@ Recipe changes
12 deleted. BitBake will stop with an error when renamed or removed variables 12 deleted. BitBake will stop with an error when renamed or removed variables
13 still exist in your recipes or configuration. 13 still exist in your recipes or configuration.
14 14
15 Please note that the change applies also to environmental variables, so
16 make sure you use a fresh environment for your build.
17
18 The following variables have changed their names:
19
20 - ``BB_ENV_WHITELIST`` became :term:`BB_ENV_PASSTHROUGH`
21 - ``BB_ENV_EXTRAWHITE`` became :term:`BB_ENV_PASSTHROUGH_ADDITIONS`
22 - ``BB_HASHBASE_WHITELIST`` became :term:`BB_BASEHASH_IGNORE_VARS`
23 - ``BB_HASHCONFIG_WHITELIST`` became :term:`BB_HASHCONFIG_IGNORE_VARS`
24 - ``BB_HASHTASK_WHITELIST`` became ``BB_TASKHASH_IGNORE_TASKS``
25 - ``BB_SETSCENE_ENFORCE_WHITELIST`` became ``BB_SETSCENE_ENFORCE_IGNORE_TASKS``
26 - ``CVE_CHECK_PN_WHITELIST`` became :term:`CVE_CHECK_SKIP_RECIPE`
27 - ``CVE_CHECK_WHITELIST`` became :term:`CVE_CHECK_IGNORE`
28 - ``ICECC_USER_CLASS_BL`` became :term:`ICECC_CLASS_DISABLE`
29 - ``ICECC_SYSTEM_CLASS_BL`` became :term:`ICECC_CLASS_DISABLE`
30 - ``ICECC_USER_PACKAGE_WL`` became :term:`ICECC_RECIPE_ENABLE`
31 - ``ICECC_USER_PACKAGE_BL`` became :term:`ICECC_RECIPE_DISABLE`
32 - ``ICECC_SYSTEM_PACKAGE_BL`` became :term:`ICECC_RECIPE_DISABLE`
33 - ``LICENSE_FLAGS_WHITELIST`` became :term:`LICENSE_FLAGS_ACCEPTED`
34 - ``MULTI_PROVIDER_WHITELIST`` became :term:`BB_MULTI_PROVIDER_ALLOWED`
35 - ``PNBLACKLIST`` became :term:`SKIP_RECIPE`
36 - ``SDK_LOCAL_CONF_BLACKLIST`` became :term:`ESDK_LOCALCONF_REMOVE`
37 - ``SDK_LOCAL_CONF_WHITELIST`` became :term:`ESDK_LOCALCONF_ALLOW`
38 - ``SDK_INHERIT_BLACKLIST`` became :term:`ESDK_CLASS_INHERIT_DISABLE`
39 - ``SSTATE_DUPWHITELIST`` became ``SSTATE_ALLOW_OVERLAP_FILES``
40 - ``SYSROOT_DIRS_BLACKLIST`` became :term:`SYSROOT_DIRS_IGNORE`
41 - ``UNKNOWN_CONFIGURE_WHITELIST`` became :term:`UNKNOWN_CONFIGURE_OPT_IGNORE`
42
43 In addition, ``BB_STAMP_WHITELIST``, ``BB_STAMP_POLICY``, ``INHERIT_BLACKLIST``
44 and ``TUNEABI_WHITELIST`` have been removed.
45
46 Many internal variable names have been also renamed accordingly.
47
48 In addition, in the ``cve-check`` output, the CVE issue status ``Whitelisted``
49 has been renamed to ``Ignored``.
50
15 A :oe_git:`convert-variable-renames.py 51 A :oe_git:`convert-variable-renames.py
16 </openembedded-core/tree/scripts/contrib/convert-variable-renames.py>` 52 </openembedded-core/tree/scripts/contrib/convert-variable-renames.py>`
17 script is provided to convert your recipes and configuration, 53 script is provided to convert your recipes and configuration,
18 and also warns you about the use of problematic words. 54 and also warns you about the use of problematic words. The script performs
55 changes and you need to review them before committing. An example warning
56 looks like::
57
58 poky/scripts/lib/devtool/upgrade.py needs further work at line 275 since it contains abort
19 59
20- Because of the uncertainty in future default branch names in git repositories, 60- Because of the uncertainty in future default branch names in git repositories,
21 it is now required to add a branch name to all URLs described 61 it is now required to add a branch name to all URLs described