summaryrefslogtreecommitdiffstats
path: root/documentation/migration-guides
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/migration-guides')
-rw-r--r--documentation/migration-guides/index.rst1
-rw-r--r--documentation/migration-guides/migration-5.1.rst143
-rw-r--r--documentation/migration-guides/release-5.0.rst1
-rw-r--r--documentation/migration-guides/release-5.1.rst9
-rw-r--r--documentation/migration-guides/release-notes-4.0.18.rst2
-rw-r--r--documentation/migration-guides/release-notes-5.0.1.rst134
-rw-r--r--documentation/migration-guides/release-notes-5.1.rst67
7 files changed, 356 insertions, 1 deletions
diff --git a/documentation/migration-guides/index.rst b/documentation/migration-guides/index.rst
index d8edd05b89..e9d7f72809 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 release-5.1
15 release-5.0 16 release-5.0
16 release-4.3 17 release-4.3
17 release-4.2 18 release-4.2
diff --git a/documentation/migration-guides/migration-5.1.rst b/documentation/migration-guides/migration-5.1.rst
new file mode 100644
index 0000000000..b43fecc2dd
--- /dev/null
+++ b/documentation/migration-guides/migration-5.1.rst
@@ -0,0 +1,143 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2
3Release 5.1 (styhead)
4=====================
5
6Migration notes for 5.1 (styhead)
7------------------------------------
8
9This section provides migration information for moving to the Yocto
10Project 5.1 Release (codename "styhead") from the prior release.
11
12.. _migration-5.1-supported-kernel-versions:
13
14:term:`WORKDIR` changes
15~~~~~~~~~~~~~~~~~~~~~~~
16
17S = ${WORKDIR} no longer supported
18^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
19
20If a recipe has :term:`S` set to be :term:`WORKDIR`, this is no longer
21supported, and an error will be issued. The recipe should be changed to::
22
23 S = "${WORKDIR}/sources"
24 UNPACKDIR = "${S}"
25
26Any :term:`WORKDIR` references where files from :term:`SRC_URI` are referenced
27should be changed to :term:`S`. These are commonly in :ref:`ref-tasks-compile`,
28:ref:`ref-tasks-compile`, :ref:`ref-tasks-install` and :term:`LIC_FILES_CHKSUM`.
29
30:term:`WORKDIR` references in recipes
31^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
32
33:term:`WORKDIR` references in other recipes need auditing. If they reference
34files from :term:`SRC_URI`, they likely need changing to :term:`UNPACKDIR`.
35These are commonly in :ref:`ref-tasks-compile` and :ref:`ref-tasks-install`
36for things like service or configuration files. One unusual case is
37``${WORKDIR}/${BP}`` which should probably be set to ``${S}``.
38
39References to ``../`` in :term:`LIC_FILES_CHKSUM` or elsewhere may need changing
40to :term:`UNPACKDIR`. References to :term:`WORKDIR` in ``sed`` commands are
41usually left as they are.
42
43General notes
44^^^^^^^^^^^^^
45
46Files from :ref:`ref-tasks-unpack` now unpack to ``WORKDIR/sources-unpack/``
47rather than ``WORKDIR/``.
48
49If :term:`S` is set to a subdirectory under :term:`WORKDIR` and that
50subdirectory exists in ``sources-unpack`` after :ref:`ref-tasks-unpack` runs,
51it is moved to :term:`WORKDIR`. This means that ``S = "${WORKDIR}/${BP}"``,
52``S = "${WORKDIR}/git"`` and also deeper paths continue to work as expected
53without changes. We cannot use symlinks to do this as it breaks autotools
54based recipes. Keeping all sources under ``sources-unpack`` wasn't considered
55as it meant more invasive recipes changes. The key objective was separating the
56:ref:`ref-tasks-unpack` task output from :term:`WORKDIR`.
57
58Previously, :term:`S` was always created but after the recent changes it is no
59longer the case. This means the check in ``do_unpack_qa`` triggers where
60:term:`S` is not created by a recipe while it didn't happen before. This can
61require to add an :term:`S` definition to a recipe that only uses
62``file://`` :term:`SRC_URI` entries. To be consistent, the following pattern is
63recommended::
64
65 S = "${WORKDIR}/sources"
66 UNPACKDIR = "${S}"
67
68Building C files from :term:`UNPACKDIR` without setting :term:`S` to point at
69it does not work as the debug prefix mapping doesn't handle that.
70
71``devtool`` and ``recipetool`` have been updated to handle this and their
72support for ``S = WORKDIR`` and ``oe-local-files`` has been removed.
73
74Supported kernel versions
75~~~~~~~~~~~~~~~~~~~~~~~~~
76
77The :term:`OLDEST_KERNEL` setting is still "5.15" in this release, meaning that
78out the box, older kernels are not supported. See :ref:`4.3 migration notes
79<migration-4.3-supported-kernel-versions>` for details.
80
81.. _migration-5.1-supported-distributions:
82
83Supported distributions
84~~~~~~~~~~~~~~~~~~~~~~~
85
86Compared to the previous releases, running BitBake is supported on new
87GNU/Linux distributions:
88
89On the other hand, some earlier distributions are no longer supported:
90
91See :ref:`all supported distributions <system-requirements-supported-distros>`.
92
93.. _migration-5.1-go-changes:
94
95Go language changes
96~~~~~~~~~~~~~~~~~~~
97
98.. _migration-5.1-systemd-changes:
99
100systemd changes
101~~~~~~~~~~~~~~~
102
103.. _migration-5.1-recipe-changes:
104
105Recipe changes
106~~~~~~~~~~~~~~
107
108.. _migration-5.1-deprecated-variables:
109
110Deprecated variables
111~~~~~~~~~~~~~~~~~~~~
112
113.. _migration-5.1-removed-variables:
114
115Removed variables
116~~~~~~~~~~~~~~~~~
117
118The following variables have been removed:
119
120.. _migration-5.1-removed-recipes:
121
122Removed recipes
123~~~~~~~~~~~~~~~
124
125The following recipes have been removed in this release:
126
127.. _migration-5.1-removed-classes:
128
129Removed classes
130~~~~~~~~~~~~~~~
131
132No classes have been removed in this release.
133
134.. _migration-5.1-qemu-changes:
135
136QEMU changes
137~~~~~~~~~~~~
138
139.. _migration-5.1-misc-changes:
140
141Miscellaneous changes
142~~~~~~~~~~~~~~~~~~~~~
143
diff --git a/documentation/migration-guides/release-5.0.rst b/documentation/migration-guides/release-5.0.rst
index bd19b707f6..44a02ab041 100644
--- a/documentation/migration-guides/release-5.0.rst
+++ b/documentation/migration-guides/release-5.0.rst
@@ -7,3 +7,4 @@ Release 5.0 (scarthgap)
7 7
8 migration-5.0 8 migration-5.0
9 release-notes-5.0 9 release-notes-5.0
10 release-notes-5.0.1
diff --git a/documentation/migration-guides/release-5.1.rst b/documentation/migration-guides/release-5.1.rst
new file mode 100644
index 0000000000..768edfa2b0
--- /dev/null
+++ b/documentation/migration-guides/release-5.1.rst
@@ -0,0 +1,9 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2
3Release 5.1 (styhead)
4=======================
5
6.. toctree::
7
8 migration-5.1
9 release-notes-5.1
diff --git a/documentation/migration-guides/release-notes-4.0.18.rst b/documentation/migration-guides/release-notes-4.0.18.rst
index fc8cd83c02..d5a2a7f6ce 100644
--- a/documentation/migration-guides/release-notes-4.0.18.rst
+++ b/documentation/migration-guides/release-notes-4.0.18.rst
@@ -28,7 +28,7 @@ Fixes in Yocto-4.0.18
28~~~~~~~~~~~~~~~~~~~~~ 28~~~~~~~~~~~~~~~~~~~~~
29 29
30- build-appliance-image: Update to kirkstone head revision 30- build-appliance-image: Update to kirkstone head revision
31- common-licenses: Backport missing license 31- common-licenses: backport LGPL-3.0-with-zeromq-exception license
32- contributor-guide: add notes for tests 32- contributor-guide: add notes for tests
33- contributor-guide: be more specific about meta-* trees 33- contributor-guide: be more specific about meta-* trees
34- cups: fix typo in :cve:`2023-32360` backport patch 34- cups: fix typo in :cve:`2023-32360` backport patch
diff --git a/documentation/migration-guides/release-notes-5.0.1.rst b/documentation/migration-guides/release-notes-5.0.1.rst
new file mode 100644
index 0000000000..a377f92c19
--- /dev/null
+++ b/documentation/migration-guides/release-notes-5.0.1.rst
@@ -0,0 +1,134 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2
3Release notes for Yocto-5.0.1 (Scarthgap)
4-----------------------------------------
5
6Security Fixes in Yocto-5.0.1
7~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8
9- N/A
10
11
12Fixes in Yocto-5.0.1
13~~~~~~~~~~~~~~~~~~~~
14
15- babeltrace2: upgrade 2.0.5 -> 2.0.6
16- bind: upgrade 9.18.24 -> 9.18.25
17- bitbake: cooker: Use hash client to ping upstream server
18- build-appliance-image: Update to scarthgap head revision (b9b47b1a392b...)
19- docs: add support for scarthgap 5.0 release
20- docs: brief-yoctoprojectqs: explicit version dependency on websockets python module
21- docs: brief-yoctoprojectqs: Update to the correct hash equivalence server address
22- documentation/poky.yaml.in: drop mesa/sdl from essential host packages
23- ell: upgrade 0.63 -> 0.64
24- gcr: upgrade 4.2.0 -> 4.2.1
25- icu: update 74-1 -> 74-2
26- libdnf: upgrade 0.73.0 -> 0.73.1
27- libsdl2: upgrade 2.30.0 -> 2.30.1
28- libx11: upgrade 1.8.7 -> 1.8.9
29- libxcursor: upgrade 1.2.1 -> 1.2.2
30- libxml2: upgrade 2.12.5 -> 2.12.6
31- local.conf.sample: Fix hashequivalence server address
32- lttng-tools: upgrade 2.13.11 -> 2.13.13
33- manuals: standards.md: add standard for project names
34- mesa: upgrade 24.0.2 -> 24.0.3
35- migration-notes: add release notes for 4.0.18
36- mpg123: upgrade 1.32.5 -> 1.32.6
37- pango: upgrade 1.52.0 -> 1.52.1
38- poky.conf: bump version for 5.0.1
39- python3: skip test_concurrent_futures/test_shutdown
40- ref-manual: update releases.svg
41- ref-manual: variables: add :term:`USERADD_DEPENDS`
42- release-notes-5.0: update Repositories / Downloads section
43- release-notes-5.0: update recipes changes
44- release-notes-5.0: update new features
45- rootfs-postcommands.bbclass: Only set DROPBEAR_RSAKEY_DIR once
46- rpm: update 4.19.1 -> 4.19.1.1
47- scripts/oe-setup-build: write a build environment initialization one-liner into the build directory
48- sstate.bbclass: Add _SSTATE_EXCLUDEDEPS_SYSROOT to vardepsexclude
49- systemd: sed :term:`ROOT_HOME` only if sysusers :term:`PACKAGECONFIG` is set
50
51
52Known Issues in Yocto-5.0.1
53~~~~~~~~~~~~~~~~~~~~~~~~~~~
54
55- N/A
56
57
58Contributors to Yocto-5.0.1
59~~~~~~~~~~~~~~~~~~~~~~~~~~~
60
61- Alexander Kanavin
62- Christian Bräuner Sørensen
63- Joshua Watt
64- Lee Chee Yang
65- Mark Hatle
66- Michael Glembotzki
67- Michael Halstead
68- Michael Opdenacker
69- Paul Eggleton
70- Quentin Schulz
71- Richard Purdie
72- Steve Sakoman
73- Trevor Gamblin
74- Wang Mingyu
75
76
77Repositories / Downloads for Yocto-5.0.1
78~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
79
80poky
81
82- Repository Location: :yocto_git:`/poky`
83- Branch: :yocto_git:`scarthgap </poky/log/?h=scarthgap>`
84- Tag: :yocto_git:`yocto-5.0.1 </poky/log/?h=yocto-5.0.1>`
85- Git Revision: :yocto_git:`4b07a5316ed4b858863dfdb7cab63859d46d1810 </poky/commit/?id=4b07a5316ed4b858863dfdb7cab63859d46d1810>`
86- Release Artefact: poky-4b07a5316ed4b858863dfdb7cab63859d46d1810
87- sha: 51d0c84da7dbcc8db04a674da39cfc73ea78aac22ee646ede5b6229937d4666a
88- Download Locations:
89 http://downloads.yoctoproject.org/releases/yocto/yocto-5.0.1/poky-4b07a5316ed4b858863dfdb7cab63859d46d1810.tar.bz2
90 http://mirrors.kernel.org/yocto/yocto/yocto-5.0.1/poky-4b07a5316ed4b858863dfdb7cab63859d46d1810.tar.bz2
91
92openembedded-core
93
94- Repository Location: :oe_git:`/openembedded-core`
95- Branch: :oe_git:`scarthgap </openembedded-core/log/?h=scarthgap>`
96- Tag: :oe_git:`yocto-5.0.1 </openembedded-core/log/?h=yocto-5.0.1>`
97- Git Revision: :oe_git:`294a7dbe44f6b7c8d3a1de8c2cc182af37c4f916 </openembedded-core/commit/?id=294a7dbe44f6b7c8d3a1de8c2cc182af37c4f916>`
98- Release Artefact: oecore-294a7dbe44f6b7c8d3a1de8c2cc182af37c4f916
99- sha: e9be51a3b1fe8a1f420483b912caf91bc429dcca303d462381876a643b73045e
100- Download Locations:
101 http://downloads.yoctoproject.org/releases/yocto/yocto-5.0.1/oecore-294a7dbe44f6b7c8d3a1de8c2cc182af37c4f916.tar.bz2
102 http://mirrors.kernel.org/yocto/yocto/yocto-5.0.1/oecore-294a7dbe44f6b7c8d3a1de8c2cc182af37c4f916.tar.bz2
103
104meta-mingw
105
106- Repository Location: :yocto_git:`/meta-mingw`
107- Branch: :yocto_git:`scarthgap </meta-mingw/log/?h=scarthgap>`
108- Tag: :yocto_git:`yocto-5.0.1 </meta-mingw/log/?h=yocto-5.0.1>`
109- Git Revision: :yocto_git:`acbba477893ef87388effc4679b7f40ee49fc852 </meta-mingw/commit/?id=acbba477893ef87388effc4679b7f40ee49fc852>`
110- Release Artefact: meta-mingw-acbba477893ef87388effc4679b7f40ee49fc852
111- sha: 3b7c2f475dad5130bace652b150367f587d44b391218b1364a8bbc430b48c54c
112- Download Locations:
113 http://downloads.yoctoproject.org/releases/yocto/yocto-5.0.1/meta-mingw-acbba477893ef87388effc4679b7f40ee49fc852.tar.bz2
114 http://mirrors.kernel.org/yocto/yocto/yocto-5.0.1/meta-mingw-acbba477893ef87388effc4679b7f40ee49fc852.tar.bz2
115
116bitbake
117
118- Repository Location: :oe_git:`/bitbake`
119- Branch: :oe_git:`2.8 </bitbake/log/?h=2.8>`
120- Tag: :oe_git:`yocto-5.0.1 </bitbake/log/?h=yocto-5.0.1>`
121- Git Revision: :oe_git:`8f90d10f9efc9a32e13f6bd031992aece79fe7cc </bitbake/commit/?id=8f90d10f9efc9a32e13f6bd031992aece79fe7cc>`
122- Release Artefact: bitbake-8f90d10f9efc9a32e13f6bd031992aece79fe7cc
123- sha: 519f02d5de7fbfac411532161d521123814dd9cc7d6b55488b5e7a547c1a6977
124- Download Locations:
125 http://downloads.yoctoproject.org/releases/yocto/yocto-5.0.1/bitbake-8f90d10f9efc9a32e13f6bd031992aece79fe7cc.tar.bz2
126 http://mirrors.kernel.org/yocto/yocto/yocto-5.0.1/bitbake-8f90d10f9efc9a32e13f6bd031992aece79fe7cc.tar.bz2
127
128yocto-docs
129
130- Repository Location: :yocto_git:`/yocto-docs`
131- Branch: :yocto_git:`scarthgap </yocto-docs/log/?h=scarthgap>`
132- Tag: :yocto_git:`yocto-5.0.1 </yocto-docs/log/?h=yocto-5.0.1>`
133- Git Revision: :yocto_git:`875dfe69e93bf8fee3b8c07818a6ac059f228a13 </yocto-docs/commit/?id=875dfe69e93bf8fee3b8c07818a6ac059f228a13>`
134
diff --git a/documentation/migration-guides/release-notes-5.1.rst b/documentation/migration-guides/release-notes-5.1.rst
new file mode 100644
index 0000000000..32cb2de2b4
--- /dev/null
+++ b/documentation/migration-guides/release-notes-5.1.rst
@@ -0,0 +1,67 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2
3Release notes for 5.1 (styhead)
4---------------------------------
5
6New Features / Enhancements in 5.1
7~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8
9- Linux kernel 6.X, gcc 14.X, glibc 2.X, LLVM 18.X, and over XXX other recipe upgrades
10
11- New variables:
12
13- Architecture-specific enhancements:
14
15- Kernel-related enhancements:
16
17- New core recipes:
18
19- QEMU / ``runqemu`` enhancements:
20
21- Rust improvements:
22
23- wic Image Creator enhancements:
24
25- SDK-related improvements:
26
27- Testing:
28
29- Utility script changes:
30
31- BitBake improvements:
32
33- devtool improvements:
34
35- recipetool improvements:
36
37- Packaging changes:
38
39- Security improvements:
40
41- Toaster Web UI improvements:
42
43- Prominent documentation updates:
44
45- Miscellaneous changes:
46
47Known Issues in 5.1
48~~~~~~~~~~~~~~~~~~~
49
50Recipe License changes in 5.1
51~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
52
53The following corrections have been made to the :term:`LICENSE` values set by recipes:
54
55Security Fixes in 5.1
56~~~~~~~~~~~~~~~~~~~~~
57
58Recipe Upgrades in 5.1
59~~~~~~~~~~~~~~~~~~~~~~
60
61Contributors to 5.1
62~~~~~~~~~~~~~~~~~~~
63
64Thanks to the following people who contributed to this release:
65
66Repositories / Downloads for Yocto-5.1
67~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~