Skip to contentSkip to conversation

Updates for upcoming Wrynose release

PATCH Applied Antonin Godard 2 participants 22 messages Apr 10 – May 6

lore
Share & tools
lore
#0 lore raw

cover Updates for upcoming Wrynose release

Updates to the docs with Wrynose coming soon. The last two patches update the release notes themselves. The patches before that add or remove pieces of documentation to be in sync with master.

---
Antonin Godard (18):
conf.py: define new *_path roles
ref-manual/classes.rst: document the kernel-yocto-rust class ref-manual/classes.rst: document the module-rust class ref-manual/classes.rst: document the KCONFIG_CONFIG_ROOTDIR variable ref-manual/variables.rst: document the UKI_DEVICETREE variable
docs-wide: refresh SBOM documentation after SPDX2.2 removal dev-manual/sbom.rst: add bullet point on recipe SBOM ref-manual/variables.rst: document the SPDX_PACKAGE_URLS variable ref-manual/variables.rst: document the SPDX_GIT_PURL_MAPPINGS variable ref-manual/variables.rst: document the SPDX_INCLUDE_VEX variable migration-guides/migration-6.0.rst: add note on WIC_SECTOR_SIZE
ref-manual: document the sbom-cve-check class, fragment, and variables
docs-wide: adapt to the new {DISTRO,MACHINE}_FEATURES mechanism ref-manual/features.rst: drop pcmcia from DISTRO_FEATURES ref-manual/features.rst: drop usbhost/usbgadget from DISTRO_FEATURES
docs-wide: replace meta-poky/conf/templates/default by oecore's templates
migration-guides: update 6.0 (Wrynose) release notes migration-guides/migration-6.0.rst: tidy up the file

 documentation/conf.py                              |   3 +
 .../custom-template-configuration-directory.rst    |   2 +-
 documentation/dev-manual/gobject-introspection.rst |  12 +-
 documentation/dev-manual/licenses.rst              |   4 +-
 documentation/dev-manual/poky-manual-setup.rst     |   2 +-
 documentation/dev-manual/sbom.rst                  |  43 ++--
 documentation/migration-guides/migration-6.0.rst   | 207 +++++++++++++++--
 .../migration-guides/release-notes-6.0.rst         | 256 +++++++++++++++++++--
 documentation/overview-manual/concepts.rst         |   5 +-
 documentation/ref-manual/classes.rst               |  94 +++++++-
 documentation/ref-manual/faq.rst                   |   2 +-
 documentation/ref-manual/features.rst              | 109 +++++----
 documentation/ref-manual/fragments.rst             |  20 ++
 documentation/ref-manual/structure.rst             |  18 +-
 documentation/ref-manual/variables.rst             | 232 ++++++++++---------
 15 files changed, 752 insertions(+), 257 deletions(-)

---
base-commit: 560bc33c0c2ecd60d68ba06a2edff8c25b9a3f90
change-id: 20260327-second-release-notes-6-0-ebae642800f2

#1 lore raw

PATCH 1/18 conf.py: define new *_path roles

Defines three new bitbake_path, meta_yocto_path, and oecore_path roles that can be used to quickly reference a file or directory in one of those repositories and link to our web interface for the path, e.g. :oecore_path:meta/conf/bitbake.conf.

---
 documentation/conf.py | 3 +++
 1 file changed, 3 insertions(+)
documentation/conf.py +3 -0
index e5e3a8a89..58c6406f1 100644
@@ -101,6 +101,7 @@ meta_yocto_git = f"{yocto_git_server}/meta-yocto"
 # external links and substitutions
 extlinks = {
     'bitbake_git': (f'{bitbake_git}%s', None),
+    'bitbake_path': (f'{bitbake_git}/tree/%s', '%s'),
     'bitbake_rev': (f'{bitbake_git}/commit/?id=%s', '%.7s'),
     'cve_mitre': ('https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-%s', 'CVE-%s'),
     'cve_nist': ('https://nvd.nist.gov/vuln/detail/CVE-%s', 'CVE-%s'),
@@ -112,11 +113,13 @@ extlinks = {
     'yocto_ab': ('https://autobuilder.yoctoproject.org%s', None),
     'yocto_docs': ('https://docs.yoctoproject.org%s', None),
     'yocto_git': (f'{yocto_git_server}%s', None),
+    'meta_yocto_path': (f'{meta_yocto_git}/tree/%s', '%s'),
     'meta_yocto_rev': (f'{meta_yocto_git}/commit/?id=%s', '%.7s'),
     'yocto_sstate': ('http://sstate.yoctoproject.org%s', None),
     'oe_home': ('https://www.openembedded.org%s', None),
     'oe_lists': ('https://lists.openembedded.org%s', None),
     'oe_git': (f'{oe_git_server}%s', None),
+    'oecore_path': (f'{oecore_git}/tree/%s', '%s'),
     'oecore_rev': (f'{oecore_git}/commit/?id=%s', '%.7s'),
     'oe_wiki': ('https://www.openembedded.org/wiki%s', None),
     'oe_layerindex': ('https://layers.openembedded.org%s', None),
Signature · 1 line
2.53.0
#2 lore raw

Re: [docs] [PATCH 01/18] conf.py: define new *_path roles

Hi Antonin,

Quoted 5 lines · Antonin Godard via lists.yoctoproject.org

Defines three new bitbake_path, meta_yocto_path, and oecore_path roles that can be used to quickly reference a file or directory in one of those repositories and link to our web interface for the path, e.g. :oecore_path:meta/conf/bitbake.conf.

But that will be using the master branch which is a drastically moving target. Shouldn't we rather add the bitbake/yocto version branch in there?

It seems like we can provide the branch to use in the URL with ?h=<branch>

Cheers,
Quentin

#3 lore raw

PATCH 2/18 ref-manual/classes.rst: document the kernel-yocto-rust class

In reply to Antonin Godard

Added by commit 6c90097bebef ("kernel-yocto-rust: enable Rust kernel support via 'make rustavailable'.") in OE-Core.

---
 documentation/ref-manual/classes.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
documentation/ref-manual/classes.rst +9 -0
index b23c680cb..bc46fc3f4 100644
@@ -1619,6 +1619,15 @@ The :ref:`ref-classes-kernel-uimage` class provides support to pack uImage.
 The :ref:`ref-classes-kernel-yocto` class provides common functionality for building
 from linux-yocto style kernel source repositories.
 
+.. _ref-classes-kernel-yocto-rust:
+
+``kernel-yocto-rust``
+=====================
+
+The :ref:`ref-classes-kernel-yocto-rust` class creates the necessary Rust
+Linux kernel dependencies and ensures that they are available by running ``make
+rustavailable`` from the Linux kernel source tree.
+
 .. _ref-classes-kernelsrc:
 
 ``kernelsrc``
Signature · 1 line
2.53.0
#4 lore raw

PATCH 3/18 ref-manual/classes.rst: document the module-rust class

In reply to Antonin Godard

Added by commit 76fd22f09fab ("module-rust.bbclass: Prepare out-of-tree rust module compilation") in OE-Core.

---
 documentation/ref-manual/classes.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)
documentation/ref-manual/classes.rst +13 -0
index bc46fc3f4..2fa888e15 100644
@@ -1793,6 +1793,19 @@ includes one or more kernel modules and has its own means of building the module
 inherits this class as opposed to inheriting the :ref:`ref-classes-module`
 class.
 
+.. _ref-classes-module-rust:
+
+``module-rust``
+===============
+
+The :ref:`ref-classes-module-rust` class provides support for building
+out-of-tree Linux kernel modules written in the Rust programming language. The
+class inherits the :ref:`ref-classes-module` class.
+
+For general information on out-of-tree Linux kernel modules, see the
+":ref:`kernel-dev/common:incorporating out-of-tree modules`"
+section in the Yocto Project Linux Kernel Development Manual.
+
 .. _ref-classes-multilib*:
 
 ``multilib*``
Signature · 1 line
2.53.0
#5 lore raw

PATCH 4/18 ref-manual/classes.rst: document the KCONFIG_CONFIG_ROOTDIR variable

In reply to Antonin Godard

Added by commit f86282ad2c66 ("cml1: Add the option to choose the .config root dir") in OE-core.

---
 documentation/ref-manual/classes.rst   | 4 ++++
 documentation/ref-manual/variables.rst | 5 +++++
 2 files changed, 9 insertions(+)
documentation/ref-manual/classes.rst +4 -0
index 2fa888e15..acdbe9935 100644
@@ -476,6 +476,10 @@ build configuration system. "cml" stands for "Configuration Menu Language", whic
 originates from the Linux kernel but is also used in other projects such as U-Boot
 and BusyBox. It could have been called "kconfig" too.
 
+The CML configuration file location (``.config``) is by default expected to be
+in the build directory (:term:`B`). This can be overridden with the
+:term:`KCONFIG_CONFIG_ROOTDIR` variable.
+
 .. _ref-classes-compress_doc:
 
 ``compress_doc``
documentation/ref-manual/variables.rst +5 -0
index 60e608c0c..20e4893d6 100644
@@ -5337,6 +5337,11 @@ system and gives an overview of their function and contents.
       :yocto_git:`symbol_why.py </yocto-kernel-tools/tree/tools/symbol_why.py>`
       script in :yocto_git:`yocto-kernel-tools </yocto-kernel-tools>`.
 
+   :term:`KCONFIG_CONFIG_ROOTDIR`
+      The :term:`KCONFIG_CONFIG_ROOTDIR` variable allows overriding the default
+      location of the ``.config`` file for recipes using the
+      :ref:`ref-classes-cml1` class.
+
    :term:`KCONFIG_MODE`
       When used with the :ref:`ref-classes-kernel-yocto`
       class, specifies the kernel configuration values to use for options
Signature · 1 line
2.53.0
#6 lore raw

PATCH 5/18 ref-manual/variables.rst: document the UKI_DEVICETREE variable

In reply to Antonin Godard

Added by commit 56aeb7ff4e23 ("uki.bbclass: make DTB packaging optional") in OE-Core.

---
 documentation/ref-manual/classes.rst   | 1 +
 documentation/ref-manual/variables.rst | 5 +++++
 2 files changed, 6 insertions(+)
documentation/ref-manual/classes.rst +1 -0
index acdbe9935..38b16c0f9 100644
@@ -3559,6 +3559,7 @@ The variables used by this class are:
 -  :term:`UKI_SB_CERT`: optional UEFI secureboot certificate matching the
    private key
 -  :term:`UKI_SB_KEY`: optional UEFI secureboot private key to sign UKI with
+-  :term:`UKI_DEVICETREE`: list of device tree blobs to include to the UKI
 
 For examples on how to use this class see oeqa selftest
 :oe_git:`meta/lib/oeqa/selftest/cases/uki.py
documentation/ref-manual/variables.rst +5 -0
index 20e4893d6..7606d7a42 100644
@@ -11899,6 +11899,11 @@ system and gives an overview of their function and contents.
       <https://www.freedesktop.org/software/systemd/man/latest/ukify.html>`__
       command.
 
+   :term:`UKI_DEVICETREE`
+      When inheriting the :ref:`ref-classes-uki` class, the :term:`UKI_DEVICETREE`
+      variable holds the list of device tree blobs to include to the `Unified
+      Kernel Image (UKI) <https://uapi-group.org/specifications/specs/unified_kernel_image/>`__.
+
    :term:`UKI_FILENAME`
       When inheriting the :ref:`ref-classes-uki` class, the output file name
       for the generated `Unified Kernel Image (UKI)
Signature · 1 line
2.53.0
#7 lore raw

PATCH 6/18 docs-wide: refresh SBOM documentation after SPDX2.2 removal

In reply to Antonin Godard

SPDX2.2 was removed in [1]. Refresh the documentation surrounding SDPX SBOMs to removed obsolete variables and output files.

[1]: https://git.openembedded.org/openembedded-core/commit/?id=12abd0574c267bade0962ecb39d9e8da8c56842b

---
 documentation/dev-manual/sbom.rst      | 38 +++++---------------------
 documentation/ref-manual/classes.rst   |  4 +--
 documentation/ref-manual/variables.rst | 50 ----------------------------------
 3 files changed, 9 insertions(+), 83 deletions(-)
documentation/dev-manual/sbom.rst +7 -31
index e0c3ed6d1..819340a74 100644
@@ -31,25 +31,15 @@ If needed, it can be disabled from a :term:`configuration file`::
 
    INHERIT_DISTRO:remove = "create-spdx"
 
-Upon building an image, you will then get:
-
--  :term:`SPDX` output in JSON format as an ``IMAGE-MACHINE.spdx.json`` file in
-   ``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`.
-
--  This toplevel file is accompanied by an ``IMAGE-MACHINE.spdx.index.json``
-   containing an index of JSON :term:`SPDX` files for individual recipes.
-
--  The compressed archive ``IMAGE-MACHINE.spdx.tar.zst`` contains the index
-   and the files for the single recipes.
+Upon building an image, you will then get the :term:`SPDX` output in JSON format
+as an ``IMAGE-MACHINE.spdx.json`` file in ``tmp/deploy/images/MACHINE/`` inside
+the :term:`Build Directory`.
 
 The :ref:`ref-classes-create-spdx` class offers options to include
 more information in the output :term:`SPDX` data:
 
 -  Make the json files more human readable by setting (:term:`SPDX_PRETTY`).
 
--  Add compressed archives of the files in the generated target packages by
-   setting (:term:`SPDX_ARCHIVE_PACKAGED`).
-
 -  Add a description of the source files used to generate host tools and target
    packages (:term:`SPDX_INCLUDE_SOURCES`)
 
@@ -62,8 +52,6 @@ more information in the output :term:`SPDX` data:
 -  Export the recipe's ``PACKAGECONFIG`` features (enabled/disabled) into the
    SPDX document (:term:`SPDX_INCLUDE_PACKAGECONFIG`).
 
--  Add archives of these source files themselves (:term:`SPDX_ARCHIVE_SOURCES`).
-
 -  Exclude specific files from the SPDX output using Python regular expressions
    (:term:`SPDX_FILE_EXCLUDE_PATTERNS`).
 
@@ -82,28 +70,16 @@ more information in the output :term:`SPDX` data:
    (:term:`SPDX_INCLUDE_BITBAKE_PARENT_BUILD`, :term:`SPDX_INVOKED_BY`,
    :term:`SPDX_ON_BEHALF_OF`).
 
-Though the toplevel :term:`SPDX` output is available in
-``tmp/deploy/images/MACHINE/`` inside the :term:`Build Directory`, ancillary
-generated files are available in ``tmp/deploy/spdx/MACHINE`` too, such as:
-
--  The individual :term:`SPDX` JSON files in the ``IMAGE-MACHINE.spdx.tar.zst``
-   archive.
-
--  Compressed archives of the files in the generated target packages,
-   in ``packages/packagename.tar.zst`` (when :term:`SPDX_ARCHIVE_PACKAGED`
-   is set).
-
--  Compressed archives of the source files used to build the host tools
-   and the target packages in ``recipes/recipe-packagename.tar.zst``
-   (when :term:`SPDX_ARCHIVE_SOURCES` is set). Those are needed to fulfill
-   "source code access" license requirements.
-
 See also the :term:`SPDX_CUSTOM_ANNOTATION_VARS` variable which allows
 to associate custom notes to a recipe.
 See the `tools page <https://spdx.dev/resources/tools/>`__ on the :term:`SPDX`
 project website for a list of tools to consume and transform the :term:`SPDX`
 data generated by the OpenEmbedded build system.
 
+See the definition of the variables starting with ``SPDX_`` in the
+:doc:`Yocto Project Reference Manual glossary </ref-manual/variables>` for more
+information.
+
 See also Joshua Watt's presentations
 `Automated SBoM generation with OpenEmbedded and the Yocto Project <https://youtu.be/Q5UQUM6zxVU>`__
 at FOSDEM 2023 and
documentation/ref-manual/classes.rst +2 -2
index 38b16c0f9..d29339491 100644
@@ -559,8 +559,8 @@ The toplevel :term:`SPDX` output file is generated in JSON format as a
 as well as in ``tmp/deploy/spdx``.
 
 The exact behaviour of this class, and the amount of output can be controlled
-by the :term:`SPDX_PRETTY`, :term:`SPDX_ARCHIVE_PACKAGED`,
-:term:`SPDX_ARCHIVE_SOURCES` and :term:`SPDX_INCLUDE_SOURCES` variables.
+by the :term:`SPDX_PRETTY`, :term:`SPDX_INCLUDE_SOURCES` and other variables
+starting with with ``SPDX_``.
 
 See the description of these variables and the
 ":ref:`dev-manual/sbom:creating a software bill of materials`"
documentation/ref-manual/variables.rst +0 -50

56 lines not on this page · raw message

Signature · 1 line
2.53.0
#8 lore raw

PATCH 7/18 dev-manual/sbom.rst: add bullet point on recipe SBOM

In reply to Antonin Godard

Added by commit d999ac407c86 ("spdx3: Add recipe SPDX data") in OE-Core.

---
 documentation/dev-manual/sbom.rst | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)
documentation/dev-manual/sbom.rst +14 -3
index 819340a74..45b63ed8e 100644
@@ -31,9 +31,20 @@ If needed, it can be disabled from a :term:`configuration file`::
 
    INHERIT_DISTRO:remove = "create-spdx"
 
-Upon building an image, you will then get the :term:`SPDX` output in JSON format
-as an ``IMAGE-MACHINE.spdx.json`` file in ``tmp/deploy/images/MACHINE/`` inside
-the :term:`Build Directory`.
+There are two ways to generate SBOM metadata:
+
+-  By building an image, you will then get the :term:`SPDX` output in JSON format
+   as an ``IMAGE-MACHINE.spdx.json`` file in ``tmp/deploy/images/MACHINE/`` inside
+   the :term:`Build Directory`.
+
+-  By generating the SBOM document using the recipe metadata only:
+
+   .. code-block:: console
+
+      $ bitbake <recipe> -c create_recipe_sbom
+
+   Note that recipe SBOM is also included in the image SBOM document (for the
+   recipes involved in the build of the image only).
 
 The :ref:`ref-classes-create-spdx` class offers options to include
 more information in the output :term:`SPDX` data:
Signature · 1 line
2.53.0
#9 lore raw

PATCH 8/18 ref-manual/variables.rst: document the SPDX_PACKAGE_URLS variable

In reply to Antonin Godard

Added by commit 874b2d301d3c ("spdx: Add yocto PURLs") in OE-Core.

---
 documentation/ref-manual/variables.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
documentation/ref-manual/variables.rst +9 -0
index bb39ceaaf..6c3f62d9f 100644
@@ -9659,6 +9659,15 @@ system and gives an overview of their function and contents.
       specification) for a software Package. The default value of this variable
       is an empty string.
 
+   :term:`SPDX_PACKAGE_URLS`
+      A space separated list of Package URLs ("PURLs") for the software package.
+      The first item in this list will be listed as the ``packageUrl`` property
+      of the packages, and all PURLs (including the first one) will be listed as
+      external references. The default value is an auto generated ``pkg:yocto``
+      PURL based on the recipe name, version, and layer name. Override this
+      variable to replace the default, otherwise append or prepend to add
+      additional PURLs.
+
    :term:`SPDX_PACKAGE_VERSION`
       This variable controls the package version as seen in the SPDX 3.0 JSON
       output (``software_packageVersion``). The default value for this variable
Signature · 1 line
2.53.0
#10 lore raw

PATCH 9/18 ref-manual/variables.rst: document the SPDX_GIT_PURL_MAPPINGS variable

In reply to Antonin Godard

Added by commit 9f1825e74d0f ("spdx30: Add Git version and PURL to source downloads") in OE-Core.

---
 documentation/ref-manual/variables.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)
documentation/ref-manual/variables.rst +11 -0
index 6c3f62d9f..653bdb1b4 100644
@@ -9396,6 +9396,17 @@ system and gives an overview of their function and contents.
 
       See also :term:`SPDX_INCLUDE_SOURCES`.
 
+   :term:`SPDX_GIT_PURL_MAPPINGS`
+      A space separated list of ``domain:purl_type`` mappings to configure PURL
+      (Package URLs) generation for Git source downloads.
+
+      For example, adding ``gitlab.example.com:pkg:gitlab`` to this variable
+      will map repositories hosted on "gitlab.example.com" to the ``pkg:gitlab``
+      PURL type.
+
+      See also the :term:`SPDX_PACKAGE_URLS` variable for more information on
+      PURLs.
+
    :term:`SPDX_IMAGE_SUPPLIER`
       The name of an agent variable prefix describing the organization or
       person who supplies the image SBOM. When set, the supplier is attached
Signature · 1 line
2.53.0
#11 lore raw

PATCH 10/18 ref-manual/variables.rst: document the SPDX_INCLUDE_VEX variable

In reply to Antonin Godard

Added by commit b63f6f50458f ("classes/create-spdx-3.0: Add classes") in OE-Core.

---
 documentation/ref-manual/variables.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
documentation/ref-manual/variables.rst +14 -0
index 653bdb1b4..89a5e632b 100644
@@ -9563,6 +9563,20 @@ system and gives an overview of their function and contents.
       increases the SBOM size (potentially by several gigabytes for typical
       images).
 
+   :term:`SPDX_INCLUDE_VEX`
+      This option controls what `VEX <https://cyclonedx.org/capabilities/vex/>`__
+      information will be present in the output SPDX documents.
+
+      It can take three different values:
+
+      -  ``none``: disable all VEX data.
+
+      -  ``current`` (default): include VEX data for vulnerabilities not already
+         fixed in the upstream source code.
+
+      -  ``all``: get all known historical vulnerabilities, including those
+         already fixed upstream (warning: this can be large and slow).
+
    :term:`SPDX_INVOKED_BY`
       The base variable name describing the agent that invoked the build.
       Each ``Build`` object in the SPDX output is linked to this agent with an
Signature · 1 line
2.53.0
#12 lore raw

PATCH 11/18 migration-guides/migration-6.0.rst: add note on WIC_SECTOR_SIZE

In reply to Antonin Godard

After b50d6debf7ba ("wic: re-implement sector-size support") in OE-Core, add a note on the WIC_SECTOR_SIZE variable.

---
 documentation/migration-guides/migration-6.0.rst | 30 ++++++++++++++++++++++++
 documentation/ref-manual/variables.rst           |  7 ++++++
 2 files changed, 37 insertions(+)
documentation/migration-guides/migration-6.0.rst +30 -0
index 15dbd08a0..16046dad8 100644
@@ -189,6 +189,36 @@ class, meaning recipes using these variables that not yet inheriting the
 
 See commit :oecore_rev:`68d2d38483efada7bc2409e10508b03a7431caff` for more information.
 
+
+.. _ref-migration-6-0-wic-sector-size-change:
+
+:term:`WIC_SECTOR_SIZE` should be replaced by ``--sector-size``
+---------------------------------------------------------------
+
+The :term:`WIC_SECTOR_SIZE` variable was previously used to define the sector
+size of the partitions generated by the :doc:`WIC </dev-manual/wic>` tool. The
+``wic`` command-line tool now supports a ``--sector-size`` argument that
+replaces this variable.
+
+While this variable can still be used in recipes, a warning is now printed on
+the console when used::
+
+   DEPRECATED: WIC_SECTOR_SIZE is deprecated, use the --sector-size command-line argument instead.
+
+Using the ``--sector-size`` command-line argument can be done through the
+:term:`WIC_CREATE_EXTRA_ARGS` variable.
+
+For example, a previous assignment to :term:`WIC_SECTOR_SIZE`::
+
+   WIC_SECTOR_SIZE = "4096"
+
+Should be replaced by::
+
+   WIC_CREATE_EXTRA_ARGS += "--sector-size 4096"
+
+See commit :oecore_rev:`b50d6debf7baa555fbfb3521c4f952675bba2d37` for more
+information.
+
 Rust language changes
 ---------------------
 
documentation/ref-manual/variables.rst +7 -0
index 89a5e632b..b698e865f 100644
@@ -12261,6 +12261,13 @@ system and gives an overview of their function and contents.
       Wic creation process.
 
    :term:`WIC_SECTOR_SIZE`
+
+      .. warning::
+
+         This variable is deprecated in favor of the ``--sector-size`` wic
+         command-line argument. See :ref:`ref-migration-6-0-wic-sector-size-change`
+         for more information.
+
       The variable :term:`WIC_SECTOR_SIZE` controls the sector size of Wic
       images. In the background, this controls the value of the
       ``PARTED_SECTOR_SIZE`` environment variable passed to the ``parted``
Signature · 1 line
2.53.0
#13 lore raw

PATCH 12/18 ref-manual: document the sbom-cve-check class, fragment, and variables

In reply to Antonin Godard

Added by commit 8ef22ad9e302 ("sbom-cve-check: Add class for post-build CVE analysis") in OE-Core.

---
 documentation/ref-manual/classes.rst   | 55 ++++++++++++++++++++++++++++++++++
 documentation/ref-manual/fragments.rst | 20 +++++++++++++
 documentation/ref-manual/variables.rst | 38 +++++++++++++++++++++++
 3 files changed, 113 insertions(+)
documentation/ref-manual/classes.rst +55 -0
index d29339491..5a119da71 100644
@@ -2760,6 +2760,61 @@ configuration checks from the ``local.conf`` configuration file to
 prevent common mistakes that cause build failures. Distribution policy
 usually determines whether to include this class.
 
+.. _ref-classes-sbom-cve-check:
+
+``sbom-cve-check``
+==================
+
+The :ref:`ref-classes-sbom-cve-check` class uses the `sbom-cve-check
+<github.com/bootlin/sbom-cve-check>`__ command-line tool for post-build CVE
+analysis. It relies on the :ref:`ref-classes-create-spdx` class as SPDX files
+are the input of this tool.
+
+This class should be enabled through the :ref:`ref-fragments-core-yocto-sbom-cve-check`
+fragment:
+
+.. code-block:: console
+
+   $ bitbake-config-build enable-fragment core/yocto/sbom-cve-check
+
+After building an image, ``sbom-cve-check`` will generate one or more reports in
+the :term:`DEPLOY_DIR_IMAGE` directory depending on the current value of
+:term:`SBOM_CVE_CHECK_EXPORT_VARS`.
+
+See the variables starting with ``SBOM_CVE_CHECK_`` in the :doc:`Yocto Project
+Reference Manual glossary </ref-manual/variables>` to learn more on how to
+configure the behavior of this class.
+
+.. _ref-classes-sbom-cve-check-recipe:
+
+``sbom-cve-check-recipe``
+=========================
+
+The :ref:`ref-classes-sbom-cve-check-recipe` class uses the `sbom-cve-check
+<github.com/bootlin/sbom-cve-check>`__ command-line tool for post-build CVE
+analysis of a recipe. It relies on the :ref:`ref-classes-create-spdx` class as
+SPDX files are the input of this tool.
+
+This class can be inherited in any recipe. Compared to the
+:class:`ref-classes-sbom-cve-check` class, this class only uses the SBOM of the
+recipe (after the ``create_recipe_sbom`` is run) to determine which is the
+underlying software and do the analysis, meaning that building the recipe itself
+isn't necessary.
+
+To use this class, inherit it in the recipe and run:
+
+.. code-block:: console
+
+   $ bitbake <recipe> -c sbom_cve_check_recipe
+
+After running the command, ``sbom-cve-check`` will generate one or more reports
+in the :term:`DEPLOY_DIR_IMAGE` directory depending on the current value of
+:term:`SBOM_CVE_CHECK_EXPORT_VARS`.
+
+See the variables starting with ``SBOM_CVE_CHECK_`` in the :doc:`Yocto Project
+Reference Manual glossary </ref-manual/variables>` to learn more on how to
+configure the behavior of this class.
+
 .. _ref-classes-scons:
 
 ``scons``
documentation/ref-manual/fragments.rst +20 -0
index 9449f4648..8da14a038 100644
@@ -204,6 +204,26 @@ The ``core/yocto/root-login-with-empty-password`` :term:`configuration fragment`
 can be used to allow to login as the ``root`` user to login without a password
 on the serial console and over SSH.
 
+.. _ref-fragments-core-yocto-sbom-cve-check:
+
+``core/yocto/sbom-cve-check``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The ``core/yocto/sbom-cve-check`` :term:`configuration fragment` can be used
+to set up the build to use the :ref:`ref-classes-sbom-cve-check` class .
+
+This configuration fragment does multiple things:
+
+-  Add the :ref:`ref-classes-create-spdx` class to the list of globally
+   inherited classes, as it depends on it.
+
+-  Sets the source revision (:term:`SRCREV`) of the input CVE databases to
+   :term:`AUTOREV`, so these databases are automatically fetched and updated
+   when starting a build.
+
+-  Include the VEX statements to the input SPDX document using the
+   :term:`SPDX_INCLUDE_VEX` variable.
+
 Yocto Project Autobuilder Fragments
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
documentation/ref-manual/variables.rst +38 -0
index b698e865f..d8cadef3e 100644
@@ -8742,6 +8742,44 @@ system and gives an overview of their function and contents.
       list, then the build system reports a warning that indicates the
       current host distribution has not been tested as a build host.
 
+   :term:`SBOM_CVE_CHECK_EXPORT_VARS`
+      When inheriting the :ref:`ref-classes-sbom-cve-check` class, this variable
+      holds the list of variables that declare export files to generate.
+
+      Each variable must have a ``type`` and an ``ext`` flag set:
+
+      -  The ``type`` flag contains the value that is passed to the
+         ``--export-type`` command line argument of ``sbom-cve-check``.
+
+      -  The ``ext`` flag contains the filename extension (suffix). The output
+         filename is going will be ``${IMAGE_NAME}${ext}``.
+
+      For example::
+
+         SBOM_CVE_CHECK_EXPORT_VARS = "SBOM_CVE_CHECK_EXPORT_SPDX3"
+         SBOM_CVE_CHECK_EXPORT_SPDX3[type] = "spdx3"
+         SBOM_CVE_CHECK_EXPORT_SPDX3[ext] = ".sbom-cve-check.spdx.json"
+
+   :term:`SBOM_CVE_CHECK_EXTRA_ARGS`
+      When inheriting the :ref:`ref-classes-sbom-cve-check` class, this variable
+      can be used to pass extra arguments to the ``sbom-cve-check`` command-line
+      tool.
+
+      See the `documentation <https://sbom-cve-check.readthedocs.io/en/latest/index.html>`__
+      of ``sbom-cve-check`` for more information.
+
+   :term:`SBOM_CVE_CHECK_SCAN_SCOPE`
+      When inheriting the :ref:`ref-classes-sbom-cve-check` class, this
+      variable controls whether to scan target and native, just target, or just
+      native recipes.
+
+      Valid values are:
+
+      -  ``target`` (default): recipes are scanned in their target context
+      -  ``native``: recipes are scanned in their :ref:`ref-classes-native` context
+      -  ``both``: recipes are scanned in both their target and
+         :ref:`ref-classes-native` context
+
    :term:`SDK_ARCH`
       The target architecture for the SDK. Typically, you do not directly
       set this variable. Instead, use :term:`SDKMACHINE`.
Signature · 1 line
2.53.0
#14 lore raw

PATCH 13/18 docs-wide: adapt to the new {DISTRO,MACHINE}_FEATURES mechanism

In reply to Antonin Godard

The way DISTRO_FEATURES and MACHINE_FEATURES defaults are provided and the way you can opt out of it has changed in OE-Core. Adapt the documentation to these changes, which includes remove some previous definitions (all the *BACKFILL* variables) and documenting the new variables.

Note that DISTRO_FEATURES_DEFAULT was also removed. There is a new DISTRO_FEATURES_DEFAULTS variable and MACHINE_FEATURES_DEFAULTS, however.

---
 documentation/dev-manual/gobject-introspection.rst |  12 +--
 documentation/migration-guides/migration-6.0.rst   |  51 +++++++++++
 documentation/ref-manual/classes.rst               |   8 +-
 documentation/ref-manual/features.rst              | 101 +++++++++++----------
 documentation/ref-manual/variables.rst             |  91 +++++++------------
 5 files changed, 150 insertions(+), 113 deletions(-)
documentation/dev-manual/gobject-introspection.rst +6 -6
index f7206e6fa..8203f17f0 100644
@@ -44,9 +44,9 @@ library package involves the following:
 #. Make sure introspection is not disabled anywhere in the recipe or
    from anything the recipe includes. Also, make sure that
    "gobject-introspection-data" is not in
-   :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
+   :term:`DISTRO_FEATURES_OPTED_OUT`
    and that "qemu-usermode" is not in
-   :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`.
+   :term:`MACHINE_FEATURES_OPTED_OUT`.
    In either of these conditions, nothing will happen.
 
 #. Try to build the recipe. If you encounter build errors that look like
@@ -84,7 +84,7 @@ disable GIR file generations:
 
 -  Add the following to your distro configuration::
 
-      DISTRO_FEATURES_BACKFILL_CONSIDERED = "gobject-introspection-data"
+      DISTRO_FEATURES_OPTED_OUT = "gobject-introspection-data"
 
    Adding this statement disables generating introspection data using
    QEMU but will still enable building introspection tools and libraries
@@ -92,7 +92,7 @@ disable GIR file generations:
 
 -  Add the following to your machine configuration::
 
-      MACHINE_FEATURES_BACKFILL_CONSIDERED = "qemu-usermode"
+      MACHINE_FEATURES_OPTED_OUT = "qemu-usermode"
 
    Adding this statement disables the use of QEMU when building packages for your
    machine. Currently, this feature is used only by introspection
@@ -115,9 +115,9 @@ Use the following procedure to test if generating introspection data is
 working in an image:
 
 #. Make sure that "gobject-introspection-data" is not in
-   :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
+   :term:`DISTRO_FEATURES_OPTED_OUT`
    and that "qemu-usermode" is not in
-   :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`.
+   :term:`MACHINE_FEATURES_OPTED_OUT`.
 
 #. Build ``core-image-sato``.
 
documentation/migration-guides/migration-6.0.rst +51 -0

57 lines not on this page · raw message

documentation/ref-manual/classes.rst +4 -4
index 5a119da71..d66c9c68b 100644
@@ -1071,10 +1071,10 @@ introspection. This functionality is only enabled if the
 
 .. note::
 
-   This functionality is :ref:`backfilled <ref-features-backfill>` by default
-   and, if not applicable, should be disabled through
-   :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` or
-   :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`, respectively.
+   This functionality is :ref:`enabled <ref-manual/features:Default Features>`
+   by default and, if not applicable, should be disabled through
+   :term:`DISTRO_FEATURES_OPTED_OUT` or
+   :term:`MACHINE_FEATURES_OPTED_OUT`, respectively.
 
 .. _ref-classes-grub-efi:
 
documentation/ref-manual/features.rst +54 -47

116 lines not on this page · raw message

documentation/ref-manual/variables.rst +35 -56

110 lines not on this page · raw message

Signature · 1 line
2.53.0
#15 lore raw

PATCH 14/18 ref-manual/features.rst: drop pcmcia from DISTRO_FEATURES

In reply to Antonin Godard

After commit ec0a7650a4fd ("conf/packagegroups: Drop pcmcia from DISTRO_FEATURES to MACHINE_FEATURES") in OE-Core.

---
 documentation/ref-manual/features.rst | 2 --
 1 file changed, 2 deletions(-)
documentation/ref-manual/features.rst +0 -2
index 5fda7ac9a..9173b9553 100644
@@ -200,8 +200,6 @@ metadata, as extra layers can define their own:
 
 -  *pci:* Include PCI bus support.
 
--  *pcmcia:* Include PCMCIA/CompactFlash support.
-
 -  *pni-names:* Enable generation of persistent network interface names, i.e.
    the system tries hard to have the same but unique names for the network
    interfaces even after a reinstall.
Signature · 1 line
2.53.0
#16 lore raw

PATCH 15/18 ref-manual/features.rst: drop usbhost/usbgadget from DISTRO_FEATURES

In reply to Antonin Godard

After commit a791ca692d08 ("conf/packagegroups: Drop usbhost/usbgadget from DISTRO_FEATURES to MACHINE_FEATURES") in OE-Core.

---
 documentation/ref-manual/features.rst | 6 ------
 1 file changed, 6 deletions(-)
documentation/ref-manual/features.rst +0 -6
index 9173b9553..77d034f0c 100644
@@ -237,12 +237,6 @@ metadata, as extra layers can define their own:
    main DNS name resolver in ``glibc`` Name Service Switch. This is a DNS
    resolver daemon from ``systemd``.
 
--  *usbgadget:* Include USB Gadget Device support (for USB
-   networking/serial/storage).
-
--  *usbhost:* Include USB Host support (allows to connect external
-   keyboard, mouse, storage, network etc).
-
 -  *usrmerge:* Merges the ``/bin``, ``/sbin``, ``/lib``, and ``/lib64``
    directories into their respective counterparts in the ``/usr``
    directory to provide better package and application compatibility.
Signature · 1 line
2.53.0
#17 lore raw

PATCH 16/18 docs-wide: replace meta-poky/conf/templates/default by oecore's templates

In reply to Antonin Godard

The meta-poky's templates have been removed with [1]. They're intented to be replaced with the ones from OpenEmbedded-Core.

Replace the occurences of these paths and replace accordingly.

[1]: https://git.yoctoproject.org/meta-yocto/commit/meta-poky/conf?id=ac300baea7314ea3c80f2330b2a993f729f32150

---
 .../custom-template-configuration-directory.rst        |  2 +-
 documentation/dev-manual/licenses.rst                  |  4 ++--
 documentation/dev-manual/poky-manual-setup.rst         |  2 +-
 documentation/overview-manual/concepts.rst             |  5 ++---
 documentation/ref-manual/faq.rst                       |  2 +-
 documentation/ref-manual/structure.rst                 | 18 ++++++------------
 documentation/ref-manual/variables.rst                 |  2 +-
 7 files changed, 14 insertions(+), 21 deletions(-)
documentation/dev-manual/custom-template-configuration-directory.rst +1 -1
index 8bf763569..597772f7f 100644
@@ -39,7 +39,7 @@ from ``.templateconf`` file that is read from the same directory as
 ``oe-init-build-env`` script. For the Poky reference distribution this
 would be::
 
-   TEMPLATECONF=${TEMPLATECONF:-meta-poky/conf/templates/default}
+   TEMPLATECONF=${TEMPLATECONF:-meta/conf/templates/default}
 
 If you look at a configuration template directory, you will
 see the ``bblayers.conf.sample``, ``local.conf.sample``, ``conf-summary.txt`` and
documentation/dev-manual/licenses.rst +2 -2
index 4bc1f7376..774b5db23 100644
@@ -469,8 +469,8 @@ of the Yocto Project and layers used during your build. Archiving a Git
 repository can be done with the :manpage:`git-archive <git-archive(1)>` command.
 
 One thing a development organization might want to consider for end-user
-convenience is to modify
-``meta-poky/conf/templates/default/bblayers.conf.sample`` to ensure that when
+convenience is to provide its own version of the
+:oecore_path:`meta/conf/templates/default/bblayers.conf.sample` file to ensure that when
 the end user utilizes the released build system to build an image, the
 development organization's layers are included in the ``bblayers.conf`` file
 automatically::
documentation/dev-manual/poky-manual-setup.rst +1 -1
index 2b1c3f63d..cade9e2b1 100644
@@ -94,7 +94,7 @@ an entire Linux distribution, including the toolchain, from source.
 
     .. code-block:: shell
 
-       $ TEMPLATECONF=$PWD/layers/meta-yocto/meta-poky/conf/templates/default source ./layers/openembedded-core/oe-init-build-env
+       $ source ./layers/openembedded-core/oe-init-build-env
 
     Among other things, the script creates the :term:`Build Directory`, which is
     ``build`` in this case and is located in the :term:`Source Directory`.
documentation/overview-manual/concepts.rst +2 -3
index ab723d7c3..1faa790f3 100644
@@ -228,9 +228,8 @@ Directory` at the time you source the build environment setup script.
 :term:`Configuration files <Configuration File>` provide many basic variables
 that define a build environment. To show a list of possible variables to
 configure from :term:`configuration files <Configuration File>`, see the
-:yocto_git:`local.conf.sample
-</meta-yocto/tree/meta-poky/conf/templates/default/local.conf.sample>` in the
-``meta-poky`` layer:
+:oecore_path:`local.conf.sample <meta/conf/templates/default/local.conf.sample>`
+file in :term:`OpenEmbedded-Core (OE-Core)`:
 
 Here is a non-exhaustive list:
 
documentation/ref-manual/faq.rst +1 -1
index 248cf3d2d..adb5659b7 100644
@@ -196,7 +196,7 @@ and ``all_proxy`` set as to standard shell environment variables to redirect
 requests through proxy servers.
 
 The Yocto Project also includes a
-``meta-poky/conf/templates/default/site.conf.sample`` file that shows
+:oecore_path:`meta/conf/templates/default/site.conf.sample` file that shows
 how to configure a Git proxy server if needed.
 
 .. note::
documentation/ref-manual/structure.rst +6 -12
index 06cd2b770..ff84b250b 100644
@@ -315,10 +315,10 @@ The :term:`OpenEmbedded Build System` can create the ``local.conf`` file from a
 setup script :ref:`structure-core-script`.
 
 The source ``local.conf.sample`` file used depends on the
-:term:`TEMPLATECONF` script variable, which defaults to ``layers/meta-yocto/meta-poky/conf/templates/default``
-when you are building from the Yocto Project development environment,
-and to ``layers/openembedded-core/meta/conf/templates/default`` when you are building from the OpenEmbedded-Core
-environment. Because the script variable points to the source of the
+:term:`TEMPLATECONF` script variable, which defaults to
+:oecore_path:`meta/conf/templates/default` in :term:`OpenEmbedded-Core
+(OE-Core)`.
+Because the script variable points to the source of the
 ``local.conf.sample`` file, this implies that you can configure your
 build environment from any layer by setting the variable in the
 top-level build environment setup script as follows::
@@ -334,8 +334,6 @@ file, it uses ``sed`` to substitute final
 
    You can see how the :term:`TEMPLATECONF` variable is used by looking at the
    ``layers/openembedded-core/scripts/oe-setup-builddir`` script in :term:`OpenEmbedded-Core (OE-Core)`.
-   You can find the :term:`Poky` version of the ``local.conf.sample`` file in
-   the ``layers/meta-yocto/meta-poky/conf/templates/default`` directory.
 
 .. _structure-build-conf-bblayers.conf:
 
@@ -354,9 +352,7 @@ when you ``source`` the top-level build environment setup script (i.e.
 
 As with the :ref:`structure-build-conf-local.conf` file, the source ``bblayers.conf.sample``
 file used depends on the :term:`TEMPLATECONF` script variable, which
-defaults to ``meta-poky/conf/templates/default`` when you are building using the
-:term:`Poky` reference distro, and to ``meta/conf/templates/default`` when you are
-building from the OpenEmbedded-Core environment (default). Because the script
+defaults to :oecore_path:`meta/conf/templates/default` . Because the script
 variable points to the source of the ``bblayers.conf.sample`` file, this
 implies that you can base your build from any layer by setting the
 variable in the top-level build environment setup script as follows::
@@ -369,9 +365,7 @@ Once the build process gets the sample file, it uses ``sed`` to substitute final
 .. note::
 
    You can see how the :term:`TEMPLATECONF` variable is defined by the ``scripts/oe-setup-builddir``
-   script in :term:`OpenEmbedded-Core (OE-Core)`. You can find the :term:`Poky`
-   version of the ``bblayers.conf.sample`` file in the ``layers/meta-yocto/meta-poky/conf/templates/default``
-   directory.
+   script in :term:`OpenEmbedded-Core (OE-Core)`.
 
 .. _structure-build-conf-site.conf:
 
documentation/ref-manual/variables.rst +1 -1
index 9ce2803b3..606466313 100644
@@ -5050,7 +5050,7 @@ system and gives an overview of their function and contents.
          configuration file. You cannot set the variable in a recipe file.
 
       See the
-      :yocto_git:`local.conf.sample.extended </meta-yocto/tree/meta-poky/conf/templates/default/local.conf.sample.extended>`
+      :oecore_path:`local.conf.sample.extended <meta/conf/templates/default/local.conf.sample.extended>`
       file for additional information. Also, for information on creating an
       :term:`Initramfs`, see the ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section
       in the Yocto Project Development Tasks Manual.
Signature · 1 line
2.53.0
#18 lore raw

PATCH 17/18 migration-guides: update 6.0 (Wrynose) release notes

In reply to Antonin Godard

Update documentation/migration-guides/migration-6.0.rst and documentation/migration-guides/release-notes-6.0.rst to include important changes between:

- bitbake: a3ad577439d11 and 5d722b5d65e
- openembedded-core: be8cdcf13a65 and 853baa702e3
- meta-yocto: 0a4ce9dd7fdd and 49cbb01d5252

---
 documentation/migration-guides/migration-6.0.rst   |  98 ++++++++
 .../migration-guides/release-notes-6.0.rst         | 256 +++++++++++++++++++--
 2 files changed, 340 insertions(+), 14 deletions(-)
documentation/migration-guides/migration-6.0.rst +98 -0
index 18cb62f1d..8008c547d 100644
@@ -165,6 +165,19 @@ The following :term:`DISTRO_FEATURES` are now enabled by default in
 
 See commit :oecore_rev:`2e1e7c86064ce36580953650b27cca9ae7c269c4` for more information.
 
+Default configuration templates removed from :yocto_git:`meta-poky </meta-yocto/tree/meta-poky>`
+------------------------------------------------------------------------------------------------
+
+The configuration templates located in ``meta-poky/conf/templates/default`` have
+been removed as they are now provided in a single location:
+:term:`OpenEmbedded-Core (OE-Core)` :oecore_path:`meta/conf/templates/default`.
+
+These files were duplicating themselves but were mostly similar.
+
+See commit :meta_yocto_rev:`ac300baea7314ea3c80f2330b2a993f729f32150` for more
+information on the differences there are between the two sets of default
+templates.
+
 :ref:`ref-classes-native` and :ref:`ref-classes-cross` classes :term:`DEBUG_BUILD` change
 -----------------------------------------------------------------------------------------
 
@@ -240,6 +253,38 @@ class, meaning recipes using these variables that not yet inheriting the
 
 See commit :oecore_rev:`68d2d38483efada7bc2409e10508b03a7431caff` for more information.
 
+:ref:`ref-classes-vex` output JSON document extension change
+------------------------------------------------------------
+
+Image recipes that inherit the :ref:`ref-classes-vex` class have an extra JSON
+document generated which was previous ending with the ``.json`` suffix. For
+example, a build for the ``core-image-minimal`` image recipe with this class
+would have resulted in a file named::
+
+   core-image-minimal-qemuarm64.rootfs.json
+
+The suffix of this file is now ``.vex.json``. Taking the above example, the same
+file is now named::
+
+   core-image-minimal-qemuarm64.rootfs.vex.json
+
+Support for SPDX 2.2 removed
+----------------------------
+
+Support for generating SPDX 2.2 document through the ``create-spdx-2.2`` class
+was removed:
+
+.. code-block::
+
+   Removes SPDX 2.2 support in favor of SPDX 3 support being the only
+   option. The SPDX 3 data is far superior to SPDX 2.2 and thus more useful
+   for SBoM uses cases.
+
+See commit :oecore_rev:`12abd0574c267bade0962ecb39d9e8da8c56842b` for more
+information.
+
+Users are advised to transition to SDPX 3.0, which is provided by the
+:ref:`ref-classes-create-spdx` class.
 
 .. _ref-migration-6-0-wic-sector-size-change:
 
@@ -270,6 +315,39 @@ Should be replaced by::
 See commit :oecore_rev:`b50d6debf7baa555fbfb3521c4f952675bba2d37` for more
 information.
 
+:doc:`WIC </dev-manual/wic>` files to be moved under ``files/wic``
+------------------------------------------------------------------
+
+:doc:`WIC </dev-manual/wic>` related files such as :doc:`WKS
+</ref-manual/kickstart>` files or custom WIC plugins should be moved to the
+``files/wic/`` directory of the layer containing them.
+
+If not done, the build will fail with errors indicating how to move these files,
+for example::
+
+   wic/wks files at ../meta-custom/wic need to be moved to files/wic within the layer to be found/used
+   wic/wks files at ../meta-custom/scripts/lib/wic/canned-wks need to be moved to files/wic within the layer to be found/used
+
+For example, here is the content of the :term:`OpenEmbedded-Core (OE-Core)`
+"meta" layer as of writing::
+
+   meta/files/wic
+   ├── common.wks.inc
+   ├── directdisk-bootloader-config.cfg
+   ├── directdisk-bootloader-config.wks
+   ├── directdisk-gpt.wks
+   ├── directdisk-multi-rootfs.wks
+   ├── directdisk.wks
+   ├── efi-bootdisk.wks.in
+   ├── efi-uki-bootdisk.wks.in
+   ├── mkefidisk.wks
+   ├── mkhybridiso.wks
+   ├── qemuloongarch.wks
+   ├── qemuriscv.wks
+   ├── qemux86-directdisk.wks
+   ├── sdimage-bootpart.wks
+   └── systemd-bootdisk.wks
+
 Rust language changes
 ---------------------
 
@@ -314,6 +392,18 @@ The following recipes have been removed in this release:
 -  ``systemd-compat-units``: Dropped as a consequence of removing
    :wikipedia:`SysVinit <UNIX_System_V>` support in :wikipedia:`systemd
    <Systemd>`
+   (:oecore_rev:`d9ec9e20eebc062d084dd76b59d665994e0cb51b`)
+
+-  ``gstreamer1.0-vaapi``: removed as it was already provided by the ``va``
+   :term:`PACKAGECONFIG` item of ``gstreamer1.0-plugins-bad``.
+   (:oecore_rev:`9e2d2a5b0c9e062f13651093bb1e459f210618e6`)
+
+-  ``pkgconfig``: replaced by the ``pkgconf`` recipe
+   (:oecore_rev:`e32bf38fab8b2ae417022a4dbd36f7e1ce52c206`)
+
+-  ``python3-pyzstd``: there were no users of this in :term:`OpenEmbedded-Core
+   (OE-Core)` and Python 3.14 now has built-in support for zstd
+   (:oecore_rev:`55061de857657ea01babc5652caa062e8d292c44`)
 
 Removed :term:`PACKAGECONFIG` options
 -------------------------------------
@@ -321,6 +411,8 @@ Removed :term:`PACKAGECONFIG` options
 -  ``mesa``: ``freedreno-fdperf`` (:oecore_rev:`293edd0d3d077d0fde7ba6671dc9a26d5b4cf5e4`)
 -  ``libcxx``: ``no-atomics`` (:oecore_rev:`ccc585f94c51ebaef863f116bcd2b41b2d958666`)
 -  ``systemd``: ``sysvinit`` (:oecore_rev:`e00d5d6eac65e2cd88e34c2790469c7325bfb37d`)
+-  ``gstreamer1.0-plugins-good``: ``soup2`` (:oecore_rev:`61d653562a5b3903aa4e79791b58a75e4dc74236`)
+-  ``webkitgtk``: ``soup2`` (:oecore_rev:`69af43387e809e595b992b3576dde89e700cc711`)
 
 Removed classes
 ---------------
@@ -340,3 +432,9 @@ Miscellaneous changes
 
 -  :ref:`ref-classes-meson`: drop ``meson_do_qa_configure`` as it was
    non-functional (:oecore_rev:`0514b451b5d96135c6d24e75e0afa8b5aea513dd`)
+
+-  Drop VSCode setup support from the ``oe-init-build-env`` script. Users are
+   advised to use :doc:`bitbake-setup
+   <bitbake:bitbake-user-manual/bitbake-user-manual-environment-setup>`
+   instead (:oecore_rev:`4e781c6618ae8ba1a3d2c1242a92017dbe44caaf`)
+
documentation/migration-guides/release-notes-6.0.rst +242 -14

387 lines not on this page · raw message

Signature · 1 line
2.53.0
#19 lore raw

Re: [docs] [PATCH 17/18] migration-guides: update 6.0 (Wrynose) release notes

Hi Antonin,

On 4/10/26 4:43 PM, Antonin Godard via lists.yoctoproject.org wrote:
[...]

documentation/migration-guides/migration-6.0.rst class, meaning recipes using these variables that not yet inheriting the · line 282

Quoted 12 lines
documentation/migration-guides/migration-6.0.rst +12 -0
+Support for SPDX 2.2 removed
+----------------------------
+
+Support for generating SPDX 2.2 document through the ``create-spdx-2.2`` class
+was removed:
+
+.. code-block::
+
+   Removes SPDX 2.2 support in favor of SPDX 3 support being the only
+   option. The SPDX 3 data is far superior to SPDX 2.2 and thus more useful
+   for SBoM uses cases.
+

We have a mix of SBoM and SBOM in the docs, we should probably be more consistent there. Wikipedia says SBOM in https://en.wikipedia.org/wiki/Software_supply_chain, so I guess we could go with that? What do you think?

Cheers,
Quentin

#20 lore raw

PATCH 18/18 migration-guides/migration-6.0.rst: tidy up the file

In reply to Antonin Godard

Fill in the missing pieces of the file, remove empty sections, and make the "Support for SysVinit compatibility in systemd was dropped" its own section as it was alone in "systemd changes".

---
 documentation/migration-guides/migration-6.0.rst | 32 +++++++-----------------
 1 file changed, 9 insertions(+), 23 deletions(-)
documentation/migration-guides/migration-6.0.rst +9 -23
index 8008c547d..42c688a89 100644
@@ -30,7 +30,7 @@ See also the list of new features and enhancements of the previous releases:
 Supported kernel versions
 -------------------------
 
-The :term:`OLDEST_KERNEL` setting is XXX in this release, meaning that
+The :term:`OLDEST_KERNEL` setting is 5.15 in this release, meaning that
 out the box, older kernels are not supported. See :ref:`4.3 migration notes
 <migration-4.3-supported-kernel-versions>` for details.
 
@@ -40,11 +40,16 @@ Supported distributions
 Compared to the previous releases, running BitBake is supported on new
 GNU/Linux distributions:
 
--  XXX
+-  Fedora 43
+-  openSUSE Leap 16.0
+-  Ubuntu 26.04 (LTS)
 
 On the other hand, some earlier distributions are no longer supported:
 
--  XXX
+-  Fedora 39
+-  Fedora 40
+-  Fedora 41
+-  openSUSE Leap 15.5
 
 See :ref:`all supported distributions <system-requirements-supported-distros>`.
 
@@ -348,14 +353,8 @@ For example, here is the content of the :term:`OpenEmbedded-Core (OE-Core)`
    ├── sdimage-bootpart.wks
    └── systemd-bootdisk.wks
 
-Rust language changes
----------------------
-
-systemd changes
----------------
-
 Support for SysVinit compatibility in systemd was dropped
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+---------------------------------------------------------
 
 Support for the :wikipedia:`SysVinit <UNIX_System_V>` compatibility in
 :wikipedia:`systemd <Systemd>` was dropped.
@@ -371,14 +370,6 @@ Users are advised to switch to one init manager or the other entirely.
 
 See commit :oecore_rev:`d9ec9e20eebc062d084dd76b59d665994e0cb51b` for more information.
 
-Recipe changes
---------------
-
-Removed variables
------------------
-
-The following variables have been removed:
-
 Removed recipes
 ---------------
 
@@ -422,11 +413,6 @@ The following classes have been removed in this release:
 -  ``oelint``: remove as most of the checks done by this class are done in other
    areas of code now, making this class obsolete.
 
-Removed features
-----------------
-
-The following features have been removed in this release:
-
 Miscellaneous changes
 ---------------------
 
Signature · 1 line
2.53.0
author Applied
#21 lore raw
In reply to Antonin Godard

Applied, thanks!

[01/18] conf.py: define new *_path roles

        commit: 89cf4b98686f6f353811d444f36848410ffd2929
[02/18] ref-manual/classes.rst: document the kernel-yocto-rust class
        commit: 0cea0cc9de56687dc0f37ee5194db2258792a2ca
[03/18] ref-manual/classes.rst: document the module-rust class
        commit: b9bb216a45a3f0797a74d89742a8583e784943fb
[04/18] ref-manual/classes.rst: document the KCONFIG_CONFIG_ROOTDIR variable
        commit: 7eee5e7f60ac90cdbf364467bb7e3b8cd29b4df7
[05/18] ref-manual/variables.rst: document the UKI_DEVICETREE variable
        commit: 542a5f454ceec3ae0c3f3ec7dc41974ef19b240a
[06/18] docs-wide: refresh SBOM documentation after SPDX2.2 removal
        commit: 921e941437f09294a840c27d973ecbb2f1fcf185
[07/18] dev-manual/sbom.rst: add bullet point on recipe SBOM
        commit: 4e034d2aa28be854004e6471bb7ed06c75d1255d
[08/18] ref-manual/variables.rst: document the SPDX_PACKAGE_URLS variable
        commit: c34bfa05cc101849ffe983cdbd755ccb57ffe7f4
[09/18] ref-manual/variables.rst: document the SPDX_GIT_PURL_MAPPINGS variable
        commit: c7925d14afd27d20b72c27f453698d96bfc2d846
[10/18] ref-manual/variables.rst: document the SPDX_INCLUDE_VEX variable
        commit: 851f25e271d0f229f76733cdcf854d9bd1e3a4c9
[11/18] migration-guides/migration-6.0.rst: add note on WIC_SECTOR_SIZE
        commit: bd22f27619182ab1395818712b91ec5511d5f500
[12/18] ref-manual: document the sbom-cve-check class, fragment, and variables
        commit: 51162cd20d7ab1f2b5cac623adbde431865a81e2
[13/18] docs-wide: adapt to the new {DISTRO,MACHINE}_FEATURES mechanism
        commit: 30efdd544a6027332408b42251809f51e73cb791
[14/18] ref-manual/features.rst: drop pcmcia from DISTRO_FEATURES
        commit: daf9e613cc20fe598bab033f5f403a0420663386
[15/18] ref-manual/features.rst: drop usbhost/usbgadget from DISTRO_FEATURES
        commit: dd36ade5e54a52c8afeddb40158c8c31c858e4ec
[16/18] docs-wide: replace meta-poky/conf/templates/default by oecore's templates
        commit: 72e6d674a5d0bad4cc72037a13d8c9fcba24d38e
[17/18] migration-guides: update 6.0 (Wrynose) release notes
        commit: 8a29e23d144ee5b65de8b30d0bcb993e77a74fbd
[18/18] migration-guides/migration-6.0.rst: tidy up the file
        commit: 5cc3b6690acf0c209514eae68006b1f24735302b