diff options
Diffstat (limited to 'poky/documentation/migration-guides/migration-3.5.rst')
| -rw-r--r-- | poky/documentation/migration-guides/migration-3.5.rst | 96 |
1 files changed, 94 insertions, 2 deletions
diff --git a/poky/documentation/migration-guides/migration-3.5.rst b/poky/documentation/migration-guides/migration-3.5.rst index 8ce2306e42..8a4c568743 100644 --- a/poky/documentation/migration-guides/migration-3.5.rst +++ b/poky/documentation/migration-guides/migration-3.5.rst @@ -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 :term:`BB_ENV_PASSTHROUGH` + - ``BB_ENV_EXTRAWHITE`` became :term:`BB_ENV_PASSTHROUGH_ADDITIONS` + - ``BB_HASHBASE_WHITELIST`` became :term:`BB_BASEHASH_IGNORE_VARS` + - ``BB_HASHCONFIG_WHITELIST`` became :term:`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 :term:`CVE_CHECK_SKIP_RECIPE` + - ``CVE_CHECK_WHITELIST`` became :term:`CVE_CHECK_IGNORE` + - ``ICECC_USER_CLASS_BL`` became :term:`ICECC_CLASS_DISABLE` + - ``ICECC_SYSTEM_CLASS_BL`` became :term:`ICECC_CLASS_DISABLE` + - ``ICECC_USER_PACKAGE_WL`` became :term:`ICECC_RECIPE_ENABLE` + - ``ICECC_USER_PACKAGE_BL`` became :term:`ICECC_RECIPE_DISABLE` + - ``ICECC_SYSTEM_PACKAGE_BL`` became :term:`ICECC_RECIPE_DISABLE` + - ``LICENSE_FLAGS_WHITELIST`` became :term:`LICENSE_FLAGS_ACCEPTED` + - ``MULTI_PROVIDER_WHITELIST`` became :term:`BB_MULTI_PROVIDER_ALLOWED` + - ``PNBLACKLIST`` became :term:`SKIP_RECIPE` + - ``SDK_LOCAL_CONF_BLACKLIST`` became :term:`ESDK_LOCALCONF_REMOVE` + - ``SDK_LOCAL_CONF_WHITELIST`` became :term:`ESDK_LOCALCONF_ALLOW` + - ``SDK_INHERIT_BLACKLIST`` became :term:`ESDK_CLASS_INHERIT_DISABLE` + - ``SSTATE_DUPWHITELIST`` became ``SSTATE_ALLOW_OVERLAP_FILES`` + - ``SYSROOT_DIRS_BLACKLIST`` became :term:`SYSROOT_DIRS_IGNORE` + - ``UNKNOWN_CONFIGURE_WHITELIST`` became :term:`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 @@ -64,10 +104,17 @@ Recipe changes - :ref:`allarch <ref-classes-allarch>` packagegroups can no longer depend on packages which use :term:`PKG` renaming such as :ref:`ref-classes-debian`. +- :term:`LICENSE` definitions now have to use `SPDX identifiers <https://spdx.org/licenses/>`__. + A :oe_git:`convert-spdx-licenses.py </openembedded-core/tree/scripts/contrib/convert-spdx-licenses.py>` + script can be used to update your recipes. + +- :term:`SRC_URI`: a new :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-fetching:crate fetcher (\`\`crate://\`\`)` + is available for Rust packages. + Class changes ------------- -- The `distutils*.bbclasses` have been moved to `meta-python`. The classes and +- The ``distutils*.bbclasses`` have been moved to ``meta-python``. The classes and `DISTUTILS*` variables have been removed from the documentation. - ``blacklist.bbclass`` is removed and the functionality moved to the @@ -76,3 +123,48 @@ Class changes function. The usage will remain the same:: SKIP_RECIPE[my-recipe] = "Reason for skipping recipe" + +- The Python package build process based on `wheels <https://pythonwheels.com/>`__. + Here are the new Python packaging classes that should be used: + :ref:`python-flit_core <ref-classes-python_flit_core>`, + :ref:`setuptools_python-build_meta <ref-classes-python_setuptools_build_meta>` + and :ref:`python_poetry_core <ref-classes-python_poetry_core>`. + +- ``image-prelink.bbclass`` class is removed. + +- New :ref:`overlayfs <ref-classes-overlayfs>` and + :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` classes are available + to make it easier to overlay read-only filesystems (for example) + with `OverlayFS <https://en.wikipedia.org/wiki/OverlayFS>`__. + +Configuration changes +--------------------- + +- The Yocto Project now allows to reuse Shared State from its autobuilder. + If the network connection between our server and your machine is faster + than you would build recipes, you can try to speed up your builds + by using such Share State and Hash Equivalence by setting:: + + BB_SIGNATURE_HANDLER = "OEEquivHash" + BB_HASHSERVE = "auto" + BB_HASHSERVE_UPSTREAM = "typhoon.yocto.io:8687" + SSTATE_MIRRORS ?= "file://.* https://sstate.yoctoproject.org/&YOCTO_DOC_VERSION;/PATH;downloadfilename=PATH" + +Supported host distribution changes +----------------------------------- + +- New support for `AlmaLinux <https://en.wikipedia.org/wiki/AlmaLinux>`__ + hosts replacing `CentOS <https://en.wikipedia.org/wiki/CentOS>`__. + The following distribution versions were dropped: CentOS 8, Ubuntu 16.04 and Fedora 30, 31 and 32. + +Changes for release notes +------------------------- + +- Share State cache: now using `ZStandard (zstd) <https://en.wikipedia.org/wiki/Zstd>`__ + instead of Gzip compression, for better performance. + +- BitBake has an improved ``setscene`` task display. + +- This release fixes the reproducibility issues with ``rust-llvm`` and ``golang``. + Recipes in OpenEmbedded-Core are now fully reproducible. + |