diff mbox series

[15/16] release-notes-5.1: update for several section

Message ID 20241009074120.866786-16-antonin.godard@bootlin.com
State Superseded
Headers show
Series Updates for styhead | expand

Commit Message

Antonin Godard Oct. 9, 2024, 7:41 a.m. UTC 
From: Lee Chee Yang <chee.yang.lee@intel.com>

update for these changes:
 - license
 - recipe enable for ptests
 - new class, recipe and variable.
 - PACKAGECONFIG
 - some utility script, class and include file.
 - bitbake.
 - qemu/runqemu.
 - Contributors.

removed wic as no significant change or improvement.

Antonin Godard: amend and fix some typos.

Signed-off-by: Lee Chee Yang <chee.yang.lee@intel.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 .../migration-guides/release-notes-5.1.rst    | 306 +++++++++++++++++-
 1 file changed, 303 insertions(+), 3 deletions(-)

Comments

Michael Opdenacker Oct. 9, 2024, 4:18 p.m. UTC | #1 
On 10/9/24 09:41, Antonin Godard via lists.yoctoproject.org wrote:
> diff --git a/documentation/migration-guides/release-notes-5.1.rst b/documentation/migration-guides/release-notes-5.1.rst
> index 074d277da..211f92553 100644
> --- a/documentation/migration-guides/release-notes-5.1.rst
> +++ b/documentation/migration-guides/release-notes-5.1.rst
>
> +   - runqemu: :term:`QB_DRIVE_TYPE` now support for sd card (/dev/mmcblk)
You didn't write it in the first place, but that's an opportunity to use 
``/dev/mmcblk`` here.
>   
> --  wic Image Creator enhancements:
> +-  Rust improvements:
>   
>   -  SDK-related improvements:
>   
> +   -  included ``nativesdk-python3-pip`` in buildtools.
> +
>   -  Testing:
>   
>      -  oeqa/selftest: Only rewrite envvars paths that absolutely point to builddir
>   
> -   -  Enable ptests for ``python3-libarchive-c``
> +   -  Enable ptests for ``python3-cffi``, ``python3-idna``, ``python3-libarchive-c``,
> +      ``python3-mako``, ``python3-packaging``, ``python3-uritools`` and ``python3-rpds-py``.
>   
>   -  Utility script changes:
>   
> +   -  New ``cve-json-to-text`` script that converts the cve-check result from the JSON format
> +      to the TEXT format as cve-check removed text format.


s/cve-check/``cve-check``/
as in other places in the docs.

> +
> +   -  New ``makefile-getvar`` script to extract value from a Makefile.
> +
> +   -  New ``pull-spdx-licenses`` script to pull SPDX license data, update license list JSON
> +      data and update license directory.
> +
> +   -  Several improvements in ``oe-build-perf-report`` report.
> +
> +   -  ``oe-debuginfod`` add parameter "-d" to store debuginfod files in project sub-directory.

Add ":" after ``oe-debuginfod``?

> +
> +   -  ``resulttool`` support test report generation in JUnit XML format.


Same here after ``resulttool``.

> +
> +
>   -  BitBake improvements:
>   
> +   -  New go module fetcher (``gomod://``) for downloading module dependencies to the
> +      module cache from a module proxy.
> +
> +   -  New go module fetcher (``gomodgit://``) for downloading module dependencies to the
> +      module cache directly from a git repository.

s/go/Go/  in the above lines.

> +
> +   -  Fetcher for rust crate: added check for latest upstream version.

s/rust/Rust/

See the style guide for project names: 
https://git.yoctoproject.org/yocto-docs/tree/documentation/standards.md#n79
I know that the style is not very strictly enforced in release notes. 
This is not exactly like formal documentation.

It's up to you. It's not a big deal if you don't change these. The same 
applies to the following lines...

> +
> +   -  Syncrpc now requires a minimum version of the websockets module depend on python version.


s/python/Python/?

> +
> +   -  Improved bitbake-hashclient stress statistics reporting.
> +
> +   -  bitbake-hashserv added ``reuseport`` parameter to enable SO_REUSEPORT, allowing
> +      multiple servers to bind to the same port for load balancing
> +
> +   -  improved cloning speed with :term:`BB_GIT_SHALLOW` and :term:`BB_GENERATE_MIRROR_TARBALLS`.
> +
> +   -  bitbake UI now include log paths for failed task.


s/bitbake/BitBake/?

> +
> +   -  fetcher2 support for wget and wget2.
> +
> +   -  fetcher2 support npm package name with '@' character.
> +
> +   -  Codeparser now support shell substitution in quotes, for example::
> +
> +         var1="$(cmd1 ...)"
> +
>   -  devtool improvements:
>   
>      - Fix ``_test_devtool_add_git_url`` test
> @@ -52,6 +114,54 @@ New Features / Enhancements in 5.1
>   
>      -  Fix reproducibility for ``spirv-tools``
>   
> +   -  Allow selection of host key types used by openssh.
> +
> +   -  New glibc task do_symlist to list exported symbols.
> +
> +   -  initramfs-framework support for force reboot in the case of fatal error.
> +
> +   -  insane class now check for patch-status and pep517-backend by default.

:ref:`ref-classes-insane`

> +
> +   -  New ``yocto-space-optimize`` include file to allow turning off debug compiler options
> +      for a small set of recipes to reduce build on disk footprint and package/sstate sizes.
> +
> +   -  Update to SPDX license version 3.24.0
> +
> +   -  New :ref:`create-spdx-3.0` class to generate SPDX 3.0 output, :ref:`create-spdx-image-3.0`
> +      class that is used when generating images and :ref:`create-spdx-sdk-3.0` for sdk
> +      based recipes.
s/sdk/SDK/
> +
> +   -  New :ref:`nospdx` class that allows recipes to opt out of generating SPDX.

Are you sure this works? Looking at your earlier patch, shouldn't it be 
:ref:`ref-classes-nospdx` instead?

> +
> +   -  New :ref:`Vex` class generates the minimum information that is necessary
> +      for VEX generation by an external CVE checking tool.
> +
> +   -  New :ref:`retain` class creates a tarball of the work directory for a recipe
> +      when one of its tasks fails, or any other nominated directories.
> +
> +   -  New :ref:`localpkgfeed` class in meta-selftest to create a subset of the
> +      package feed that just contain the packages depended on by this recipe.


Same comment for the above three items.

That's all here ;)
Thanks
Michael.
Antonin Godard Oct. 10, 2024, 9:12 a.m. UTC | #2 
Hi Michael,

Thanks a lot for this review and the others, I'm currently editing a v3 that
takes your remarks into account.

On 09/10/2024 16:18:13+0000, Michael Opdenacker wrote:
> See the style guide for project names:
> https://git.yoctoproject.org/yocto-docs/tree/documentation/standards.md#n79
> I know that the style is not very strictly enforced in release notes. This
> is not exactly like formal documentation.
>
> It's up to you. It's not a big deal if you don't change these. The same
> applies to the following lines...

Even if not enforced in the release note, I believe it's a good thing to take
the habit of following the standards… I will probably write more docs elsewhere,
so thanks for your reviews, they're really valuable :)

> > +   -  New :ref:`nospdx` class that allows recipes to opt out of generating SPDX.
>
> Are you sure this works? Looking at your earlier patch, shouldn't it be
> :ref:`ref-classes-nospdx` instead?
>
> > +
> > +   -  New :ref:`Vex` class generates the minimum information that is necessary
> > +      for VEX generation by an external CVE checking tool.
> > +
> > +   -  New :ref:`retain` class creates a tarball of the work directory for a recipe
> > +      when one of its tasks fails, or any other nominated directories.
> > +
> > +   -  New :ref:`localpkgfeed` class in meta-selftest to create a subset of the
> > +      package feed that just contain the packages depended on by this recipe.
>
>
> Same comment for the above three items.
> That's all here ;)

Actually, this is a bit misleading because I did in fact fix this in the next
commit - otherwise no, it wouldn't work. This should've been part of the first
one from Chee Lee Yang (amended by myself). Will do in v3.

Cheers,
Antonin

--
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
diff mbox series

Patch

diff --git a/documentation/migration-guides/release-notes-5.1.rst b/documentation/migration-guides/release-notes-5.1.rst
index 074d277da..211f92553 100644
--- a/documentation/migration-guides/release-notes-5.1.rst
+++ b/documentation/migration-guides/release-notes-5.1.rst
@@ -10,30 +10,92 @@  New Features / Enhancements in 5.1
 
 -  New variables:
 
+   - :term:`CVE_CHECK_MANIFEST_JSON_SUFFIX`: suffix for the CVE JSON manifest file.
+
+   - :term:`PRSERVER_UPSTREAM`: Upstream PR service (host:port).
+
+   - :term:`RECIPE_UPGRADE_EXTRA_TASKS`: space-delimited list of tasks to run after the new
+     sources have been unpacked in scripts/lib/devtool/upgrade.py ugrade() method.
+
+   - :term:`UNPACKDIR`: allow change of do_unpack directory.
+
 -  Architecture-specific enhancements:
 
 -  Kernel-related enhancements:
 
+  - The default kernel is the current stable (6.10), and there is also support
+    for the latest long-term release (6.6).
+
 -  New core recipes:
 
+   -  `fmt <https://fmt.dev>`__: an open-source formatting library for C++. (from meta-oe)
+
+   -  `xcb-util-errors <http://xcb.freedesktop.org/XcbUtil/>`__: gives human readable
+      names to error codes and event codes
+
 -  QEMU / ``runqemu`` enhancements:
 
--  Rust improvements:
+   - runqemu: :term:`QB_DRIVE_TYPE` now support for sd card (/dev/mmcblk)
 
--  wic Image Creator enhancements:
+-  Rust improvements:
 
 -  SDK-related improvements:
 
+   -  included ``nativesdk-python3-pip`` in buildtools.
+
 -  Testing:
 
    -  oeqa/selftest: Only rewrite envvars paths that absolutely point to builddir
 
-   -  Enable ptests for ``python3-libarchive-c``
+   -  Enable ptests for ``python3-cffi``, ``python3-idna``, ``python3-libarchive-c``,
+      ``python3-mako``, ``python3-packaging``, ``python3-uritools`` and ``python3-rpds-py``.
 
 -  Utility script changes:
 
+   -  New ``cve-json-to-text`` script that converts the cve-check result from the JSON format
+      to the TEXT format as cve-check removed text format.
+
+   -  New ``makefile-getvar`` script to extract value from a Makefile.
+
+   -  New ``pull-spdx-licenses`` script to pull SPDX license data, update license list JSON
+      data and update license directory.
+
+   -  Several improvements in ``oe-build-perf-report`` report.
+
+   -  ``oe-debuginfod`` add parameter "-d" to store debuginfod files in project sub-directory.
+
+   -  ``resulttool`` support test report generation in JUnit XML format.
+
+
 -  BitBake improvements:
 
+   -  New go module fetcher (``gomod://``) for downloading module dependencies to the
+      module cache from a module proxy.
+
+   -  New go module fetcher (``gomodgit://``) for downloading module dependencies to the
+      module cache directly from a git repository.
+
+   -  Fetcher for rust crate: added check for latest upstream version.
+
+   -  Syncrpc now requires a minimum version of the websockets module depend on python version.
+
+   -  Improved bitbake-hashclient stress statistics reporting.
+
+   -  bitbake-hashserv added ``reuseport`` parameter to enable SO_REUSEPORT, allowing
+      multiple servers to bind to the same port for load balancing
+
+   -  improved cloning speed with :term:`BB_GIT_SHALLOW` and :term:`BB_GENERATE_MIRROR_TARBALLS`.
+
+   -  bitbake UI now include log paths for failed task.
+
+   -  fetcher2 support for wget and wget2.
+
+   -  fetcher2 support npm package name with '@' character.
+
+   -  Codeparser now support shell substitution in quotes, for example::
+
+         var1="$(cmd1 ...)"
+
 -  devtool improvements:
 
    - Fix ``_test_devtool_add_git_url`` test
@@ -52,6 +114,54 @@  New Features / Enhancements in 5.1
 
    -  Fix reproducibility for ``spirv-tools``
 
+   -  Allow selection of host key types used by openssh.
+
+   -  New glibc task do_symlist to list exported symbols.
+
+   -  initramfs-framework support for force reboot in the case of fatal error.
+
+   -  insane class now check for patch-status and pep517-backend by default.
+
+   -  New ``yocto-space-optimize`` include file to allow turning off debug compiler options
+      for a small set of recipes to reduce build on disk footprint and package/sstate sizes.
+
+   -  Update to SPDX license version 3.24.0
+
+   -  New :ref:`create-spdx-3.0` class to generate SPDX 3.0 output, :ref:`create-spdx-image-3.0`
+      class that is used when generating images and :ref:`create-spdx-sdk-3.0` for sdk
+      based recipes.
+
+   -  New :ref:`nospdx` class that allows recipes to opt out of generating SPDX.
+
+   -  New :ref:`Vex` class generates the minimum information that is necessary
+      for VEX generation by an external CVE checking tool.
+
+   -  New :ref:`retain` class creates a tarball of the work directory for a recipe
+      when one of its tasks fails, or any other nominated directories.
+
+   -  New :ref:`localpkgfeed` class in meta-selftest to create a subset of the
+      package feed that just contain the packages depended on by this recipe.
+
+   -  New :term:`PACKAGECONFIG` options for individual recipes:
+
+      - appstream: qt6
+      - cronie: inotify
+      - gstreamer1.0-plugins-bad: gtk3
+      - libsdl2: libsamplerate
+      - mesa: tegra
+      - openssh: hostkey-rsa hostkey-ecdsa hostkey-ed25519
+      - pciutils: kmod zlib
+      - piglit: wayland
+      - pulseaudio: oss-output
+      - python3: staticlibpython
+      - python3-jsonschema: format-nongpl (previously "nongpl")
+      - systemd: bpf-framework
+      - util-linux: libmount-mountfd-support
+
+   -  Stop referring :term:`WORKDIR` for :term:`S` and :term:`B`: trigger
+     :ref:`ref-classes-insane` errors when :term:`S` or :term:`B` are equal to
+     :term:`WORKDIR`.
+
 Known Issues in 5.1
 ~~~~~~~~~~~~~~~~~~~
 
@@ -60,6 +170,20 @@  Recipe License changes in 5.1
 
 The following corrections have been made to the :term:`LICENSE` values set by recipes:
 
+-  ``dejagnu``: update :term:`LICENSE` to ``GPL-3.0-only``.
+-  ``gcr``: update :term:`LICENSE` to ``LGPL-2.0-only``.
+-  ``glibc``: update :term:`LICENSE` to ``GPL-2.0-only & LGPL-2.1-or-later``.
+-  ``gpgme``: update :term:`LICENSE` for different packages.
+-  ``libgcrypt``: add license ``BSD-3-Clause``.
+-  ``linux-firmware``: separate license ``Firmware-linaro`` for linaro-license package.
+-  ``iw``: update :term:`LICENSE` to ``ISC``.
+-  ``ppp``: add license ``RSA-MD`` .
+-  ``tiff``: update :term:`LICENSE` to ``libtiff``.
+-  ``unzip``: update :term:`LICENSE` to ``Info-ZIP``.
+-  ``xz``: add :term:`LICENSE` ``PD`` for xz, xz-dev and xz-doc package.
+-  ``zip``: update :term:`LICENSE` to ``Info-ZIP``.
+
+
 Security Fixes in 5.1
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -71,5 +195,181 @@  Contributors to 5.1
 
 Thanks to the following people who contributed to this release:
 
+- Adithya Balakumar
+- Adriaan Schmidt
+- Adrian Freihofer
+- Alban Bedel
+- Alejandro Hernandez Samaniego
+- Aleksandar Nikolic
+- Alessandro Pecugi
+- Alexander Kanavin
+- Alexander Sverdlin
+- Alexandre Belloni
+- Alexandre Truong
+- Alexis Lothoré
+- Andrew Fernandes
+- Andrew Oppelt
+- Andrey Zhizhikin
+- Anton Almqvist
+- Antonin Godard
+- Anuj Mittal
+- Archana Polampalli
+- Bartosz Golaszewski
+- Benjamin Bara
+- Benjamin Szőke
+- Bruce Ashfield
+- Carlos Alberto Lopez Perez
+- Changhyeok Bae
+- Changqing Li
+- Chen Qi
+- Chris Laplante
+- Chris Spencer
+- Christian Bräuner Sørensen
+- Christian Lindeberg
+- Christian Taedcke
+- Clara Kowalsky
+- Clément Péron
+- Colin McAllister
+- Corentin Lévy
+- Daniel Klauer
+- Daniel Semkowicz
+- Daniil Batalov
+- Dan McGregor
+- Deepesh Varatharajan
+- Deepthi Hemraj
+- Denys Dmytriyenko
+- Divya Chellam
+- Dmitry Baryshkov
+- Emil Kronborg
+- Enguerrand de Ribaucourt
+- Enrico Jörns
+- Esben Haabendal
+- Etienne Cordonnier
+- Fabio Estevam
+- Felix Nilsson
+- Florian Amstutz
+- Gassner, Tobias.ext
+- Gauthier HADERER
+- Guðni Már Gilbert
+- Harish Sadineni
+- Heiko Thole
+- Het Patel
+- Hongxu Jia
+- Igor Opaniuk
+- Intaek Hwang
+- Iskander Amara
+- Jaeyoon Jung
+- Jan Vermaete
+- Jasper Orschulko
+- Joe Slater
+- Johannes Schneider
+- John Ripple
+- Jonas Gorski
+- Jonas Munsin
+- Jonathan GUILLOT
+- Jon Mason
+- Jookia
+- Jordan Crouse
+- Jörg Sommer
+- Jose Quaresma
+- Joshua Watt
+- Julien Stephan
+- Kai Kang
+- Kari Sivonen
+- Khem Raj
+- Kirill Yatsenko
+- Konrad Weihmann
+- Lee Chee Yang
+- Lei Maohui
+- Leon Anavi
+- Leonard Göhrs
+- Louis Rannou
+- Marc Ferland
+- Marcus Folkesson
+- Marek Vasut
+- Mark Hatle
+- Markus Volk
+- Marlon Rodriguez Garcia
+- Marta Rybczynska
+- Martin Hundebøll
+- Martin Jansa
+- Matthew Bullock
+- Matthias Pritschet
+- Maxin B. John
+- Michael Glembotzki
+- Michael Haener
+- Michael Halstead
+- Michael Opdenacker
+- Michal Sieron
+- Mikko Rapeli
+- Mingli Yu
+- Naveen Saini
+- Niko Mauno
+- Ninette Adhikari
+- Noe Galea
+- Ola x Nilsson
+- Oleksandr Hnatiuk
+- Otavio Salvador
+- Patrick Wicki
+- Paul Barker
+- Paul Eggleton
+- Paul Gerber
+- Pedro Ferreira
+- Peter Kjellerstedt
+- Peter Marko
+- Philip Lorenz
+- Poonam Jadhav
+- Primoz Fiser
+- Quentin Schulz
+- Ralph Siemsen
+- Rasmus Villemoes
+- Ricardo Simoes
+- Richard Purdie
+- Robert Joslyn
+- Robert Kovacsics
+- Robert Yang
+- Ross Burton
+- Rudolf J Streif
+- Ryan Eatmon
+- Sabeeh Khan
+- Sakib Sajal
+- Samantha Jalabert
+- Siddharth Doshi
+- simit.ghane
+- Simone Weiß
+- Soumya Sambu
+- Sreejith Ravi
+- Stefan Mueller-Klieser
+- Sundeep KOKKONDA
+- Sven Schwermer
+- Teresa Remmet
+- Theodore A. Roth
+- Thomas Perrot
+- Tim Orling
+- Tom Hochstein
+- Trevor Gamblin
+- Troels Dalsgaard Hoffmeyer
+- Tronje Krabbe
+- Ulrich Ölmann
+- Victor Kamensky
+- Vijay Anusuri
+- Vincent Kriek
+- Vivek Puar
+- Wadim Egorov
+- Wang Mingyu
+- Weisser, Pascal.ext
+- Willy Tu
+- Xiangyu Chen
+- Yang-Mark Zhang
+- Yash Shinde
+- Yi Zhao
+- Yoann Congal
+- Yogita Urade
+- Yuri D'Elia
+- Zahir Hussain
+- Zev Weiss
+- Zoltan Boszormenyi
+
+
 Repositories / Downloads for Yocto-5.1
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~