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

[Michael Opdenacker <michael.opdenacker@rootcommit.com>]

[-- Attachment #1: Type: text/plain, Size: 5400 bytes --]


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.

-- 
Michael Opdenacker
Root Commit
https://rootcommit.com

[-- Attachment #2: Type: text/html, Size: 8197 bytes --]