diff options
Diffstat (limited to 'poky/documentation')
-rw-r--r-- | poky/documentation/brief-yoctoprojectqs/index.rst | 8 | ||||
-rw-r--r-- | poky/documentation/migration-guides/release-4.0.rst | 1 | ||||
-rw-r--r-- | poky/documentation/migration-guides/release-notes-4.0.18.rst | 191 | ||||
-rw-r--r-- | poky/documentation/migration-guides/release-notes-5.0.rst | 97 | ||||
-rw-r--r-- | poky/documentation/poky.yaml.in | 26 | ||||
-rw-r--r-- | poky/documentation/ref-manual/svg/releases.svg | 99 | ||||
-rw-r--r-- | poky/documentation/ref-manual/variables.rst | 6 | ||||
-rwxr-xr-x | poky/documentation/set_versions.py | 8 | ||||
-rw-r--r-- | poky/documentation/standards.md | 33 |
9 files changed, 394 insertions, 75 deletions
diff --git a/poky/documentation/brief-yoctoprojectqs/index.rst b/poky/documentation/brief-yoctoprojectqs/index.rst index 61c5cbec36..c5400e4ac8 100644 --- a/poky/documentation/brief-yoctoprojectqs/index.rst +++ b/poky/documentation/brief-yoctoprojectqs/index.rst @@ -251,11 +251,17 @@ an entire Linux distribution, including the toolchain, from source. To use such mirrors, uncomment the below lines in your ``conf/local.conf`` file in the :term:`Build Directory`:: - BB_HASHSERVE_UPSTREAM = "hashserv.yocto.io:8687" + BB_HASHSERVE_UPSTREAM = "wss://hashserv.yoctoproject.org/ws" SSTATE_MIRRORS ?= "file://.* http://cdn.jsdelivr.net/yocto/sstate/all/PATH;downloadfilename=PATH" BB_HASHSERVE = "auto" BB_SIGNATURE_HANDLER = "OEEquivHash" + The hash equivalence server needs the websockets python module version 9.1 + or later. Debian GNU/Linux 12 (Bookworm) and later, Fedora, CentOS Stream + 9 and later, and Ubuntu 22.04 (LTS) and later, all have a recent enough + package. Other supported distributions need to get the module some other + place than their package feed, e.g. via ``pip``. + #. **Start the Build:** Continue with the following command to build an OS image for the target, which is ``core-image-sato`` in this example: diff --git a/poky/documentation/migration-guides/release-4.0.rst b/poky/documentation/migration-guides/release-4.0.rst index 685799e268..d848b3ef64 100644 --- a/poky/documentation/migration-guides/release-4.0.rst +++ b/poky/documentation/migration-guides/release-4.0.rst @@ -24,3 +24,4 @@ Release 4.0 (kirkstone) release-notes-4.0.15 release-notes-4.0.16 release-notes-4.0.17 + release-notes-4.0.18 diff --git a/poky/documentation/migration-guides/release-notes-4.0.18.rst b/poky/documentation/migration-guides/release-notes-4.0.18.rst new file mode 100644 index 0000000000..fc8cd83c02 --- /dev/null +++ b/poky/documentation/migration-guides/release-notes-4.0.18.rst @@ -0,0 +1,191 @@ +.. SPDX-License-Identifier: CC-BY-SA-2.0-UK + +Release notes for Yocto-4.0.18 (Kirkstone) +------------------------------------------ + +Security Fixes in Yocto-4.0.18 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- curl: Fix :cve:`2024-2398` +- expat: fix :cve:`2023-52426` and :cve:`2024-28757` +- libssh2: fix :cve:`2023-48795` +- ncurses: Fix :cve:`2023-50495` +- nghttp2: Fix :cve:`2024-28182` and :cve:`2023-44487` +- openssh: Ignore :cve:`2023-51767` +- openssl: Fix :cve:`2024-2511` +- perl: Ignore :cve:`2023-47100` +- python3-cryptography: Fix :cve:`2024-26130` +- python3-urllib3: Fix :cve:`2023-45803` +- qemu: Fix :cve:`2023-6683` +- ruby: fix :cve_mitre:`2024-27281` +- rust: Ignore :cve:`2024-24576` +- tiff: Fix :cve:`2023-52356` and :cve:`2023-6277` +- xserver-xorg: Fix :cve:`2024-31080` and :cve:`2024-31081` +- xwayland: Fix :cve:`2023-6816`, :cve:`2024-0408` and :cve:`2024-0409` + + +Fixes in Yocto-4.0.18 +~~~~~~~~~~~~~~~~~~~~~ + +- build-appliance-image: Update to kirkstone head revision +- common-licenses: Backport missing license +- contributor-guide: add notes for tests +- contributor-guide: be more specific about meta-* trees +- cups: fix typo in :cve:`2023-32360` backport patch +- cve-update-nvd2-native: Add an age threshold for incremental update +- cve-update-nvd2-native: Fix CVE configuration update +- cve-update-nvd2-native: Fix typo in comment +- cve-update-nvd2-native: Remove duplicated CVE_CHECK_DB_FILE definition +- cve-update-nvd2-native: Remove rejected CVE from database +- cve-update-nvd2-native: nvd_request_next: Improve comment +- dev-manual: improve descriptions of 'bitbake -S printdiff' +- dev-manual: packages: fix capitalization +- docs: conf.py: properly escape backslashes for latex_elements +- gcc: Backport sanitizer fix for 32-bit ALSR +- glibc: Fix subscript typos for get_nscd_addresses +- kernel-dev: join mkdir commands with -p +- linux-firmware: Upgrade to 20240220 +- manuals: add initial sphinx-lint support +- manuals: add initial stylechecks with Vale +- manuals: document VIRTUAL-RUNTIME variables +- manuals: fix duplicate "stylecheck" target +- manuals: fix incorrect double backticks +- manuals: fix trailing spaces +- manuals: refer to new yocto-patches mailing list wherever appropriate +- manuals: remove tab characters +- manuals: replace hyphens with em dashes +- manuals: use "manual page(s)" +- migration-guides: add release notes for 4.0.17 +- poky.conf: bump version for 4.0.18 +- profile-manual: usage.rst: fix reference to bug report +- profile-manual: usage.rst: formatting fixes +- profile-manual: usage.rst: further style improvements +- python3-urllib3: Upgrade to v1.26.18 +- ref-manual: add documentation of the variable :term:`SPDX_NAMESPACE_PREFIX` +- ref-manual: tasks: do_cleanall: recommend using '-f' instead +- ref-manual: tasks: do_cleansstate: recommend using '-f' instead for a shared sstate +- ref-manual: variables: adding multiple groups in :term:`GROUPADD_PARAM` +- ref-manual: variables: correct sdk installation default path +- stress-ng: avoid calling sync during do_compile +- systemd: Fix vlan qos mapping +- tcl: Add a way to skip ptests +- tcl: skip async and event tests in run-ptest +- tcl: skip timing-dependent tests in run-ptest +- valgrind: skip intermittently failing ptest +- wireless-regdb: Upgrade to 2024.01.23 +- yocto-uninative: Update to 4.4 for glibc 2.39 + + +Known Issues in Yocto-4.0.18 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- N/A + + +Contributors to Yocto-4.0.18 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- Alex Kiernan +- Alex Stewart +- Alexander Kanavin +- BELOUARGA Mohamed +- Claus Stovgaard +- Colin McAllister +- Geoff Parker +- Haitao Liu +- Harish Sadineni +- Johan Bezem +- Jonathan GUILLOT +- Jörg Sommer +- Khem Raj +- Lee Chee Yang +- Luca Ceresoli +- Martin Jansa +- Meenali Gupta +- Michael Halstead +- Michael Opdenacker +- Peter Marko +- Quentin Schulz +- Ross Burton +- Sana Kazi +- Simone Weiß +- Soumya Sambu +- Steve Sakoman +- Tan Wen Yan +- Vijay Anusuri +- Wang Mingyu +- Yoann Congal +- Yogita Urade +- Zahir Hussain + + +Repositories / Downloads for Yocto-4.0.18 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`kirkstone </poky/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.18 </poky/log/?h=yocto-4.0.18>` +- Git Revision: :yocto_git:`31751bba1c789f15f574773a659b8017d7bcf440 </poky/commit/?id=31751bba1c789f15f574773a659b8017d7bcf440>` +- Release Artefact: poky-31751bba1c789f15f574773a659b8017d7bcf440 +- sha: 72d5aa65c3c37766ebc24b212740272c1d52342468548f9c070241d3522ad2ca +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.18/poky-31751bba1c789f15f574773a659b8017d7bcf440.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.18/poky-31751bba1c789f15f574773a659b8017d7bcf440.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`kirkstone </openembedded-core/log/?h=kirkstone>` +- Tag: :oe_git:`yocto-4.0.18 </openembedded-core/log/?h=yocto-4.0.18>` +- Git Revision: :oe_git:`b7182571242dc4e23e5250a449d90348e62a6abc </openembedded-core/commit/?id=b7182571242dc4e23e5250a449d90348e62a6abc>` +- Release Artefact: oecore-b7182571242dc4e23e5250a449d90348e62a6abc +- sha: 6f257e50c10ebae673dcf61a833b3270db6d22781f02f6794a370aac839f1020 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.18/oecore-b7182571242dc4e23e5250a449d90348e62a6abc.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.18/oecore-b7182571242dc4e23e5250a449d90348e62a6abc.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`kirkstone </meta-mingw/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.18 </meta-mingw/log/?h=yocto-4.0.18>` +- Git Revision: :yocto_git:`f6b38ce3c90e1600d41c2ebb41e152936a0357d7 </meta-mingw/commit/?id=f6b38ce3c90e1600d41c2ebb41e152936a0357d7>` +- Release Artefact: meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7 +- sha: 7d57167c19077f4ab95623d55a24c2267a3a3fb5ed83688659b4c03586373b25 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.18/meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.18/meta-mingw-f6b38ce3c90e1600d41c2ebb41e152936a0357d7.tar.bz2 + +meta-gplv2 + +- Repository Location: :yocto_git:`/meta-gplv2` +- Branch: :yocto_git:`kirkstone </meta-gplv2/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.18 </meta-gplv2/log/?h=yocto-4.0.18>` +- Git Revision: :yocto_git:`d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a </meta-gplv2/commit/?id=d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a>` +- Release Artefact: meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a +- sha: c386f59f8a672747dc3d0be1d4234b6039273d0e57933eb87caa20f56b9cca6d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.18/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.18/meta-gplv2-d2f8b5cdb285b72a4ed93450f6703ca27aa42e8a.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.0 </bitbake/log/?h=2.0>` +- Tag: :oe_git:`yocto-4.0.18 </bitbake/log/?h=yocto-4.0.18>` +- Git Revision: :oe_git:`40fd5f4eef7460ca67f32cfce8e229e67e1ff607 </bitbake/commit/?id=40fd5f4eef7460ca67f32cfce8e229e67e1ff607>` +- Release Artefact: bitbake-40fd5f4eef7460ca67f32cfce8e229e67e1ff607 +- sha: 5d20a0e4c5d0fce44bd84778168714a261a30a4b83f67c88df3b8a7e7115e444 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-4.0.18/bitbake-40fd5f4eef7460ca67f32cfce8e229e67e1ff607.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-4.0.18/bitbake-40fd5f4eef7460ca67f32cfce8e229e67e1ff607.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`kirkstone </yocto-docs/log/?h=kirkstone>` +- Tag: :yocto_git:`yocto-4.0.18 </yocto-docs/log/?h=yocto-4.0.18>` +- Git Revision: :yocto_git:`fd1423141e7458ba557db465c171b0b4e9063987 </yocto-docs/commit/?id=fd1423141e7458ba557db465c171b0b4e9063987>` + diff --git a/poky/documentation/migration-guides/release-notes-5.0.rst b/poky/documentation/migration-guides/release-notes-5.0.rst index 4bd9125d17..800ba20a27 100644 --- a/poky/documentation/migration-guides/release-notes-5.0.rst +++ b/poky/documentation/migration-guides/release-notes-5.0.rst @@ -25,6 +25,10 @@ New Features / Enhancements in 5.0 - :term:`TARGET_DBGSRC_DIR`: specifies the target path to debug source files + - :term:`USERADD_DEPENDS`: provides a way to declare dependencies on the users + and/or groups created by other recipes, resolving a long-standing build + ordering issue + - Architecture-specific enhancements: - ``genericarm64``: a new :term:`MACHINE` to represent a 64-bit General Arm @@ -84,6 +88,9 @@ New Features / Enhancements in 5.0 a Sphinx extension to include jQuery on newer Sphinx releases. Recent versions of ``python3-sphinx-rtd-theme`` depend on it. + - `python3-websockets <https://pypi.org/project/websockets/>`__: a + library for building WebSocket servers and clients in Python. + - `python3-yamllint <https://github.com/adrienverge/yamllint>`__: a linter for YAML files. In U-Boot, the ``binman`` tool uses this linter to verify the configurations at compile time. @@ -155,6 +162,12 @@ New Features / Enhancements in 5.0 - Testing: + - Move `patchtest` to the core (as ``scripts/patchtest``, test cases under + ``meta/lib/patchtest/tests``) and make a number of improvements to enable + it to validate patches submitted on the mailing list again. Additionally, + make it work with the original upstream version of + `Patchwork <http://jk.ozlabs.org/projects/patchwork/>`__. + - Add an optional ``unimplemented-ptest`` QA warning to detect upstream packages with tests, that do not use ptest. @@ -163,6 +176,9 @@ New Features / Enhancements in 5.0 - ``oeqa``, ``oe-selftest``: add test cases for Maturin (SDK and runtime). + - Proof-of-concept of screenshot-based runtime UI test + (``meta/lib/oeqa/runtime/cases/login.py``) + - Enable ptests for ``python3-attrs``, ``python3-pyyaml``, ``xz`` - Utility script changes: @@ -191,8 +207,6 @@ New Features / Enhancements in 5.0 extra tasks if the system load is too high, especially in distributions where ``/proc/pressure`` is disabled. - - Add garbage collection to remove unused unihashes from the database. - - ``taskexp_ncurses``: add ncurses version of ``taskexp``, the dependency explorer originally implemented with GTK. @@ -208,6 +222,17 @@ New Features / Enhancements in 5.0 - ``git-make-shallow`` script: add support for Git's ``safe.bareRepository=explicit`` configuration setting. + - Hash equivalence gained a number of scalability improvements including: + + - Support for a wide range of database backends through `SQLAlchemy` + + - Support for hash equivalence server and client to communicate over websockets + + - Support for per-user permissions in the hashserver, and on the client side + specifying credentials via the environment or ``.netrc`` + + - Add garbage collection to remove unused unihashes from the database. + - devtool improvements: - Introduce a new ``ide-sdk`` plugin to generate a configuration to use @@ -255,6 +280,12 @@ New Features / Enhancements in 5.0 incremental update can be configured with :term:`CVE_DB_INCR_UPDATE_AGE_THRES` variable. +- Toaster Web UI improvements: + + - Numerous bugfixes, and additional input validation + + - Add `pytest` support and add/update test cases + - Prominent documentation updates: - 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 - ``elfutils``: split license for libraries & backend and utilities. - ``ghostscript``: correct :term:`LICENSE` to ``AGPL-3.0-or-later``. +- ``kbd``: update license for consolefont and keymaps. - ``libsystemd``: set its own :term:`LICENSE` value (``LGPL-2.1-or-later``) to add more granularity. - ``libtest-warnings-perl``: update :term:`LICENSE` ``Artistic-1.0`` to ``Artistic-1.0-Perl``. - ``linux-firmware``: set package :term:`LICENSE` appropriately for ``carl9170``, ``rockchip`` and ``powerpr``. @@ -350,7 +382,7 @@ Security Fixes in 5.0 - libxml2: :cve:`2023-45322` (ignored) - linux-yocto/6.6: :cve:`2020-16119` - openssh: :cve:`2023-48795`, :cve:`2023-51384`, :cve:`2023-51385` -- openssl: :cve:`2023-5363`, :cve:`2023-5678`, :cve:`2023-6129`, :cve_mitre:`2023-6237`, :cve:`2024-0727` +- openssl: :cve:`2023-5363`, :cve:`2023-5678`, :cve:`2023-6129`, :cve_mitre:`2023-6237`, :cve:`2024-0727`, :cve:`2024-2511` - perl: :cve:`2023-47100` - pixman: :cve:`2023-37769` (ignored) - python3-cryptography{-vectors}: :cve:`2023-49083`, :cve:`2024-26130` @@ -526,7 +558,7 @@ Recipe Upgrades in 5.0 - linux-yocto-dev 6.6+git -> 6.9+git - linux-yocto-rt 6.1.78+git, 6.5.13+git -> 6.6.23+git - linux-yocto-tiny 6.1.78+git, 6.5.13+git -> 6.6.23+git -- llvm 17.0.3 -> 18.1.2 +- llvm 17.0.3 -> 18.1.3 - lsof 4.98.0 -> 4.99.3 - ltp 20230516 -> 20240129 - lttng-modules 2.13.10 -> 2.13.12 @@ -562,7 +594,7 @@ Recipe Upgrades in 5.0 - ptest-runner 2.4.2+git -> 2.4.3+git - pulseaudio 16.1 -> 17.0 - puzzles 0.0+git (2d9e414ee316…) -> 0.0+git (80aac3104096…) -- python3 3.11.5 -> 3.12.2 +- python3 3.11.5 -> 3.12.3 - python3-alabaster 0.7.13 -> 0.7.16 - python3-attrs 23.1.0 -> 23.2.0 - python3-babel 2.12.1 -> 2.14.0 @@ -904,3 +936,58 @@ Thanks to the following people who contributed to this release: Repositories / Downloads for Yocto-5.0 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +poky + +- Repository Location: :yocto_git:`/poky` +- Branch: :yocto_git:`scarthgap </poky/log/?h=scarthgap>` +- Tag: :yocto_git:`yocto-5.0 </poky/log/?h=yocto-5.0>` +- Git Revision: :yocto_git:`fb91a49387cfb0c8d48303bb3354325ba2a05587 </poky/commit/?id=fb91a49387cfb0c8d48303bb3354325ba2a05587>` +- Release Artefact: poky-fb91a49387cfb0c8d48303bb3354325ba2a05587 +- sha: 8a0dff4b677b9414ab814ed35d1880196123732ea16ab2fafa388bcc509b32ab +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-5.0/poky-fb91a49387cfb0c8d48303bb3354325ba2a05587.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-5.0/poky-fb91a49387cfb0c8d48303bb3354325ba2a05587.tar.bz2 + +openembedded-core + +- Repository Location: :oe_git:`/openembedded-core` +- Branch: :oe_git:`scarthgap </openembedded-core/log/?h=scarthgap>` +- Tag: :oe_git:`yocto-5.0 </openembedded-core/log/?h=yocto-5.0>` +- Git Revision: :oe_git:`b65b4e5a8e4473d8ca43835ba17bc8bd4bdca277 </openembedded-core/commit/?id=b65b4e5a8e4473d8ca43835ba17bc8bd4bdca277>` +- Release Artefact: oecore-b65b4e5a8e4473d8ca43835ba17bc8bd4bdca277 +- sha: c7fd05d1a00c70acba2540e60dce01a1bdc4701ebff9a808784960240c69261d +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-5.0/oecore-b65b4e5a8e4473d8ca43835ba17bc8bd4bdca277.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-5.0/oecore-b65b4e5a8e4473d8ca43835ba17bc8bd4bdca277.tar.bz2 + +meta-mingw + +- Repository Location: :yocto_git:`/meta-mingw` +- Branch: :yocto_git:`scarthgap </meta-mingw/log/?h=scarthgap>` +- Tag: :yocto_git:`yocto-5.0 </meta-mingw/log/?h=yocto-5.0>` +- Git Revision: :yocto_git:`acbba477893ef87388effc4679b7f40ee49fc852 </meta-mingw/commit/?id=acbba477893ef87388effc4679b7f40ee49fc852>` +- Release Artefact: meta-mingw-acbba477893ef87388effc4679b7f40ee49fc852 +- sha: 3b7c2f475dad5130bace652b150367f587d44b391218b1364a8bbc430b48c54c +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-5.0/meta-mingw-acbba477893ef87388effc4679b7f40ee49fc852.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-5.0/meta-mingw-acbba477893ef87388effc4679b7f40ee49fc852.tar.bz2 + +bitbake + +- Repository Location: :oe_git:`/bitbake` +- Branch: :oe_git:`2.8 </bitbake/log/?h=2.8>` +- Tag: :oe_git:`yocto-5.0 </bitbake/log/?h=yocto-5.0>` +- Git Revision: :oe_git:`c86466d51e8ff14e57a734c1eec5bb651fdc73ef </bitbake/commit/?id=c86466d51e8ff14e57a734c1eec5bb651fdc73ef>` +- Release Artefact: bitbake-c86466d51e8ff14e57a734c1eec5bb651fdc73ef +- sha: 45c91294c1fa5a0044f1bb72a9bb69456bb458747114115af85c7664bf672d48 +- Download Locations: + http://downloads.yoctoproject.org/releases/yocto/yocto-5.0/bitbake-c86466d51e8ff14e57a734c1eec5bb651fdc73ef.tar.bz2 + http://mirrors.kernel.org/yocto/yocto/yocto-5.0/bitbake-c86466d51e8ff14e57a734c1eec5bb651fdc73ef.tar.bz2 + +yocto-docs + +- Repository Location: :yocto_git:`/yocto-docs` +- Branch: :yocto_git:`scarthgap </yocto-docs/log/?h=scarthgap>` +- Tag: :yocto_git:`yocto-5.0 </yocto-docs/log/?h=yocto-5.0>` +- Git Revision: :yocto_git:`0cdc0afd3332459d30cfc8f4c2e62bdcc23f5ed5 </yocto-docs/commit/?id=0cdc0afd3332459d30cfc8f4c2e62bdcc23f5ed5>` + diff --git a/poky/documentation/poky.yaml.in b/poky/documentation/poky.yaml.in index 7a686ac4e1..0c04b615ea 100644 --- a/poky/documentation/poky.yaml.in +++ b/poky/documentation/poky.yaml.in @@ -1,10 +1,10 @@ -DISTRO : "4.3" -DISTRO_NAME_NO_CAP : "nanbield" -DISTRO_NAME : "Nanbield" -DISTRO_NAME_NO_CAP_MINUS_ONE : "mickledore" -DISTRO_NAME_NO_CAP_LTS : "kirkstone" -YOCTO_DOC_VERSION : "4.3" -DISTRO_REL_TAG : "yocto-4.3" +DISTRO : "5.0" +DISTRO_NAME_NO_CAP : "scarthgap" +DISTRO_NAME : "Scarthgap" +DISTRO_NAME_NO_CAP_MINUS_ONE : "nanbield" +DISTRO_NAME_NO_CAP_LTS : "scarthgap" +YOCTO_DOC_VERSION : "5.0" +DISTRO_REL_TAG : "yocto-5.0" DOCCONF_VERSION : "dev" BITBAKE_SERIES : "" YOCTO_DL_URL : "https://downloads.yoctoproject.org" @@ -12,18 +12,18 @@ YOCTO_AB_URL : "https://autobuilder.yoctoproject.org" YOCTO_RELEASE_DL_URL : "&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;" UBUNTU_HOST_PACKAGES_ESSENTIAL : "gawk wget git diffstat unzip texinfo gcc \ build-essential chrpath socat cpio python3 python3-pip python3-pexpect \ - xz-utils debianutils iputils-ping python3-git python3-jinja2 libegl1-mesa libsdl1.2-dev \ - python3-subunit mesa-common-dev zstd liblz4-tool file locales libacl1 + xz-utils debianutils iputils-ping python3-git python3-jinja2 \ + python3-subunit zstd liblz4-tool file locales libacl1 \n\ $ sudo locale-gen en_US.UTF-8" FEDORA_HOST_PACKAGES_ESSENTIAL : "gawk make wget tar bzip2 gzip python3 unzip perl patch \ diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath \ ccache perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue perl-bignum socat \ python3-pexpect findutils which file cpio python python3-pip xz python3-GitPython \ - python3-jinja2 SDL-devel rpcgen mesa-libGL-devel perl-FindBin perl-File-Compare \ + python3-jinja2 rpcgen perl-FindBin perl-File-Compare \ perl-File-Copy perl-locale zstd lz4 hostname glibc-langpack-en libacl" OPENSUSE_HOST_PACKAGES_ESSENTIAL : "python gcc gcc-c++ git chrpath make wget python-xml \ diffstat makeinfo python-curses patch socat python3 python3-curses tar python3-pip \ - python3-pexpect xz which python3-Jinja2 Mesa-libEGL1 libSDL-devel rpcgen Mesa-dri-devel \ + python3-pexpect xz which python3-Jinja2 rpcgen \ zstd lz4 bzip2 gzip hostname libacl1 \n\ $ sudo pip3 install GitPython" ALMALINUX_HOST_PACKAGES_ESSENTIAL : "-y epel-release @@ -33,8 +33,8 @@ ALMALINUX_HOST_PACKAGES_ESSENTIAL : "-y epel-release \n\ $ sudo dnf install gawk make wget tar bzip2 gzip python3 unzip perl patch \ diffutils diffstat git cpp gcc gcc-c++ glibc-devel texinfo chrpath ccache \ socat perl-Data-Dumper perl-Text-ParseWords perl-Thread-Queue python3-pip \ - python3-GitPython python3-jinja2 python3-pexpect xz which SDL-devel \ - rpcgen mesa-libGL-devel zstd lz4 cpio glibc-langpack-en libacl" + python3-GitPython python3-jinja2 python3-pexpect xz which \ + rpcgen zstd lz4 cpio glibc-langpack-en libacl" PIP3_HOST_PACKAGES_DOC : "$ sudo pip3 install sphinx sphinx_rtd_theme pyyaml" MIN_PYTHON_VERSION : "3.8.0" MIN_TAR_VERSION : "1.28" diff --git a/poky/documentation/ref-manual/svg/releases.svg b/poky/documentation/ref-manual/svg/releases.svg index 198d4632b1..036aa467cc 100644 --- a/poky/documentation/ref-manual/svg/releases.svg +++ b/poky/documentation/ref-manual/svg/releases.svg @@ -3,8 +3,8 @@ version="1.1" id="svg2" width="2040.0006" - height="624.30518" - viewBox="0 0 2040.0006 624.30515" + height="669.30511" + viewBox="0 0 2040.0006 669.30509" sodipodi:docname="releases.svg" inkscape:version="1.1.2 (0a00cf5339, 2022-02-04)" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" @@ -409,8 +409,8 @@ id="namedview4" showgrid="true" inkscape:zoom="1.4472045" - inkscape:cx="736.24703" - inkscape:cy="312.32629" + inkscape:cx="987.76641" + inkscape:cy="357.93145" inkscape:window-x="1728" inkscape:window-y="0" inkscape:window-maximized="1" @@ -427,13 +427,13 @@ type="xygrid" id="grid1257" originx="-289.99936" - originy="325" /> + originy="369.99998" /> </sodipodi:namedview> <g inkscape:groupmode="layer" inkscape:label="Image" id="g10" - transform="translate(-289.99936,325.00004)"> + transform="translate(-289.99936,370.00003)"> <path style="fill:none;fill-rule:evenodd;stroke:#000000;stroke-width:0.5;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" d="m 1080,220.00003 v -515.00007 0 0" @@ -669,11 +669,11 @@ style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" id="tspan10317-2-9-1-4">4.2</tspan></text> <g - id="g1379"> + id="g1258"> <rect style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" id="rect917-0-0-4-4-9-4-5-38" - width="140.00003" + width="120.00002" height="45.000004" x="1220" y="-230.00005" @@ -696,53 +696,76 @@ id="tspan10317-2-9-1-4-6">4.3</tspan></text> </g> <rect - style="opacity:0.75;fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" - id="rect917-0-0-4-4-9-4-5-3-9" - width="979.99994" + style="opacity:0.75;fill:#241f31;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" + id="rect917-0-0-4-4-9-4-5-3-9-2" + width="140" height="45.000004" - x="1320" - y="-285.00003" + x="1440" + y="-340.00003" ry="2.2558987" /> <text xml:space="preserve" style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - x="1373.233" - y="-265.32928" - id="text1185-3-55-4-0-0-0-1-1-6"><tspan + x="1487.233" + y="-320.32928" + id="text1185-3-55-4-0-0-0-1-1-6-4"><tspan sodipodi:role="line" - x="1373.233" - y="-265.32928" + x="1487.233" + y="-320.32928" style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" - id="tspan957-2-8-6-3-9-7-4-2">Scarthgap</tspan><tspan + id="tspan957-2-8-6-3-9-7-4-2-0">Styhead</tspan><tspan sodipodi:role="line" - x="1373.233" - y="-247.33261" + x="1487.233" + y="-302.33261" style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" - id="tspan10317-2-9-1-4-6-5">5.0</tspan></text> - <rect + id="tspan10317-2-9-1-4-6-5-6">5.1</tspan></text> + <g + id="g1591"> + <rect + style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" + id="rect917-0-0-4-4-9-9" + width="960.00012" + height="45.000004" + x="859.99994" + y="-64.999992" + ry="2.2558987" /> + <text + xml:space="preserve" + style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="928.49872" + y="-45.648258" + id="text1185-3-55-4-0-0-9"><tspan + sodipodi:role="line" + x="928.49872" + y="-45.648258" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan957-2-8-6-3-6">Kirkstone (LTS)</tspan><tspan + sodipodi:role="line" + x="928.49872" + y="-27.651579" + style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" + id="tspan10317-2-9-0">4.0</tspan></text> + </g> + <path + id="rect917-0-0-4-4-9-9-9" style="fill:#333333;fill-opacity:1;fill-rule:evenodd;stroke:none;stroke-width:2;stroke-opacity:1" - id="rect917-0-0-4-4-9-9" - width="960.00012" - height="45.000004" - x="859.99994" - y="-64.999992" - ry="2.2558987" /> + d="m 1322.3015,-285.00003 c -1.2753,0 -2.302,1.00609 -2.302,2.25586 v 40.48828 c 0,1.24977 1.0267,2.25586 2.302,2.25586 h 975.0412 c 1.2754,0 2.302,-1.00609 2.302,-2.25586 v -40.48828 c 0,-1.24977 -1.0266,-2.25586 -2.302,-2.25586 z" /> <text xml:space="preserve" style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" - x="928.49872" - y="-45.648258" - id="text1185-3-55-4-0-0-9"><tspan + x="1390.4988" + y="-265.64832" + id="text1185-3-55-4-0-0-9-0"><tspan sodipodi:role="line" - x="928.49872" - y="-45.648258" + x="1390.4988" + y="-265.64832" style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" - id="tspan957-2-8-6-3-6">Kirkstone (LTS)</tspan><tspan + id="tspan957-2-8-6-3-6-8">Scarthgap (LTS)</tspan><tspan sodipodi:role="line" - x="928.49872" - y="-27.651579" + x="1390.4988" + y="-247.65164" style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:13.3333px;font-family:'Liberation Sans';-inkscape-font-specification:'Liberation Sans Bold';text-align:center;text-anchor:middle;fill:#fffefe;fill-opacity:1;stroke:none" - id="tspan10317-2-9-0">4.0</tspan></text> + id="tspan10317-2-9-0-1">5.0</tspan></text> <text xml:space="preserve" style="font-weight:bold;font-size:13.3333px;line-height:125%;font-family:'Nimbus Roman';-inkscape-font-specification:'Nimbus Roman, Bold';letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;fill:#fffefe;fill-opacity:1;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" diff --git a/poky/documentation/ref-manual/variables.rst b/poky/documentation/ref-manual/variables.rst index 9cdcc1b61b..3f37f42f21 100644 --- a/poky/documentation/ref-manual/variables.rst +++ b/poky/documentation/ref-manual/variables.rst @@ -9771,6 +9771,12 @@ system and gives an overview of their function and contents. ``meta-poky/conf/templates/default/local.conf.sample`` in the :term:`Source Directory`. + :term:`USERADD_DEPENDS` + Specifies a list of recipes that create users / groups (via + :term:`USERADD_PARAM` / :term:`GROUPADD_PARAM`) which a recipe + depends upon. This ensures that those users / groups are available + when building a recipe. + :term:`USERADD_ERROR_DYNAMIC` If set to ``error``, forces the OpenEmbedded build system to produce an error if the user identification (``uid``) and group diff --git a/poky/documentation/set_versions.py b/poky/documentation/set_versions.py index 90e08fc5e0..dec0780834 100755 --- a/poky/documentation/set_versions.py +++ b/poky/documentation/set_versions.py @@ -26,9 +26,9 @@ ourversion = None if len(sys.argv) == 2: ourversion = sys.argv[1] -activereleases = ["nanbield", "kirkstone", "dunfell"] -devbranch = "scarthgap" -ltsseries = ["kirkstone", "dunfell"] +activereleases = ["scarthgap", "nanbield", "kirkstone", "dunfell"] +devbranch = "styhead" +ltsseries = ["scarthgap", "kirkstone", "dunfell"] # used by run-docs-builds to get the default page if ourversion == "getlatest": @@ -36,6 +36,7 @@ if ourversion == "getlatest": sys.exit(0) release_series = collections.OrderedDict() +release_series["styhead"] = "5.1" release_series["scarthgap"] = "5.0" release_series["nanbield"] = "4.3" release_series["mickledore"] = "4.2" @@ -68,6 +69,7 @@ release_series["laverne"] = "0.9" bitbake_mapping = { + "styhead" : "2.10", "scarthgap" : "2.8", "nanbield" : "2.6", "mickledore" : "2.4", diff --git a/poky/documentation/standards.md b/poky/documentation/standards.md index e0c0cba83c..bc403e393e 100644 --- a/poky/documentation/standards.md +++ b/poky/documentation/standards.md @@ -70,27 +70,30 @@ cannot be split without infringing syntactic rules or reducing readability, as well as for command output which should be kept unmodified. -### Project names +### File, tool and command names -Project names should be capitalized in the same -way they are on Wikipedia, in particular: +File, tool, command and package names should be double tick-quoted. +For example, ``` ``conf/local.conf`` ``` is preferred over +`"conf/local.conf"`. -* BitBake -* OpenEmbedded +### Project names -There are exceptions in which such names can be used -in lower case: +Project names should be introduced with single quotes, to have them rendered +with an italic font and make them easier to distinguish from command names +(double tick-quoted) and from regular English words. -* When referring to a package name -* When referring to the corresponding command name -* When used in a cross-reference title. Such - titles are usually in lower case. +An exception is when project names appear in hyperlinks, as nested markup +is not supported by Sphinx yet. -### File, tool and command names +Project names should also be capitalized (or not) in the same way they are on +Wikipedia, or on their own project pages if they are not described on +Wikipedia. If a project name isn't capitalized, it should remain so even +at the beginning of a sentence. -File, tool and command names should be double tick-quoted. -For example, ``` ``conf/local.conf`` ``` is preferred over -`"conf/local.conf"`. +For example: + +* ``` `BitBake` ``` +* ``` `ftrace` ``` ### Variables |