summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-rw-r--r--documentation/brief-yoctoprojectqs/index.rst5
-rw-r--r--documentation/migration-guides/release-notes-5.0.rst42
-rw-r--r--documentation/poky.yaml.in14
-rw-r--r--documentation/ref-manual/variables.rst6
-rwxr-xr-xdocumentation/set_versions.py8
-rw-r--r--documentation/standards.md33
6 files changed, 77 insertions, 31 deletions
diff --git a/documentation/brief-yoctoprojectqs/index.rst b/documentation/brief-yoctoprojectqs/index.rst
index 61c5cbec36..4301bfd970 100644
--- a/documentation/brief-yoctoprojectqs/index.rst
+++ b/documentation/brief-yoctoprojectqs/index.rst
@@ -251,11 +251,14 @@ an entire Linux distribution, including the toolchain, from source.
251 To use such mirrors, uncomment the below lines in your ``conf/local.conf`` 251 To use such mirrors, uncomment the below lines in your ``conf/local.conf``
252 file in the :term:`Build Directory`:: 252 file in the :term:`Build Directory`::
253 253
254 BB_HASHSERVE_UPSTREAM = "hashserv.yocto.io:8687" 254 BB_HASHSERVE_UPSTREAM = "wss://hashserv.yoctoproject.org/ws"
255 SSTATE_MIRRORS ?= "file://.* http://cdn.jsdelivr.net/yocto/sstate/all/PATH;downloadfilename=PATH" 255 SSTATE_MIRRORS ?= "file://.* http://cdn.jsdelivr.net/yocto/sstate/all/PATH;downloadfilename=PATH"
256 BB_HASHSERVE = "auto" 256 BB_HASHSERVE = "auto"
257 BB_SIGNATURE_HANDLER = "OEEquivHash" 257 BB_SIGNATURE_HANDLER = "OEEquivHash"
258 258
259 The hash equivalence server needs a recent version of python
260 websockets installed to work correctly.
261
259#. **Start the Build:** Continue with the following command to build an OS 262#. **Start the Build:** Continue with the following command to build an OS
260 image for the target, which is ``core-image-sato`` in this example: 263 image for the target, which is ``core-image-sato`` in this example:
261 264
diff --git a/documentation/migration-guides/release-notes-5.0.rst b/documentation/migration-guides/release-notes-5.0.rst
index 4bd9125d17..884a66771d 100644
--- a/documentation/migration-guides/release-notes-5.0.rst
+++ b/documentation/migration-guides/release-notes-5.0.rst
@@ -25,6 +25,10 @@ New Features / Enhancements in 5.0
25 25
26 - :term:`TARGET_DBGSRC_DIR`: specifies the target path to debug source files 26 - :term:`TARGET_DBGSRC_DIR`: specifies the target path to debug source files
27 27
28 - :term:`USERADD_DEPENDS`: provides a way to declare dependencies on the users
29 and/or groups created by other recipes, resolving a long-standing build
30 ordering issue
31
28- Architecture-specific enhancements: 32- Architecture-specific enhancements:
29 33
30 - ``genericarm64``: a new :term:`MACHINE` to represent a 64-bit General Arm 34 - ``genericarm64``: a new :term:`MACHINE` to represent a 64-bit General Arm
@@ -84,6 +88,9 @@ New Features / Enhancements in 5.0
84 a Sphinx extension to include jQuery on newer Sphinx releases. Recent 88 a Sphinx extension to include jQuery on newer Sphinx releases. Recent
85 versions of ``python3-sphinx-rtd-theme`` depend on it. 89 versions of ``python3-sphinx-rtd-theme`` depend on it.
86 90
91 - `python3-websockets <https://pypi.org/project/websockets/>`__: a
92 library for building WebSocket servers and clients in Python.
93
87 - `python3-yamllint <https://github.com/adrienverge/yamllint>`__: a linter 94 - `python3-yamllint <https://github.com/adrienverge/yamllint>`__: a linter
88 for YAML files. In U-Boot, the ``binman`` tool uses this linter to verify the 95 for YAML files. In U-Boot, the ``binman`` tool uses this linter to verify the
89 configurations at compile time. 96 configurations at compile time.
@@ -155,6 +162,12 @@ New Features / Enhancements in 5.0
155 162
156- Testing: 163- Testing:
157 164
165 - Move `patchtest` to the core (as ``scripts/patchtest``, test cases under
166 ``meta/lib/patchtest/tests``) and make a number of improvements to enable
167 it to validate patches submitted on the mailing list again. Additionally,
168 make it work with the original upstream version of
169 `Patchwork <http://jk.ozlabs.org/projects/patchwork/>`__.
170
158 - Add an optional ``unimplemented-ptest`` QA warning to detect upstream 171 - Add an optional ``unimplemented-ptest`` QA warning to detect upstream
159 packages with tests, that do not use ptest. 172 packages with tests, that do not use ptest.
160 173
@@ -163,6 +176,9 @@ New Features / Enhancements in 5.0
163 176
164 - ``oeqa``, ``oe-selftest``: add test cases for Maturin (SDK and runtime). 177 - ``oeqa``, ``oe-selftest``: add test cases for Maturin (SDK and runtime).
165 178
179 - Proof-of-concept of screenshot-based runtime UI test
180 (``meta/lib/oeqa/runtime/cases/login.py``)
181
166 - Enable ptests for ``python3-attrs``, ``python3-pyyaml``, ``xz`` 182 - Enable ptests for ``python3-attrs``, ``python3-pyyaml``, ``xz``
167 183
168- Utility script changes: 184- Utility script changes:
@@ -191,8 +207,6 @@ New Features / Enhancements in 5.0
191 extra tasks if the system load is too high, especially in distributions 207 extra tasks if the system load is too high, especially in distributions
192 where ``/proc/pressure`` is disabled. 208 where ``/proc/pressure`` is disabled.
193 209
194 - Add garbage collection to remove unused unihashes from the database.
195
196 - ``taskexp_ncurses``: add ncurses version of ``taskexp``, the dependency 210 - ``taskexp_ncurses``: add ncurses version of ``taskexp``, the dependency
197 explorer originally implemented with GTK. 211 explorer originally implemented with GTK.
198 212
@@ -208,6 +222,17 @@ New Features / Enhancements in 5.0
208 - ``git-make-shallow`` script: add support for Git's ``safe.bareRepository=explicit`` 222 - ``git-make-shallow`` script: add support for Git's ``safe.bareRepository=explicit``
209 configuration setting. 223 configuration setting.
210 224
225 - Hash equivalence gained a number of scalability improvements including:
226
227 - Support for a wide range of database backends through `SQLAlchemy`
228
229 - Support for hash equivalence server and client to communicate over websockets
230
231 - Support for per-user permissions in the hashserver, and on the client side
232 specifying credentials via the environment or ``.netrc``
233
234 - Add garbage collection to remove unused unihashes from the database.
235
211- devtool improvements: 236- devtool improvements:
212 237
213 - Introduce a new ``ide-sdk`` plugin to generate a configuration to use 238 - Introduce a new ``ide-sdk`` plugin to generate a configuration to use
@@ -255,6 +280,12 @@ New Features / Enhancements in 5.0
255 incremental update can be configured with :term:`CVE_DB_INCR_UPDATE_AGE_THRES` 280 incremental update can be configured with :term:`CVE_DB_INCR_UPDATE_AGE_THRES`
256 variable. 281 variable.
257 282
283- Toaster Web UI improvements:
284
285 - Numerous bugfixes, and additional input validation
286
287 - Add `pytest` support and add/update test cases
288
258- Prominent documentation updates: 289- Prominent documentation updates:
259 290
260 - Documentation for using the new ``devtool ide-sdk`` command and features. 291 - Documentation for using the new ``devtool ide-sdk`` command and features.
@@ -318,6 +349,7 @@ The following corrections have been made to the :term:`LICENSE` values set by re
318 349
319- ``elfutils``: split license for libraries & backend and utilities. 350- ``elfutils``: split license for libraries & backend and utilities.
320- ``ghostscript``: correct :term:`LICENSE` to ``AGPL-3.0-or-later``. 351- ``ghostscript``: correct :term:`LICENSE` to ``AGPL-3.0-or-later``.
352- ``kbd``: update license for consolefont and keymaps.
321- ``libsystemd``: set its own :term:`LICENSE` value (``LGPL-2.1-or-later``) to add more granularity. 353- ``libsystemd``: set its own :term:`LICENSE` value (``LGPL-2.1-or-later``) to add more granularity.
322- ``libtest-warnings-perl``: update :term:`LICENSE` ``Artistic-1.0`` to ``Artistic-1.0-Perl``. 354- ``libtest-warnings-perl``: update :term:`LICENSE` ``Artistic-1.0`` to ``Artistic-1.0-Perl``.
323- ``linux-firmware``: set package :term:`LICENSE` appropriately for ``carl9170``, ``rockchip`` and ``powerpr``. 355- ``linux-firmware``: set package :term:`LICENSE` appropriately for ``carl9170``, ``rockchip`` and ``powerpr``.
@@ -350,7 +382,7 @@ Security Fixes in 5.0
350- libxml2: :cve:`2023-45322` (ignored) 382- libxml2: :cve:`2023-45322` (ignored)
351- linux-yocto/6.6: :cve:`2020-16119` 383- linux-yocto/6.6: :cve:`2020-16119`
352- openssh: :cve:`2023-48795`, :cve:`2023-51384`, :cve:`2023-51385` 384- openssh: :cve:`2023-48795`, :cve:`2023-51384`, :cve:`2023-51385`
353- openssl: :cve:`2023-5363`, :cve:`2023-5678`, :cve:`2023-6129`, :cve_mitre:`2023-6237`, :cve:`2024-0727` 385- openssl: :cve:`2023-5363`, :cve:`2023-5678`, :cve:`2023-6129`, :cve_mitre:`2023-6237`, :cve:`2024-0727`, :cve:`2024-2511`
354- perl: :cve:`2023-47100` 386- perl: :cve:`2023-47100`
355- pixman: :cve:`2023-37769` (ignored) 387- pixman: :cve:`2023-37769` (ignored)
356- python3-cryptography{-vectors}: :cve:`2023-49083`, :cve:`2024-26130` 388- python3-cryptography{-vectors}: :cve:`2023-49083`, :cve:`2024-26130`
@@ -526,7 +558,7 @@ Recipe Upgrades in 5.0
526- linux-yocto-dev 6.6+git -> 6.9+git 558- linux-yocto-dev 6.6+git -> 6.9+git
527- linux-yocto-rt 6.1.78+git, 6.5.13+git -> 6.6.23+git 559- linux-yocto-rt 6.1.78+git, 6.5.13+git -> 6.6.23+git
528- linux-yocto-tiny 6.1.78+git, 6.5.13+git -> 6.6.23+git 560- linux-yocto-tiny 6.1.78+git, 6.5.13+git -> 6.6.23+git
529- llvm 17.0.3 -> 18.1.2 561- llvm 17.0.3 -> 18.1.3
530- lsof 4.98.0 -> 4.99.3 562- lsof 4.98.0 -> 4.99.3
531- ltp 20230516 -> 20240129 563- ltp 20230516 -> 20240129
532- lttng-modules 2.13.10 -> 2.13.12 564- lttng-modules 2.13.10 -> 2.13.12
@@ -562,7 +594,7 @@ Recipe Upgrades in 5.0
562- ptest-runner 2.4.2+git -> 2.4.3+git 594- ptest-runner 2.4.2+git -> 2.4.3+git
563- pulseaudio 16.1 -> 17.0 595- pulseaudio 16.1 -> 17.0
564- puzzles 0.0+git (2d9e414ee316…) -> 0.0+git (80aac3104096…) 596- puzzles 0.0+git (2d9e414ee316…) -> 0.0+git (80aac3104096…)
565- python3 3.11.5 -> 3.12.2 597- python3 3.11.5 -> 3.12.3
566- python3-alabaster 0.7.13 -> 0.7.16 598- python3-alabaster 0.7.13 -> 0.7.16
567- python3-attrs 23.1.0 -> 23.2.0 599- python3-attrs 23.1.0 -> 23.2.0
568- python3-babel 2.12.1 -> 2.14.0 600- python3-babel 2.12.1 -> 2.14.0
diff --git a/documentation/poky.yaml.in b/documentation/poky.yaml.in
index 7a686ac4e1..17cbe26e36 100644
--- a/documentation/poky.yaml.in
+++ b/documentation/poky.yaml.in
@@ -1,10 +1,10 @@
1DISTRO : "4.3" 1DISTRO : "5.0"
2DISTRO_NAME_NO_CAP : "nanbield" 2DISTRO_NAME_NO_CAP : "scarthgap"
3DISTRO_NAME : "Nanbield" 3DISTRO_NAME : "Scarthgap"
4DISTRO_NAME_NO_CAP_MINUS_ONE : "mickledore" 4DISTRO_NAME_NO_CAP_MINUS_ONE : "nanbield"
5DISTRO_NAME_NO_CAP_LTS : "kirkstone" 5DISTRO_NAME_NO_CAP_LTS : "scarthgap"
6YOCTO_DOC_VERSION : "4.3" 6YOCTO_DOC_VERSION : "5.0"
7DISTRO_REL_TAG : "yocto-4.3" 7DISTRO_REL_TAG : "yocto-5.0"
8DOCCONF_VERSION : "dev" 8DOCCONF_VERSION : "dev"
9BITBAKE_SERIES : "" 9BITBAKE_SERIES : ""
10YOCTO_DL_URL : "https://downloads.yoctoproject.org" 10YOCTO_DL_URL : "https://downloads.yoctoproject.org"
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 9cdcc1b61b..3f37f42f21 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -9771,6 +9771,12 @@ system and gives an overview of their function and contents.
9771 ``meta-poky/conf/templates/default/local.conf.sample`` in the 9771 ``meta-poky/conf/templates/default/local.conf.sample`` in the
9772 :term:`Source Directory`. 9772 :term:`Source Directory`.
9773 9773
9774 :term:`USERADD_DEPENDS`
9775 Specifies a list of recipes that create users / groups (via
9776 :term:`USERADD_PARAM` / :term:`GROUPADD_PARAM`) which a recipe
9777 depends upon. This ensures that those users / groups are available
9778 when building a recipe.
9779
9774 :term:`USERADD_ERROR_DYNAMIC` 9780 :term:`USERADD_ERROR_DYNAMIC`
9775 If set to ``error``, forces the OpenEmbedded build system to produce 9781 If set to ``error``, forces the OpenEmbedded build system to produce
9776 an error if the user identification (``uid``) and group 9782 an error if the user identification (``uid``) and group
diff --git a/documentation/set_versions.py b/documentation/set_versions.py
index 90e08fc5e0..dec0780834 100755
--- a/documentation/set_versions.py
+++ b/documentation/set_versions.py
@@ -26,9 +26,9 @@ ourversion = None
26if len(sys.argv) == 2: 26if len(sys.argv) == 2:
27 ourversion = sys.argv[1] 27 ourversion = sys.argv[1]
28 28
29activereleases = ["nanbield", "kirkstone", "dunfell"] 29activereleases = ["scarthgap", "nanbield", "kirkstone", "dunfell"]
30devbranch = "scarthgap" 30devbranch = "styhead"
31ltsseries = ["kirkstone", "dunfell"] 31ltsseries = ["scarthgap", "kirkstone", "dunfell"]
32 32
33# used by run-docs-builds to get the default page 33# used by run-docs-builds to get the default page
34if ourversion == "getlatest": 34if ourversion == "getlatest":
@@ -36,6 +36,7 @@ if ourversion == "getlatest":
36 sys.exit(0) 36 sys.exit(0)
37 37
38release_series = collections.OrderedDict() 38release_series = collections.OrderedDict()
39release_series["styhead"] = "5.1"
39release_series["scarthgap"] = "5.0" 40release_series["scarthgap"] = "5.0"
40release_series["nanbield"] = "4.3" 41release_series["nanbield"] = "4.3"
41release_series["mickledore"] = "4.2" 42release_series["mickledore"] = "4.2"
@@ -68,6 +69,7 @@ release_series["laverne"] = "0.9"
68 69
69 70
70bitbake_mapping = { 71bitbake_mapping = {
72 "styhead" : "2.10",
71 "scarthgap" : "2.8", 73 "scarthgap" : "2.8",
72 "nanbield" : "2.6", 74 "nanbield" : "2.6",
73 "mickledore" : "2.4", 75 "mickledore" : "2.4",
diff --git a/documentation/standards.md b/documentation/standards.md
index e0c0cba83c..bc403e393e 100644
--- a/documentation/standards.md
+++ b/documentation/standards.md
@@ -70,27 +70,30 @@ cannot be split without infringing syntactic rules
70or reducing readability, as well as for command output 70or reducing readability, as well as for command output
71which should be kept unmodified. 71which should be kept unmodified.
72 72
73### Project names 73### File, tool and command names
74 74
75Project names should be capitalized in the same 75File, tool, command and package names should be double tick-quoted.
76way they are on Wikipedia, in particular: 76For example, ``` ``conf/local.conf`` ``` is preferred over
77`"conf/local.conf"`.
77 78
78* BitBake 79### Project names
79* OpenEmbedded
80 80
81There are exceptions in which such names can be used 81Project names should be introduced with single quotes, to have them rendered
82in lower case: 82with an italic font and make them easier to distinguish from command names
83(double tick-quoted) and from regular English words.
83 84
84* When referring to a package name 85An exception is when project names appear in hyperlinks, as nested markup
85* When referring to the corresponding command name 86is not supported by Sphinx yet.
86* When used in a cross-reference title. Such
87 titles are usually in lower case.
88 87
89### File, tool and command names 88Project names should also be capitalized (or not) in the same way they are on
89Wikipedia, or on their own project pages if they are not described on
90Wikipedia. If a project name isn't capitalized, it should remain so even
91at the beginning of a sentence.
90 92
91File, tool and command names should be double tick-quoted. 93For example:
92For example, ``` ``conf/local.conf`` ``` is preferred over 94
93`"conf/local.conf"`. 95* ``` `BitBake` ```
96* ``` `ftrace` ```
94 97
95### Variables 98### Variables
96 99