diff options
-rw-r--r-- | documentation/migration-guides/index.rst | 1 | ||||
-rw-r--r-- | documentation/migration-guides/migration-3.5.rst | 44 |
2 files changed, 45 insertions, 0 deletions
diff --git a/documentation/migration-guides/index.rst b/documentation/migration-guides/index.rst index 287b553195..6472cc2848 100644 --- a/documentation/migration-guides/index.rst +++ b/documentation/migration-guides/index.rst | |||
@@ -12,6 +12,7 @@ to move to one release of the Yocto Project from the previous one. | |||
12 | .. toctree:: | 12 | .. toctree:: |
13 | 13 | ||
14 | migration-general | 14 | migration-general |
15 | migration-3.5 | ||
15 | migration-3.4 | 16 | migration-3.4 |
16 | migration-3.3 | 17 | migration-3.3 |
17 | migration-3.2 | 18 | migration-3.2 |
diff --git a/documentation/migration-guides/migration-3.5.rst b/documentation/migration-guides/migration-3.5.rst new file mode 100644 index 0000000000..bd807eb8c7 --- /dev/null +++ b/documentation/migration-guides/migration-3.5.rst | |||
@@ -0,0 +1,44 @@ | |||
1 | Release 3.5 (kirkstone) | ||
2 | ======================= | ||
3 | |||
4 | This section provides migration information for moving to the Yocto | ||
5 | Project 3.5 Release (codename "kirkstone") from the prior release. | ||
6 | |||
7 | Recipe changes | ||
8 | -------------- | ||
9 | |||
10 | - Because of the uncertainty in future default branch names in git repositories, | ||
11 | it is now required to add a branch name to all URLs described | ||
12 | by ``git://`` and ``gitsm://`` :term:`SRC_URI` entries. For example:: | ||
13 | |||
14 | SRC_URI = "git://git.denx.de/u-boot.git;branch=master" | ||
15 | |||
16 | A :oe_git:`convert-srcuri </openembedded-core/tree/scripts/contrib/convert-srcuri.py>` | ||
17 | script to convert your recipes is available in :term:`OpenEmbedded-Core (OE-Core)` | ||
18 | and in :term:`Poky`. | ||
19 | |||
20 | - Because of `GitHub dropping support for the git: | ||
21 | protocol <https://github.blog/2021-09-01-improving-git-protocol-security-github/>`__, | ||
22 | recipes now need to use ``;protocol=https`` at the end of GitHub | ||
23 | URLs. The same script as above can be used to convert the recipes. | ||
24 | |||
25 | - The :term:`TOPDIR` variable and the current working directory are no longer modified | ||
26 | when parsing recipes. Any code depending on that behaviour will no longer work. | ||
27 | |||
28 | - The ``append``, ``prepend`` and ``remove`` operators can now only be combined with | ||
29 | ``=`` and ``:=`` operators. To the exception of the ``append`` plus ``+=`` and | ||
30 | ``prepend`` plus ``=+`` combinations, all combinations could be factored up to the | ||
31 | ``append``, ``prepend`` or ``remove`` in the combination. This brought a lot of | ||
32 | confusion on how the override style syntax operators work and should be used. | ||
33 | Therefore, those combinations can simply be replaced by a single ``append``, | ||
34 | ``prepend`` or ``remove`` operator without any additional change. | ||
35 | For the ``append`` plus ``+=`` (and ``prepend`` plus ``=+``) combinations, | ||
36 | the content should be prefixed (respectively suffixed) by a space to maintain | ||
37 | the same behavior. You can learn more about override style syntax operators | ||
38 | (``append``, ``prepend`` and ``remove``) in the BitBake documentation: | ||
39 | :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:appending and prepending (override style syntax)` | ||
40 | and :ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:removal (override style syntax)`. | ||
41 | |||
42 | - :ref:`allarch <ref-classes-allarch>` packagegroups can no longer depend on packages | ||
43 | which use :term:`PKG` renaming such as :ref:`debian.bbclass <ref-classes-debian>`. | ||
44 | |||