Skip to contentSkip to conversation

4.1 release notes and related changes

PATCH In review Paul Eggleton 5 participants 52 messages Oct 10, 2022 – Oct 17, 2022 4 messages not in the archive

lore
Share & tools
lore
#0 lore raw

cover 4.1 release notes and related changes

Here are the release notes and migration guide for 4.1 (langdale) as well as a whole heap of additions of missing documentation. I may have got a little carried away, but almost all of it was necessary to be able to have links from the release notes / migration guide for more information.

Some things that we still need to sort out before release:
* Known issues (if any)
* Download info
* externalsrc class has been moved to classes-recipe/ but documentation and comments in the class suggest using it globally (presumably to make it easier to support a subset of recipes without having to bbappend all of them.) We need to do one of the following:
A) move the class back to classes/ (easiest),
B) update the documentation and comments to remove the global usage, and note in the migration guide, or
C) add it as a known issue and fix with A/B later.
* New direct ESDK feature refers to "bitbake populate-sysroots" instead of "bitbake build-sysroots" - Alex will be sending a patch soon.

A few gaps that are still present (probably post-release at this point):
* Rust support (classes, variables)
* New layer setup functionality

Let me know if I missed anything / messed anything up.

The following changes since commit 42d3e26a0d04bc5951e640b471686f347dc9b74a:

ref-manual/faq.rst: update references to products built with OE / Yocto Project (2022-10-06 10:22:27 +0200)

are available in the git repository at:

https://git.yoctoproject.org/poky-contrib paule/4.1-release
http://git.yoctoproject.org/cgit.cgi/poky-contrib/log/?h=paule/4.1-release

Paul Eggleton (34):
migration-general: add section on using buildhistory
ref-manual: add DISABLE_STATIC
ref-manual: expand documentation on image-buildinfo class
ref-manual: add WATCHDOG_TIMEOUT to variable glossary
ref-manual: correct default for BUILDHISTORY_COMMIT
ref-manual: document new github-releases class
ref-manual: add a note to ssh-server-dropbear feature
ref-manual: sync supported distro list with code
ref-manual: update buildpaths QA check documentation
ref-manual: add UBOOT_MKIMAGE_SIGN
ref-manual: add DEV_PKG_DEPENDENCY
ref-manual: add SDK_TOOLCHAIN_LANGS
ref-manual: add pressure limit variable documentation
ref-manual: add pypi class
ref-manual: update pypi documentation for CVE_PRODUCT default in 4.1
ref-manual: add CVE_CHECK_SHOW_WARNINGS
ref-manual: add info on buildtools-make-tarball
ref-manual: add FIT_PAD_ALG
ref-manual: add CVE_DB_UPDATE_INTERVAL
ref-manual: add KERNEL_DEPLOY_DEPEND
ref-manual: add MOUNT_BASE variable
ref-manual: remove reference to testimage-auto class Update documentation for classes split
ref-manual: complementary package installation recommends
ref-manual: remove reference to largefile in DISTRO_FEATURES
ref-manual: add missing features
ref-manual: add serial-autologin-root to IMAGE_FEATURES documentation
ref-manual: add previous overlayfs-etc variables
ref-manual: add OVERLAYFS_ETC_EXPOSE_LOWER
ref-manual: add WIRELESS_DAEMON
ref-manual: add section for create-spdx class
ref-manual: add overlayfs class variables
ref-manual: add OVERLAYFS_QA_SKIP
Add 4.1 migration guide & release notes

 documentation/dev-manual/common-tasks.rst          |   8 +-
 documentation/migration-guides/index.rst           |   1 +
 documentation/migration-guides/migration-1.5.rst   |   2 +-
 documentation/migration-guides/migration-2.6.rst   |   2 +-
 documentation/migration-guides/migration-4.1.rst   | 214 +++++++
 .../migration-guides/migration-general.rst         |  33 +
 documentation/migration-guides/release-4.1.rst     |   7 +
 .../migration-guides/release-notes-4.1.rst         | 687 +++++++++++++++++++++
 documentation/overview-manual/concepts.rst         |   6 +-
 documentation/ref-manual/classes.rst               |  96 ++-
 documentation/ref-manual/faq.rst                   |   2 +-
 documentation/ref-manual/features.rst              |  74 ++-
 documentation/ref-manual/qa-checks.rst             |  16 +
 documentation/ref-manual/release-process.rst       |   2 +-
 documentation/ref-manual/structure.rst             |   6 +-
 documentation/ref-manual/system-requirements.rst   |  28 +-
 documentation/ref-manual/tasks.rst                 |   4 +-
 documentation/ref-manual/variables.rst             | 303 +++++++--
 documentation/test-manual/intro.rst                |   4 +-
 19 files changed, 1414 insertions(+), 81 deletions(-)
 create mode 100644 documentation/migration-guides/migration-4.1.rst
 create mode 100644 documentation/migration-guides/release-4.1.rst
 create mode 100644 documentation/migration-guides/release-notes-4.1.rst
Signature · 1 line
1.8.3.1
#1 lore raw

PATCH 1/34 migration-general: add section on using buildhistory

From: Paul Eggleton <[email protected]>

Add a short section recommending the use of buildhistory to compare the build output before and after migration.

---
 .../migration-guides/migration-general.rst         | 33 ++++++++++++++++++++++
 1 file changed, 33 insertions(+)
documentation/migration-guides/migration-general.rst +33 -0
index 9eecf69..8b22508 100644
@@ -70,3 +70,36 @@ any new Yocto Project release.
      bitbake-layers show-appends
 
 
+.. _migration-general-buildhistory:
+
+- *Checking Image / SDK Changes*:
+
+   The :ref:`buildhistory <ref-classes-buildhistory>` class can be used
+   if you wish to check the impact of changes to images / SDKs across
+   the migration (e.g. added/removed packages, added/removed files, size
+   changes etc.). To do this, follow these steps:
+
+   1. Enable buildhistory before the migration
+
+   2. Run a pre-migration build
+
+   3. Capture the buildhistory output (as specified by :term:`BUILDHISTORY_DIR`)
+      and ensure it is preserved for subsequent builds. How you would do this
+      depends how you are running your builds - if you are doing this all on
+      one workstation in the same build directory you may not need to do
+      anything other than not deleting the buildhistory output directory. For
+      builds in a pipeline it may be more complicated.
+
+   4. Set a tag in the buildhistory output (which is a git repository) before
+      migration, to make the commit from the pre-migration build easy to find
+      as you may end up running multiple builds during the migration.
+
+   5. Perform the migration
+
+   6. Run a build
+
+   7. Check the output changes between the previously set tag and HEAD in the
+      buildhistory output using ``git diff`` or ``buildhistory-diff``.
+
+   For more information on using buildhistory, see
+   :ref:`dev-manual/common-tasks:maintaining build output quality`.
Signature · 1 line
1.8.3.1
#2 lore raw

Re: [docs] [PATCH 01/34] migration-general: add section on using buildhistory

Hi Paul

Many thanks for all these patches!

Quoted 24 lines · Paul Eggleton

From: Paul Eggleton <[email protected]>

Add a short section recommending the use of buildhistory to compare the build output before and after migration.

---
  .../migration-guides/migration-general.rst         | 33 ++++++++++++++++++++++
  1 file changed, 33 insertions(+)
documentation/migration-guides/migration-general.rst +6 -0
index 9eecf69..8b22508 100644
@@ -70,3 +70,36 @@ any new Yocto Project release.
       bitbake-layers show-appends
 
 
+.. _migration-general-buildhistory:
+
+- *Checking Image / SDK Changes*:
+
+   The :ref:`buildhistory <ref-classes-buildhistory>` class can be used
+   if you wish to check the impact of changes to images / SDKs across

documentation/migration-guides/migration-general.rst any new Yocto Project release. · line 88

Quoted 10 lines
documentation/migration-guides/migration-general.rst +10 -0
+   the migration (e.g. added/removed packages, added/removed files, size
+   changes etc.). To do this, follow these steps:
+
+   1. Enable buildhistory before the migration
+
+   2. Run a pre-migration build
+
+   3. Capture the buildhistory output (as specified by :term:`BUILDHISTORY_DIR`)
+      and ensure it is preserved for subsequent builds. How you would do this
+      depends how you are running your builds - if you are doing this all on

s/depends how/depends on how/?
The rest looks good.
Thanks again

Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#3 lore raw

PATCH 2/34 ref-manual: add DISABLE_STATIC

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

This was added all the way back in krogoth.

---
 documentation/ref-manual/variables.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)
documentation/ref-manual/variables.rst +12 -0
index 1685a26..8ea9834 100644
@@ -1812,6 +1812,18 @@ system and gives an overview of their function and contents.
       :term:`DESCRIPTION` takes the value of the :term:`SUMMARY`
       variable.
 
+   :term:`DISABLE_STATIC`
+      Used in order to disable static linking by default (in order to save
+      space, since static libraries are often unused in embedded systems.)
+      The default value is " --disable-static", however it can be set to ""
+      in order to enable static linking if desired. Certain recipes do this
+      individually, and also there is a
+      ``meta/conf/distro/include/no-static-libs.inc`` include file that
+      disables static linking for a number of recipes. Some software
+      packages or build tools (such as CMake) have explicit support for
+      enabling / disabling static linking, and in those cases
+      :term:`DISABLE_STATIC` is not used.
+
    :term:`DISTRO`
       The short name of the distribution. For information on the long name
       of the distribution, see the :term:`DISTRO_NAME`
Signature · 1 line
1.8.3.1
#4 lore raw

PATCH 3/34 ref-manual: expand documentation on image-buildinfo class

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

Expand the documentation on the image-buildinfo class, and add variable glossary entries for IMAGE_BUILDINFO_FILE, IMAGE_BUILDINFO_VARS and SDK_BUILDINFO_FILE (latter is new in 4.1).

---
 documentation/ref-manual/classes.rst   | 18 ++++++++++++++++--
 documentation/ref-manual/variables.rst | 16 ++++++++++++++++
 2 files changed, 32 insertions(+), 2 deletions(-)
documentation/ref-manual/classes.rst +16 -2
index 5e49613..cc0d212 100644
@@ -881,8 +881,22 @@ Yocto Project Overview and Concepts Manual.
 ``image-buildinfo.bbclass``
 ===========================
 
-The ``image-buildinfo`` class writes information to the target
-filesystem on ``/etc/build``.
+The ``image-buildinfo`` class writes a plain text file containing
+build information to the target filesystem at ``${sysconfdir}/buildinfo``
+by default (as specified by :term:`IMAGE_BUILDINFO_FILE`.
+This can be useful for manually determining the origin of any given
+image. It writes out two sections:
+
+1. `Build Configuration`: a list of variables and their values (specified
+   by :term:`IMAGE_BUILDINFO_VARS`, which defaults to :term:`DISTRO` and
+   :term:`DISTRO_VERSION`)
+
+2. `Layer Revisions`: the revisions of all of the layers used in the
+   build.
+
+Additionally, when building an SDK it will write the same contents
+to ``/buildinfo`` by default (as specified by
+:term:`SDK_BUILDINFO_FILE`).
 
 .. _ref-classes-image_types:
 
documentation/ref-manual/variables.rst +16 -0
index 8ea9834..8b0331c 100644
@@ -3053,6 +3053,17 @@ system and gives an overview of their function and contents.
       material for Wic is located in the
       ":doc:`/ref-manual/kickstart`" chapter.
 
+   :term:`IMAGE_BUILDINFO_FILE`
+      When using the :ref:`image-buildinfo <ref-classes-image-buildinfo>` class,
+      specifies the file in the image to write the build information into. The
+      default value is "``${sysconfdir}/buildinfo``".
+
+   :term:`IMAGE_BUILDINFO_VARS`
+      When using the :ref:`image-buildinfo <ref-classes-image-buildinfo>` class,
+      specifies the list of variables to include in the `Build Configuration`
+      section of the output file (as a space-separated list). Defaults to
+      ":term:`DISTRO` :term:`DISTRO_VERSION`".
+
    :term:`IMAGE_CLASSES`
       A list of classes that all images should inherit. You typically use
       this variable to specify the list of classes that register the
@@ -6627,6 +6638,11 @@ system and gives an overview of their function and contents.
       The target architecture for the SDK. Typically, you do not directly
       set this variable. Instead, use :term:`SDKMACHINE`.
 
+   :term:`SDK_BUILDINFO_FILE`
+      When using the :ref:`image-buildinfo <ref-classes-image-buildinfo>` class,
+      specifies the file in the SDK to write the build information into. The
+      default value is "``/buildinfo``".
+
    :term:`SDK_CUSTOM_TEMPLATECONF`
       When building the extensible SDK, if :term:`SDK_CUSTOM_TEMPLATECONF` is set to
       "1" and a ``conf/templateconf.cfg`` file exists in the build directory
Signature · 1 line
1.8.3.1
#5 lore raw

PATCH 4/34 ref-manual: add WATCHDOG_TIMEOUT to variable glossary

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

In 4.1 the WATCHDOG_TIMEOUT variable is now used in two places, so let's actually document it.

---
 documentation/ref-manual/variables.rst | 4 ++++
 1 file changed, 4 insertions(+)
documentation/ref-manual/variables.rst +4 -0
index 8b0331c..9eb453c 100644
@@ -8872,6 +8872,10 @@ system and gives an overview of their function and contents.
       can control with this variable, see the
       ":ref:`ref-classes-insane`" section.
 
+   :term:`WATCHDOG_TIMEOUT`
+      Specifies the timeout in seconds used by the ``watchdog`` recipe and
+      also by ``systemd`` during reboot. The default is 60 seconds.
+
    :term:`WKS_FILE`
       Specifies the location of the Wic kickstart file that is used by the
       OpenEmbedded build system to create a partitioned image
Signature · 1 line
1.8.3.1
#6 lore raw

PATCH 5/34 ref-manual: correct default for BUILDHISTORY_COMMIT

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

The default changed to "1" back in 2017 (OE-Core revision 8018a2349b7ad5ab27731c93a49603adf5f72fc2). It seems I missed updating the documentation to match.

---
 documentation/ref-manual/variables.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
documentation/ref-manual/variables.rst +3 -3
index 9eb453c..81a4ab1 100644
@@ -920,10 +920,10 @@ system and gives an overview of their function and contents.
       and sdk). If you want to track changes to build history over time,
       you should set this value to "1".
 
-      By default, the :ref:`buildhistory <ref-classes-buildhistory>` class does not commit the build
-      history output in a local Git repository::
+      By default, the :ref:`buildhistory <ref-classes-buildhistory>` class
+      enables committing the buildhistory output in a local Git repository::
 
-         BUILDHISTORY_COMMIT ?= "0"
+         BUILDHISTORY_COMMIT ?= "1"
 
    :term:`BUILDHISTORY_COMMIT_AUTHOR`
       When inheriting the :ref:`buildhistory <ref-classes-buildhistory>`
Signature · 1 line
1.8.3.1
#7 lore raw

PATCH 6/34 ref-manual: document new github-releases class

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

Newly added class in 4.1.

---
 documentation/ref-manual/classes.rst   | 14 ++++++++++++++
 documentation/ref-manual/variables.rst |  7 +++++++
 2 files changed, 21 insertions(+)
documentation/ref-manual/classes.rst +14 -0
index cc0d212..6c60d41 100644
@@ -659,6 +659,20 @@ the GNU ``gettext`` internationalization and localization system. All
 recipes building software that use ``gettext`` should inherit this
 class.
 
+.. _ref-classes-github-releases:
+
+``github-releases``
+===================
+
+For recipes that fetch release tarballs from github, the ``github-releases``
+class sets up a standard way for checking available upstream versions
+(to support ``devtool upgrade`` and the Automated Upgrade Helper (AUH)).
+
+To use it, add ``github-releases`` to the inherit line in the recipe,
+and if the default value of :term:`GITHUB_BASE_URI` is not suitable,
+then set your own value in the recipe. You should then use ``${GITHUB_BASE_URI}``
+in the value you set for :term:`SRC_URI` within the recipe.
+
 .. _ref-classes-gnomebase:
 
 ``gnomebase.bbclass``
documentation/ref-manual/variables.rst +7 -0
index 81a4ab1..bdc8e3b 100644
@@ -2768,6 +2768,13 @@ system and gives an overview of their function and contents.
       The directory in which a local copy of a Git repository is stored
       when it is cloned.
 
+   :term:`GITHUB_BASE_URI`
+      When inheriting the :ref:`github-releases <ref-classes-github-releases>`
+      class, specifies the base URL for fetching releases for the github
+      project you wish to fetch sources from. The default value is as follows::
+
+         GITHUB_BASE_URI ?= "https://github.com/${BPN}/${BPN}/releases/"
+
    :term:`GLIBC_GENERATE_LOCALES`
       Specifies the list of GLIBC locales to generate should you not wish
       to generate all LIBC locals, which can be time consuming.
Signature · 1 line
1.8.3.1
#8 lore raw

PATCH 7/34 ref-manual: add a note to ssh-server-dropbear feature

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

Add a note regarding the 4.1 change to add openssh-sftp-server as a recommends from ssh-server-dropbear.

---
 documentation/ref-manual/features.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
documentation/ref-manual/features.rst +15 -0
index 5e853ca..9dc73db 100644
@@ -322,6 +322,21 @@ these valid features is as follows:
 
 -  *ssh-server-dropbear:* Installs the Dropbear minimal SSH server.
 
+   .. note::
+
+      As of the 4.1 release, the ``ssh-server-dropbear`` feature also
+      recommends the ``openssh-sftp-server`` package, which by default
+      will be pulled into the image. This is because recent versions of
+      the OpenSSH ``scp`` client now use the SFTP protocol, and thus
+      require an SFTP server to be present to connect to. However, if
+      you wish to use the Dropbear ssh server `without` the SFTP server
+      installed, you can either remove ``ssh-server-dropbear`` from
+      ``IMAGE_FEATURES`` and add ``dropbear`` to :term:`IMAGE_INSTALL`
+      instead, or alternatively still use the feature but set
+      :term:`BAD_RECOMMENDATIONS` as follows::
+
+         BAD_RECOMMENDATIONS += "openssh-sftp-server"
+
 -  *ssh-server-openssh:* Installs the OpenSSH SSH server, which is more
    full-featured than Dropbear. Note that if both the OpenSSH SSH server
    and the Dropbear minimal SSH server are present in
Signature · 1 line
1.8.3.1
#9 lore raw

PATCH 8/34 ref-manual: sync supported distro list with code

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

We were missing Ubuntu 21.10.

---
 documentation/ref-manual/system-requirements.rst | 2 ++
 1 file changed, 2 insertions(+)
documentation/ref-manual/system-requirements.rst +2 -0
index acc97c9..014c9a5 100644
@@ -41,6 +41,8 @@ distributions:
 
 -  Ubuntu 20.04 (LTS)
 
+-  Ubuntu 21.10
+
 -  Ubuntu 22.04 (LTS)
 
 -  Fedora 34
Signature · 1 line
1.8.3.1
#10 lore raw

Re: [docs] [PATCH 08/34] ref-manual: sync supported distro list with code

Hi Paul,

Quoted 14 lines · Paul Eggleton

From: Paul Eggleton <[email protected]>

We were missing Ubuntu 21.10.

---
  documentation/ref-manual/system-requirements.rst | 2 ++
  1 file changed, 2 insertions(+)
documentation/ref-manual/system-requirements.rst +0 -0
index acc97c9..014c9a5 100644

documentation/ref-manual/system-requirements.rst distributions: · line 46

Quoted 6 lines
documentation/ref-manual/system-requirements.rst +2 -0
@@ -41,6 +41,8 @@ distributions:
 
  -  Ubuntu 20.04 (LTS)
 
+-  Ubuntu 21.10
+
  -  Ubuntu 22.04 (LTS)

Is the code right though? 21.10 is no longer updated by Canonical and 22.04 is more recent. What about stopping testing it instead? That's why I didn't add it to the documentation.
Cheers
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#11 lore raw

Re: [docs] [PATCH 08/34] ref-manual: sync supported distro list with code

Quoted 22 lines · On Tuesday, 11 October 2022 21:20:37 NZDT Michael Opdenacker via…

Hi Paul,

Quoted 19 lines · Paul Eggleton

From: Paul Eggleton <[email protected]>

We were missing Ubuntu 21.10.

---

  documentation/ref-manual/system-requirements.rst | 2 ++
  1 file changed, 2 insertions(+)
(quoted diff) +0 -0

b/documentation/ref-manual/system-requirements.rst index acc97c9..014c9a5 100644

documentation/ref-manual/system-requirements.rst +0 -0
@@ -41,6 +41,8 @@ distributions:
  -  Ubuntu 20.04 (LTS)
 
Quoted 7 lines

documentation/ref-manual/system-requirements.rst distributions:

Quoted 4 lines
documentation/ref-manual/system-requirements.rst +2 -0
+-  Ubuntu 21.10
+
 
  -  Ubuntu 22.04 (LTS)

Is the code right though? 21.10 is no longer updated by Canonical and 22.04 is more recent. What about stopping testing it instead?

Fine by me, I just figured the documentation should match what is in SANITY_TESTED_DISTROS; in this case perhaps the latter needs updating.

Cheers
Paul

#12 lore raw

Re: [docs] [PATCH 08/34] ref-manual: sync supported distro list with code

Quoted 24 lines · Paul Eggleton
Quoted 22 lines · On Tuesday, 11 October 2022 21:20:37 NZDT Michael Opdenacker via…

Hi Paul,

Quoted 19 lines · Paul Eggleton

From: Paul Eggleton <[email protected]>

We were missing Ubuntu 21.10.

---

   documentation/ref-manual/system-requirements.rst | 2 ++
   1 file changed, 2 insertions(+)
(quoted diff) +0 -0

b/documentation/ref-manual/system-requirements.rst index acc97c9..014c9a5 100644

documentation/ref-manual/system-requirements.rst +0 -0
@@ -41,6 +41,8 @@ distributions:
   -  Ubuntu 20.04 (LTS)
 
Quoted 8 lines
Quoted 6 lines

documentation/ref-manual/system-requirements.rst distributions:

Quoted 4 lines
documentation/ref-manual/system-requirements.rst +2 -0
+-  Ubuntu 21.10
+
 
   -  Ubuntu 22.04 (LTS)

Is the code right though? 21.10 is no longer updated by Canonical and 22.04 is more recent. What about stopping testing it instead?

Fine by me, I just figured the documentation should match what is in SANITY_TESTED_DISTROS; in this case perhaps the latter needs updating.

Done (at least proposed): https://lists.yoctoproject.org/g/poky/message/12908
Thanks
Michael

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#13 lore raw

PATCH 9/34 ref-manual: update buildpaths QA check documentation

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

The buildpaths QA check is now practically usable and enabled by default, so update the comment and add a section with the warning message since users may start seeing it in their builds.

---
 documentation/ref-manual/classes.rst   |  4 ++--
 documentation/ref-manual/qa-checks.rst | 16 ++++++++++++++++
 2 files changed, 18 insertions(+), 2 deletions(-)
documentation/ref-manual/classes.rst +2 -2
index 6c60d41..d94db03 100644
@@ -1008,8 +1008,8 @@ Here are the tests you can list with the :term:`WARN_QA` and
    software, like bootloaders, might need to bypass this check.
 
 -  ``buildpaths:`` Checks for paths to locations on the build host
-   inside the output files. Currently, this test triggers too many false
-   positives and thus is not normally enabled.
+   inside the output files. Not only can these leak information about
+   the build environment, they also hinder binary reproducibility.
 
 -  ``build-deps:`` Determines if a build-time dependency that is
    specified through :term:`DEPENDS`, explicit
documentation/ref-manual/qa-checks.rst +16 -0
index 9455bec..fb31dc1 100644
@@ -748,6 +748,22 @@ Errors and Warnings
     other things in the patches, those can be discarded.
 
 
+.. _qa-check-buildpaths:
+
+- ``File <filename> in package <packagename> contains reference to TMPDIR [buildpaths]``
+
+    This check ensures that build system paths (including :term:`TMPDIR`) do not
+    appear in output files, which not only leaks build system configuration into
+    the target, but also hinders binary reproducibility as the output will change
+    if the build system configuration changes.
+
+    Typically these paths will enter the output through some mechanism in the
+    configuration or compilation of the software being built by the recipe. To
+    resolve this issue you will need to determine how the detected path is
+    entering the output. Sometimes it may require adjusting scripts or code to
+    use a relative path rather than an absolute one, or to pick up the path from
+    runtime configuration or environment variables.
+
 
 Configuring and Disabling QA Checks
 ===================================
Signature · 1 line
1.8.3.1
#14 lore raw

PATCH 10/34 ref-manual: add UBOOT_MKIMAGE_SIGN

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

New variable in 4.1.

---
 documentation/ref-manual/variables.rst | 4 ++++
 1 file changed, 4 insertions(+)
documentation/ref-manual/variables.rst +4 -0
index bdc8e3b..7707f5a 100644
@@ -8564,6 +8564,10 @@ system and gives an overview of their function and contents.
       If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then kernel-fitimage will not
       pass the ``-D`` option to mkimage.
 
+   :term:`UBOOT_MKIMAGE_KERNEL_TYPE`
+      Specifies the type argument for the kernel as passed to ``uboot-mkimage``.
+      The default value is "kernel".
+
    :term:`UBOOT_MKIMAGE_SIGN`
       Specifies the name of the mkimage command as used by the
       :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to sign
Signature · 1 line
1.8.3.1

A message that is not in the archive (sent off-list or not yet received): [email protected]

#16 lore raw

Re: [docs] [PATCH 10/34] ref-manual: add UBOOT_MKIMAGE_SIGN

Quoted 2 lines · On Monday, 10 October 2022 23:24:07 NZDT Joshua Lock wrote:

Nit: commit title mentions UBOOT_MKIMAGE_SIGN , but the patch documents UBOOT_MKIMAGE_KERNEL_TYPE

Oops. Fixed on the branch.

Thanks
Paul

#17 lore raw

PATCH 11/34 ref-manual: add DEV_PKG_DEPENDENCY

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

New variable in 4.1.

---
 documentation/ref-manual/variables.rst | 5 +++++
 1 file changed, 5 insertions(+)
documentation/ref-manual/variables.rst +5 -0
index 7707f5a..ab39fa8 100644
@@ -1812,6 +1812,11 @@ system and gives an overview of their function and contents.
       :term:`DESCRIPTION` takes the value of the :term:`SUMMARY`
       variable.
 
+   :term:`DEV_PKG_DEPENDENCY`
+      Provides an easy way for recipes to disable or adjust the runtime
+      dependency (:term:`RDEPENDS`) of the ``${PN}-dev`` package on the main
+      (``${PN}``) package, particularly where the main package may be empty.
+
    :term:`DISABLE_STATIC`
       Used in order to disable static linking by default (in order to save
       space, since static libraries are often unused in embedded systems.)
Signature · 1 line
1.8.3.1
#18 lore raw

PATCH 12/34 ref-manual: add SDK_TOOLCHAIN_LANGS

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

New variable in 4.1.

---
 documentation/ref-manual/variables.rst | 4 ++++
 1 file changed, 4 insertions(+)
documentation/ref-manual/variables.rst +4 -0
index ab39fa8..0c6bd80 100644
@@ -6854,6 +6854,10 @@ system and gives an overview of their function and contents.
       section in the Yocto Project Application Development and the
       Extensible Software Development Kit (eSDK) manual.
 
+   :term:`SDK_TOOLCHAIN_LANGS`
+      Specifies programming languages to support in the SDK, as a
+      space-separated list. Currently supported items are ``rust`` and ``go``.
+
    :term:`SDK_UPDATE_URL`
       An optional URL for an update server for the extensible SDK. If set,
       the value is used as the default update server when running
Signature · 1 line
1.8.3.1
#19 lore raw

PATCH 13/34 ref-manual: add pressure limit variable documentation

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

Add BB_PRESSURE_MAX_CPU, BB_PRESSURE_MAX_IO and BB_PRESSURE_MAX_MEMORY variables (new in 4.1), based upon the supremely detailed commit messages from Aryaman Gupta <[email protected]> who implemented the functionality. There is probably enough material for a proper BitBake manual section (particularly if we can have some good guidance on how users should determine the values for best performance) but I did not have time to write such a section, and the BitBake manual probably needs some additional preamble on tasks / scheduling beforehand.

---
 documentation/ref-manual/variables.rst | 42 ++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)
documentation/ref-manual/variables.rst +42 -0
index 0c6bd80..e4304d1 100644
@@ -530,6 +530,48 @@ system and gives an overview of their function and contents.
       ":ref:`dev-manual/common-tasks:speeding up a build`"
       section in the Yocto Project Development Tasks Manual.
 
+   :term:`BB_PRESSURE_MAX_CPU`
+      Specifies a maximum CPU pressure threshold, above which BitBake's
+      scheduler will not start new tasks (providing there is at least
+      one active task). If no value is set, CPU pressure is not
+      monitored when starting tasks.
+
+      The pressure data is calculated based upon what (recent) Linux
+      kernels expose under ``/proc/pressure``. The threshold represents
+      the difference in "total" pressure from the previous second. The
+      minimum value is 1.0 (extremely slow builds) and the maximum is
+      1000000 (a pressure value unlikely to ever be reached).
+
+   :term:`BB_PRESSURE_MAX_IO`
+      Specifies a maximum I/O pressure threshold, above which BitBake's
+      scheduler will not start new tasks (providing there is at least
+      one active task). If no value is set, I/O pressure is not
+      monitored when starting tasks.
+
+      The pressure data is calculated based upon what (recent) Linux
+      kernels expose under ``/proc/pressure``. The threshold represents
+      the difference in "total" pressure from the previous second. The
+      minimum value is 1.0 (extremely slow builds) and the maximum is
+      1000000 (a pressure value unlikely to ever be reached).
+
+   :term:`BB_PRESSURE_MAX_MEMORY`
+      Specifies a maximum memory pressure threshold, above which BitBake's
+      scheduler will not start new tasks (providing there is at least
+      one active task). If no value is set, memory pressure is not
+      monitored when starting tasks.
+
+      The pressure data is calculated based upon what (recent) Linux
+      kernels expose under ``/proc/pressure``. The threshold represents
+      the difference in "total" pressure from the previous second. The
+      minimum value is 1.0 (extremely slow builds) and the maximum is
+      1000000 (a pressure value unlikely to ever be reached).
+
+      Memory pressure is experienced when time is spent swapping,
+      refaulting pages from the page cache or performing direct reclaim.
+      This is why memory pressure is rarely seen, but setting this variable
+      might be useful as a last resort to prevent OOM errors if they are
+      occurring during builds.
+
    :term:`BB_SERVER_TIMEOUT`
       Specifies the time (in seconds) after which to unload the BitBake
       server due to inactivity. Set :term:`BB_SERVER_TIMEOUT` to determine how
Signature · 1 line
1.8.3.1
#20 lore raw

Re: [docs] [PATCH 13/34] ref-manual: add pressure limit variable documentation

Hi Paul,

Quoted 60 lines · Paul Eggleton

From: Paul Eggleton <[email protected]>

Add BB_PRESSURE_MAX_CPU, BB_PRESSURE_MAX_IO and BB_PRESSURE_MAX_MEMORY variables (new in 4.1), based upon the supremely detailed commit messages from Aryaman Gupta <[email protected]> who implemented the functionality. There is probably enough material for a proper BitBake manual section (particularly if we can have some good guidance on how users should determine the values for best performance) but I did not have time to write such a section, and the BitBake manual probably needs some additional preamble on tasks / scheduling beforehand.

---
  documentation/ref-manual/variables.rst | 42 ++++++++++++++++++++++++++++++++++
  1 file changed, 42 insertions(+)
documentation/ref-manual/variables.rst +35 -0
index 0c6bd80..e4304d1 100644
@@ -530,6 +530,48 @@ system and gives an overview of their function and contents.
        ":ref:`dev-manual/common-tasks:speeding up a build`"
        section in the Yocto Project Development Tasks Manual.
 
+   :term:`BB_PRESSURE_MAX_CPU`
+      Specifies a maximum CPU pressure threshold, above which BitBake's
+      scheduler will not start new tasks (providing there is at least
+      one active task). If no value is set, CPU pressure is not
+      monitored when starting tasks.
+
+      The pressure data is calculated based upon what (recent) Linux
+      kernels expose under ``/proc/pressure``. The threshold represents
+      the difference in "total" pressure from the previous second. The
+      minimum value is 1.0 (extremely slow builds) and the maximum is
+      1000000 (a pressure value unlikely to ever be reached).
+
+   :term:`BB_PRESSURE_MAX_IO`
+      Specifies a maximum I/O pressure threshold, above which BitBake's
+      scheduler will not start new tasks (providing there is at least
+      one active task). If no value is set, I/O pressure is not
+      monitored when starting tasks.
+
+      The pressure data is calculated based upon what (recent) Linux
+      kernels expose under ``/proc/pressure``. The threshold represents
+      the difference in "total" pressure from the previous second. The
+      minimum value is 1.0 (extremely slow builds) and the maximum is
+      1000000 (a pressure value unlikely to ever be reached).
+
+   :term:`BB_PRESSURE_MAX_MEMORY`
+      Specifies a maximum memory pressure threshold, above which BitBake's
+      scheduler will not start new tasks (providing there is at least
+      one active task). If no value is set, memory pressure is not
+      monitored when starting tasks.
+
+      The pressure data is calculated based upon what (recent) Linux
+      kernels expose under ``/proc/pressure``. The threshold represents
+      the difference in "total" pressure from the previous second. The
+      minimum value is 1.0 (extremely slow builds) and the maximum is
+      1000000 (a pressure value unlikely to ever be reached).

documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 577

Quoted 10 lines
documentation/ref-manual/variables.rst +7 -0
+
+      Memory pressure is experienced when time is spent swapping,
+      refaulting pages from the page cache or performing direct reclaim.
+      This is why memory pressure is rarely seen, but setting this variable
+      might be useful as a last resort to prevent OOM errors if they are
+      occurring during builds.
+
     :term:`BB_SERVER_TIMEOUT`
        Specifies the time (in seconds) after which to unload the BitBake
        server due to inactivity. Set :term:`BB_SERVER_TIMEOUT` to determine how

Actually, these have recently been accepted in the BitBake manual (the patches from Aryaman got accepted after he left WindRiver), though apparently with fewer details:
https://git.openembedded.org/bitbake/commit/?id=c014281f72f4f54ec8e681ef2b8e1080de9ab5cf

Shall we submit your updates to the Bitbake manual instead? This way, we don't have these variables documented in two different places.

Cheers
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#21 lore raw

Re: [docs] [PATCH 13/34] ref-manual: add pressure limit variable documentation

Quoted 8 lines · On Tuesday, 11 October 2022 23:30:50 NZDT Michael Opdenacker via…

Actually, these have recently been accepted in the BitBake manual (the patches from Aryaman got accepted after he left WindRiver), though apparently with fewer details:
https://git.openembedded.org/bitbake/commit/?id=c014281f72f4f54ec8e681ef2b8e
1080de9ab5cf

Shall we submit your updates to the Bitbake manual instead? This way, we don't have these variables documented in two different places.

Ah, oops - I missed that. I'm OK with that for now; however, and I may have also missed if this has been discussed recently, but it's my opinion that all variables documented in the BitBake manual should also be in the Yocto reference manual, since they are two different contexts - the catch being that for some variables there is information you can't reasonably include in the bitbake manual since it relies on some definitions unique to OE so the entries can't always be copied exactly. If on the other hand some variables only appear in the BitBake manual, there will be people who just won't find them.

To avoid things getting out of sync, we could potentially have a script that would check for and report on variables present in the BitBake manual that aren't in the Yocto reference manual. I'd be happy to write such a script.

Cheers
Paul

#22 lore raw

Re: [docs] [PATCH 13/34] ref-manual: add pressure limit variable documentation

Hi Paul,

Quoted 10 lines · Paul Eggleton
Quoted 8 lines · On Tuesday, 11 October 2022 23:30:50 NZDT Michael Opdenacker via…

Actually, these have recently been accepted in the BitBake manual (the patches from Aryaman got accepted after he left WindRiver), though apparently with fewer details:
https://git.openembedded.org/bitbake/commit/?id=c014281f72f4f54ec8e681ef2b8e
1080de9ab5cf

Shall we submit your updates to the Bitbake manual instead? This way, we don't have these variables documented in two different places.

Quoted 8 lines

Ah, oops - I missed that. I'm OK with that for now; however, and I may have also missed if this has been discussed recently, but it's my opinion that all variables documented in the BitBake manual should also be in the Yocto reference manual, since they are two different contexts - the catch being that for some variables there is information you can't reasonably include in the bitbake manual since it relies on some definitions unique to OE so the entries can't always be copied exactly. If on the other hand some variables only appear in the BitBake manual, there will be people who just won't find them.

I agree that BitBake variables should all appear in the Yocto variable index.

There are already some variables which are initially documented in the BitBake manual and then the description is expanded in the Yocto manual according to the OE additions. SRC_URI is one of them:

* https://docs.yoctoproject.org/bitbake/2.0/bitbake-user-manual/bitbake-user-manual-ref-variables.html#term-SRC_URI
* https://docs.yoctoproject.org/ref-manual/variables.html#term-SRC_URI

Quoted 4 lines

To avoid things getting out of sync, we could potentially have a script that would check for and report on variables present in the BitBake manual that aren't in the Yocto reference manual. I'd be happy to write such a script.

This would be useful, but if I recall correctly, Quentin was rather thinking about having Sphinx include these from the BitBake manual, at least for the ones which are only defined in the BitBake manual.

Wouldn't it be better than duplicating content, which always causes trouble.

Any further thoughts?

Cheers
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#23 lore raw

Re: [docs] [PATCH 13/34] ref-manual: add pressure limit variable documentation

Hi all,

Quoted 22 lines · Michael Opdenacker via lists.yoctoproject.org

Hi Paul,

Quoted 9 lines · Paul Eggleton
Quoted 7 lines · On Tuesday, 11 October 2022 23:30:50 NZDT Michael Opdenacker via…

Actually, these have recently been accepted in the BitBake manual (the
patches from Aryaman got accepted after he left WindRiver), though
apparently with fewer details:
https://urldefense.proofpoint.com/v2/url?u=https-3A__git.openembedded.org_bitbake_commit_-3Fid-3Dc014281f72f4f54ec8e681ef2b8e&d=DwICaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=x6GN6XCgxQmI7f-H7T3WT3-Fm0BA5lJwsTI4AYj7vqNo4vO7FONFXbwhZxNDjOg5&s=w3C2EZQkLelO9mCiJE4ey-FVbNc3zA7PBHZ2nnBc4wE&e= 1080de9ab5cf

Shall we submit your updates to the Bitbake manual instead? This way, we don't have these variables documented in two different places.

Quoted 8 lines

Ah, oops - I missed that. I'm OK with that for now; however, and I may have also missed if this has been discussed recently, but it's my opinion that all variables documented in the BitBake manual should also be in the Yocto reference manual, since they are two different contexts - the catch being that for some variables there is information you can't reasonably include in the bitbake manual since it relies on some definitions unique to OE so the entries can't always be copied exactly. If on the other hand some variables only appear in the BitBake manual, there will be people who just won't find them.

Quoted 11 lines

I agree that BitBake variables should all appear in the Yocto variable index.

There are already some variables which are initially documented in the BitBake manual and then the description is expanded in the Yocto manual according to the OE additions. SRC_URI is one of them:

 *
https://urldefense.proofpoint.com/v2/url?u=https-3A__docs.yoctoproject.org_bitbake_2.0_bitbake-2Duser-2Dmanual_bitbake-2Duser-2Dmanual-2Dref-2Dvariables.html-23term-2DSRC-5FURI&d=DwICaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=x6GN6XCgxQmI7f-H7T3WT3-Fm0BA5lJwsTI4AYj7vqNo4vO7FONFXbwhZxNDjOg5&s=MUG2hR2Xp_pBuwrtNxNwKRKxCuWXh8fgIcmZm7k0cTw&e=  * https://urldefense.proofpoint.com/v2/url?u=https-3A__docs.yoctoproject.org_ref-2Dmanual_variables.html-23term-2DSRC-5FURI&d=DwICaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=x6GN6XCgxQmI7f-H7T3WT3-Fm0BA5lJwsTI4AYj7vqNo4vO7FONFXbwhZxNDjOg5&s=jTk77XY6-zxpJ_a9dWSexbLvlpev2lr2-QfhnWYv74E&e=

Quoted 4 lines

To avoid things getting out of sync, we could potentially have a script that would check for and report on variables present in the  BitBake manual that aren't in the Yocto reference manual. I'd be happy to write such a script.

This would be a good start, though...

Quoted 3 lines

This would be useful, but if I recall correctly, Quentin was rather thinking about having Sphinx include these from the BitBake manual, at least for the ones which are only defined in the BitBake manual.

I'd prefer having a Sphinx plugin that does this automatically (I haven't checked if this is actually possible).

But we can start with this script and manually adding those to the YP glossary. Someone may eventually find the time and motivation to look into a Sphinx plugin but I for sure don't have this time at the moment. sorry.

How do you think of implementing this? I had in mind to just add a variable in the glossary whose description would be:

See :term:BitBake documentation <bitbake:FOOVAR>

so we don't need to take care of keeping their description in sync,

Cheers,
Quentin

#24 lore raw

Re: [docs] [PATCH 13/34] ref-manual: add pressure limit variable documentation

Hi Quentin

Quoted 44 lines · Quentin Schulz

Hi all,

Quoted 22 lines · Michael Opdenacker via lists.yoctoproject.org

Hi Paul,

Quoted 9 lines · Paul Eggleton
Quoted 7 lines · On Tuesday, 11 October 2022 23:30:50 NZDT Michael Opdenacker via…

Actually, these have recently been accepted in the BitBake manual (the
patches from Aryaman got accepted after he left WindRiver), though
apparently with fewer details:
https://urldefense.proofpoint.com/v2/url?u=https-3A__git.openembedded.org_bitbake_commit_-3Fid-3Dc014281f72f4f54ec8e681ef2b8e&d=DwICaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=x6GN6XCgxQmI7f-H7T3WT3-Fm0BA5lJwsTI4AYj7vqNo4vO7FONFXbwhZxNDjOg5&s=w3C2EZQkLelO9mCiJE4ey-FVbNc3zA7PBHZ2nnBc4wE&e= 1080de9ab5cf

Shall we submit your updates to the Bitbake manual instead? This way, we don't have these variables documented in two different places.

Quoted 8 lines

Ah, oops - I missed that. I'm OK with that for now; however, and I may have also missed if this has been discussed recently, but it's my opinion that all variables documented in the BitBake manual should also be in the Yocto reference manual, since they are two different contexts - the catch being that for some variables there is information you can't reasonably include in the bitbake manual since it relies on some definitions unique to OE so the entries can't always be copied exactly. If on the other hand some variables only appear in the BitBake manual, there will be people who just won't find them.

Quoted 10 lines

I agree that BitBake variables should all appear in the Yocto variable index.

There are already some variables which are initially documented in the BitBake manual and then the description is expanded in the Yocto manual according to the OE additions. SRC_URI is one of them:

  * https://urldefense.proofpoint.com/v2/url?u=https-3A__docs.yoctoproject.org_bitbake_2.0_bitbake-2Duser-2Dmanual_bitbake-2Duser-2Dmanual-2Dref-2Dvariables.html-23term-2DSRC-5FURI&d=DwICaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=x6GN6XCgxQmI7f-H7T3WT3-Fm0BA5lJwsTI4AYj7vqNo4vO7FONFXbwhZxNDjOg5&s=MUG2hR2Xp_pBuwrtNxNwKRKxCuWXh8fgIcmZm7k0cTw&e=  * https://urldefense.proofpoint.com/v2/url?u=https-3A__docs.yoctoproject.org_ref-2Dmanual_variables.html-23term-2DSRC-5FURI&d=DwICaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=x6GN6XCgxQmI7f-H7T3WT3-Fm0BA5lJwsTI4AYj7vqNo4vO7FONFXbwhZxNDjOg5&s=jTk77XY6-zxpJ_a9dWSexbLvlpev2lr2-QfhnWYv74E&e=

Quoted 4 lines

To avoid things getting out of sync, we could potentially have a script that would check for and report on variables present in the BitBake manual that aren't in the Yocto reference manual. I'd be happy to write such a script.

This would be a good start, though...

Quoted 3 lines

This would be useful, but if I recall correctly, Quentin was rather thinking about having Sphinx include these from the BitBake manual, at least for the ones which are only defined in the BitBake manual.

I'd prefer having a Sphinx plugin that does this automatically (I haven't checked if this is actually possible).

Quoted 7 lines

But we can start with this script and manually adding those to the YP glossary. Someone may eventually find the time and motivation to look into a Sphinx plugin but I for sure don't have this time at the moment. sorry.

How do you think of implementing this? I had in mind to just add a variable in the glossary whose description would be:

See :term:BitBake documentation <bitbake:FOOVAR>

so we don't need to take care of keeping their description in sync,

Yes, this would be perfectly acceptable as a first solution IMHO, if nobody objects this redirection. Then Paul's script would definitely help (thanks in advance!). Cheers
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#25 lore raw

PATCH 14/34 ref-manual: add pypi class

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

Add missing documentation for the pypi class.

---
 documentation/ref-manual/classes.rst   | 14 ++++++++++++++
 documentation/ref-manual/variables.rst |  8 ++++++++
 2 files changed, 22 insertions(+)
documentation/ref-manual/classes.rst +14 -0
index d94db03..f6bbee5 100644
@@ -2005,6 +2005,20 @@ When inherited by a recipe, the ``perlnative`` class supports using the
 native version of Perl built by the build system rather than using the
 version provided by the build host.
 
+.. _ref-classes-pypi:
+
+``pypi.bbclass``
+================
+
+The ``pypi`` class sets variables appropriately for recipes that build
+Python modules from `PyPI <https://pypi.org/>`__, the Python Package Index.
+By default it determines the PyPI package name based upon BPN (stripping the
+"python-" or "python3-" prefix off if present), however in some cases you may
+need to set it manually in the recipe by setting :term:`PYPI_PACKAGE`.
+
+Variables set by the ``pypi`` class include :term:`SRC_URI`, :term:`SECTION`,
+:term:`HOMEPAGE`, :term:`UPSTREAM_CHECK_URI`, and :term:`UPSTREAM_CHECK_REGEX`.
+
 .. _ref-classes-python_flit_core:
 
 ``python_flit_core.bbclass``
documentation/ref-manual/variables.rst +8 -0
index e4304d1..ceb6b0e 100644
@@ -6219,6 +6219,14 @@ system and gives an overview of their function and contents.
 
       :term:`PV` is the default value of the :term:`PKGV` variable.
 
+   :term:`PYPI_PACKAGE`
+      When inheriting the :ref:`pypi <ref-classes-pypi>` class, specifies the
+      `PyPI <https://pypi.org/>`__ package name to be built. The default value
+      is set based upon :term:`BPN` (stripping any "python-" or "python3-"
+      prefix off if present), however for some packages it will need to be set
+      explicitly if that will not match the package name (e.g. where the
+      package name has a prefix, underscores, uppercase letters etc.)
+
    :term:`PYTHON_ABI`
       When used by recipes that inherit the
       :ref:`setuptools3 <ref-classes-setuptools3>` class, denotes the
Signature · 1 line
1.8.3.1

A message that is not in the archive (sent off-list or not yet received): [email protected]

#27 lore raw

Re: [docs] [PATCH 14/34] ref-manual: add pypi class

Quoted 10 lines · On Monday, 10 October 2022 23:23:03 NZDT Joshua Lock wrote:
Quoted 8 lines

+``pypi.bbclass``
+================

documentation/ref-manual/classes.rst +3 -0
+
+The ``pypi`` class sets variables appropriately for recipes that build
+Python modules from `PyPI < https://pypi.org/ >`__, the Python Package

Index.
+By default it determines the PyPI package name based upon BPN (stripping the

Nit: it would be nice to change BPN here to :term:BPN

Ah yes, well spotted. Fixed on the branch.

Thanks
Paul

#28 lore raw

PATCH 15/34 ref-manual: update pypi documentation for CVE_PRODUCT default in 4.1

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

In 4.1 the pypi class has been updated to set a default CVE_PRODUCT value.

---
 documentation/ref-manual/classes.rst   | 3 ++-
 documentation/ref-manual/variables.rst | 4 +++-
 2 files changed, 5 insertions(+), 2 deletions(-)
documentation/ref-manual/classes.rst +2 -1
index f6bbee5..3b5b4f2 100644
@@ -2017,7 +2017,8 @@ By default it determines the PyPI package name based upon BPN (stripping the
 need to set it manually in the recipe by setting :term:`PYPI_PACKAGE`.
 
 Variables set by the ``pypi`` class include :term:`SRC_URI`, :term:`SECTION`,
-:term:`HOMEPAGE`, :term:`UPSTREAM_CHECK_URI`, and :term:`UPSTREAM_CHECK_REGEX`.
+:term:`HOMEPAGE`, :term:`UPSTREAM_CHECK_URI`, :term:`UPSTREAM_CHECK_REGEX`
+and :term:`CVE_PRODUCT`.
 
 .. _ref-classes-python_flit_core:
 
documentation/ref-manual/variables.rst +3 -1
index ceb6b0e..885641a 100644
@@ -1516,7 +1516,9 @@ system and gives an overview of their function and contents.
       In a recipe, defines the name used to match the recipe name
       against the name in the upstream `NIST CVE database <https://nvd.nist.gov/>`__.
 
-      The default is ${:term:`BPN`}. If it does not match the name in the NIST CVE
+      The default is ${:term:`BPN`} (except for recipes that inherit the
+      :ref:`pypi <ref-classes-pypi>` class where it is set based upon
+      :term:`PYPI_PACKAGE`). If it does not match the name in the NIST CVE
       database or matches with multiple entries in the database, the default
       value needs to be changed.
 
Signature · 1 line
1.8.3.1
#29 lore raw

PATCH 16/34 ref-manual: add CVE_CHECK_SHOW_WARNINGS

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

New variable in 4.1.

---
 documentation/ref-manual/variables.rst | 7 +++++++
 1 file changed, 7 insertions(+)
documentation/ref-manual/variables.rst +7 -0
index 885641a..c226b92 100644
@@ -1508,6 +1508,13 @@ system and gives an overview of their function and contents.
          # This is windows only issue.
          CVE_CHECK_IGNORE += "CVE-2020-15523"
 
+   :term:`CVE_CHECK_SHOW_WARNINGS`
+      Specifies whether or not the :ref:`pypi <ref-classes-cve-check>` class
+      should generate warning messages on the console when unpatched CVEs
+      are found. The default is "1", but you may wish to set it to "0" if you
+      are already examining/processing the logs after the build has completed
+      and thus do not need the warning messages.
+
    :term:`CVE_CHECK_SKIP_RECIPE`
       The list of package names (:term:`PN`) for which
       CVEs (Common Vulnerabilities and Exposures) are ignored.
Signature · 1 line
1.8.3.1
#30 lore raw

RE: [docs] [PATCH 16/34] ref-manual: add CVE_CHECK_SHOW_WARNINGS

Quoted 25 lines

-----Original Message-----
From: [email protected] <[email protected]> On Behalf Of Paul Eggleton
Sent: den 10 oktober 2022 11:24
To: [email protected]
Subject: [docs] [PATCH 16/34] ref-manual: add CVE_CHECK_SHOW_WARNINGS

From: Paul Eggleton <[email protected]>

New variable in 4.1.

---
 documentation/ref-manual/variables.rst | 7 +++++++
 1 file changed, 7 insertions(+)
documentation/ref-manual/variables.rst +0 -0
index 885641a..c226b92 100644
@@ -1508,6 +1508,13 @@ system and gives an overview of their function and

contents.
# This is windows only issue.
CVE_CHECK_IGNORE += "CVE-2020-15523"

documentation/ref-manual/variables.rst system and gives an overview of their function and contents. · line 1512

Quoted 2 lines
documentation/ref-manual/variables.rst +2 -0
+   :term:`CVE_CHECK_SHOW_WARNINGS`
+      Specifies whether or not the :ref:`pypi <ref-classes-cve-check>` class

Change "pypi" to "cve-check".

Quoted 10 lines
documentation/ref-manual/variables.rst +5 -1
+      should generate warning messages on the console when unpatched CVEs
+      are found. The default is "1", but you may wish to set it to "0" if you
+      are already examining/processing the logs after the build has completed
+      and thus do not need the warning messages.
+
    :term:`CVE_CHECK_SKIP_RECIPE`
       The list of package names (:term:`PN`) for which
       CVEs (Common Vulnerabilities and Exposures) are ignored.
--

1.8.3.1

//Peter

#31 lore raw

Re: [docs] [PATCH 16/34] ref-manual: add CVE_CHECK_SHOW_WARNINGS

Quoted 5 lines · On Tuesday, 11 October 2022 02:55:17 NZDT Peter Kjellerstedt wrote:
Quoted 5 lines
documentation/ref-manual/variables.rst +0 -0
@@ -1508,6 +1508,13 @@ system and gives an overview of their function and

contents.

Quoted 8 lines
Quoted 6 lines

# This is windows only issue.
CVE_CHECK_IGNORE += "CVE-2020-15523"

documentation/ref-manual/variables.rst +2 -0
+   :term:`CVE_CHECK_SHOW_WARNINGS`
+      Specifies whether or not the :ref:`pypi <ref-classes-cve-check>`

class

Change "pypi" to "cve-check".

Oops - fixed on the branch.

Thanks
Paul

#32 lore raw

PATCH 17/34 ref-manual: add info on buildtools-make-tarball

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

This is not perfect, but at least covers the use case and the new tarball that we are providing. Note that the --make-only option to install-buildtools is a currently pending patch.

---
 documentation/ref-manual/system-requirements.rst | 26 +++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)
documentation/ref-manual/system-requirements.rst +25 -1
index 014c9a5..d6545d6 100644
@@ -222,8 +222,13 @@ resolve this by installing a ``buildtools-extended`` tarball that
 contains additional tools, the equivalent of the Debian/Ubuntu ``build-essential``
 package.
 
+For systems with a broken make version (e.g. make 4.2.1 without patches) but
+where the rest of the host tools are usable, you can use the ``buildtools-make``
+tarball instead.
+
 In the sections that follow, three different methods will be described for
-installing the ``buildtools`` or ``buildtools-extended`` toolset.
+installing the ``buildtools``, ``buildtools-extended`` or ``buildtools-make``
+toolset.
 
 Installing a Pre-Built ``buildtools`` Tarball with ``install-buildtools`` script
 --------------------------------------------------------------------------------
@@ -258,6 +263,13 @@ installer and automatically installs the tools for you:
       $ cd poky
       $ scripts/install-buildtools
 
+   Alternatively if your host development system has a broken ``make``
+   version such that you only need a known good version of ``make``,
+   you can use the ``--make-only`` option:
+
+      $ cd poky
+      $ scripts/install-buildtools --make-only
+
 2. Source the tools environment setup script by using a command like the
    following::
 
@@ -292,6 +304,10 @@ steps:
 
       $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh
 
+   An example for the make-only installer::
+
+      $ sh ~/Downloads/x86_64-buildtools-make-nativesdk-standalone-&DISTRO;.sh
+
    During execution, a prompt appears that allows you to choose the
    installation directory. For example, you could choose the following:
    ``/home/your-username/buildtools``
@@ -337,6 +353,10 @@ installer:
 
       $ bitbake buildtools-extended-tarball
 
+   or to build the make-only tarball::
+
+      $ bitbake buildtools-make-tarball
+
    .. note::
 
       The :term:`SDKMACHINE` variable in your ``local.conf`` file determines
@@ -360,6 +380,10 @@ installer:
 
       $ sh ~/Downloads/x86_64-buildtools-extended-nativesdk-standalone-&DISTRO;.sh
 
+   or for the make-only installer::
+
+      $ sh ~/Downloads/x86_64-buildtools-make-nativesdk-standalone-&DISTRO;.sh
+
    During execution, a prompt appears that allows you to choose the
    installation directory. For example, you could choose the following:
    ``/home/your_username/buildtools``
Signature · 1 line
1.8.3.1
#33 lore raw

Re: [docs] [PATCH 17/34] ref-manual: add info on buildtools-make-tarball

Quoted 7 lines · Paul Eggleton

From: Paul Eggleton <[email protected]>

This is not perfect, but at least covers the use case and the new tarball that we are providing. Note that the --make-only option to install-buildtools is a currently pending patch.

I'm also holding this patch, and will update the commit message when your patch to OE-core has been accepted.

Thanks!
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com
#34 lore raw

PATCH 18/34 ref-manual: add FIT_PAD_ALG

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

New variable in 4.1.

---
 documentation/ref-manual/variables.rst | 4 ++++
 1 file changed, 4 insertions(+)
documentation/ref-manual/variables.rst +4 -0
index c226b92..3848d86 100644
@@ -2755,6 +2755,10 @@ system and gives an overview of their function and contents.
       Specifies the signature algorithm used in creating the FIT Image.
       For e.g. rsa2048.
 
+   :term:`FIT_PAD_ALG`
+      Specifies the padding algorithm used in creating the FIT Image.
+      The default value is "pkcs-1.5".
+
    :term:`FIT_SIGN_INDIVIDUAL`
       If set to "1", then the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>`
       class will sign the kernel, dtb and ramdisk images individually in addition
Signature · 1 line
1.8.3.1
#35 lore raw

PATCH 19/34 ref-manual: add CVE_DB_UPDATE_INTERVAL

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

New variable in 4.1.

---
 documentation/ref-manual/variables.rst | 7 +++++++
 1 file changed, 7 insertions(+)
documentation/ref-manual/variables.rst +7 -0
index 3848d86..124eb59 100644
@@ -1519,6 +1519,13 @@ system and gives an overview of their function and contents.
       The list of package names (:term:`PN`) for which
       CVEs (Common Vulnerabilities and Exposures) are ignored.
 
+   :term:`CVE_DB_UPDATE_INTERVAL`
+      Specifies the CVE database update interval in seconds, as used by
+      ``cve-update-db-native``. The default value is "86400" i.e. once a day
+      (24*60*60). If the value is set to "0" then the update will be forced
+      every time. Alternatively, a negative value e.g. "-1" will disable
+      updates entirely.
+
    :term:`CVE_PRODUCT`
       In a recipe, defines the name used to match the recipe name
       against the name in the upstream `NIST CVE database <https://nvd.nist.gov/>`__.
Signature · 1 line
1.8.3.1
#36 lore raw

PATCH 20/34 ref-manual: add KERNEL_DEPLOY_DEPEND

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

New variable in 4.1.

---
 documentation/ref-manual/variables.rst | 6 ++++++
 1 file changed, 6 insertions(+)
documentation/ref-manual/variables.rst +6 -0
index 124eb59..d5038e5 100644
@@ -4141,6 +4141,12 @@ system and gives an overview of their function and contents.
       the kernel. The default is "0" to disable this for reproducibility
       reasons.
 
+   :term:`KERNEL_DEPLOY_DEPEND`
+      Provides a means of controlling the dependency of an image recipe
+      on the kernel. The default value is "virtual/kernel:do_deploy",
+      however for a small initramfs image or other images that do not
+      need the kernel, this can be set to "" in the image recipe.
+
    :term:`KERNEL_DEVICETREE`
       Specifies the name of the generated Linux kernel device tree (i.e.
       the ``.dtb``) file.
Signature · 1 line
1.8.3.1
#37 lore raw

PATCH 21/34 ref-manual: add MOUNT_BASE variable

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

New variable for 4.1.

---
 documentation/ref-manual/variables.rst | 5 +++++
 1 file changed, 5 insertions(+)
documentation/ref-manual/variables.rst +5 -0
index d5038e5..7c4a3dc 100644
@@ -5043,6 +5043,11 @@ system and gives an overview of their function and contents.
 
          KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
 
+   :term:`MOUNT_BASE`
+      On non-systemd systems (where ``udev-extraconf`` is being used),
+      specifies the base directory for auto-mounting filesystems. The
+      default value is "/run/media".
+
    :term:`MULTIMACH_TARGET_SYS`
       Uniquely identifies the type of the target system for which packages
       are being built. This variable allows output for different types of
Signature · 1 line
1.8.3.1
#38 lore raw

PATCH 22/34 ref-manual: remove reference to testimage-auto class

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

testimage-auto was removed in the thud release.

---
 documentation/dev-manual/common-tasks.rst        |  4 ++--
 documentation/migration-guides/migration-1.5.rst |  2 +-
 documentation/migration-guides/migration-2.6.rst |  2 +-
 documentation/overview-manual/concepts.rst       |  2 +-
 documentation/ref-manual/classes.rst             | 17 +++++++++--------
 documentation/ref-manual/release-process.rst     |  2 +-
 documentation/ref-manual/variables.rst           |  2 +-
 documentation/test-manual/intro.rst              |  4 ++--
 8 files changed, 18 insertions(+), 17 deletions(-)
documentation/dev-manual/common-tasks.rst +2 -2
index a4741c5..68ce2b8 100644
@@ -3048,7 +3048,7 @@ The following steps describe how to set up the AUH utility:
       your build directory.
 
    -  If you want to enable testing through the
-      :ref:`testimage <ref-classes-testimage*>`
+      :ref:`testimage <ref-classes-testimage>`
       class, which is optional, you need to have the following set in
       your ``conf/local.conf`` file::
 
@@ -8893,7 +8893,7 @@ You can start the tests automatically or manually:
 
 -  *Manually running tests:* To manually run the tests, first globally
    inherit the
-   :ref:`testimage <ref-classes-testimage*>` class
+   :ref:`testimage <ref-classes-testimage>` class
    by editing your ``local.conf`` file::
 
       INHERIT += "testimage"
documentation/migration-guides/migration-1.5.rst +1 -1
index 366fb00..1b78e99 100644
@@ -240,7 +240,7 @@ Automated Image Testing
 -----------------------
 
 A new automated image testing framework has been added through the
-:ref:`ref-classes-testimage*` classes. This
+:ref:`ref-classes-testimage` classes. This
 framework replaces the older ``imagetest-qemu`` framework.
 
 You can learn more about performing automated image tests in the
documentation/migration-guides/migration-2.6.rst +1 -1
index 32bb48b..b36eb19 100644
@@ -319,7 +319,7 @@ This section provides information about automatic testing changes:
    practices now dictate that you use the
    :term:`IMAGE_CLASSES` variable rather than the
    :term:`INHERIT` variable when you inherit the
-   :ref:`testimage <ref-classes-testimage*>` and
+   :ref:`testimage <ref-classes-testimage>` and
    :ref:`testsdk <ref-classes-testsdk>` classes used for automatic
    testing.
 
documentation/overview-manual/concepts.rst +1 -1
index 39b8713..35d6feb 100644
@@ -1014,7 +1014,7 @@ processing includes creation of a manifest file and optimizations.
 The manifest file (``.manifest``) resides in the same directory as the
 root filesystem image. This file lists out, line-by-line, the installed
 packages. The manifest file is useful for the
-:ref:`testimage <ref-classes-testimage*>` class,
+:ref:`testimage <ref-classes-testimage>` class,
 for example, to determine whether or not to run specific tests. See the
 :term:`IMAGE_MANIFEST`
 variable for additional information.
documentation/ref-manual/classes.rst +9 -8
index 3b5b4f2..0a83d04 100644
@@ -2767,12 +2767,12 @@ session needs to be started. For example, the
 :ref:`devshell <ref-classes-devshell>` class all use the ``terminal``
 class.
 
-.. _ref-classes-testimage*:
+.. _ref-classes-testimage:
 
-``testimage*.bbclass``
-======================
+``testimage.bbclass``
+=====================
 
-The ``testimage*`` classes support running automated tests against
+The ``testimage`` class supports running automated tests against
 images using QEMU and on actual hardware. The classes handle loading the
 tests and starting the image. To use the classes, you need to perform
 steps to set up the environment.
@@ -2786,14 +2786,15 @@ steps to set up the environment.
 The tests are commands that run on the target system over ``ssh``. Each
 test is written in Python and makes use of the ``unittest`` module.
 
-The ``testimage.bbclass`` runs tests on an image when called using the
+The ``testimage`` class runs tests on an image when called using the
 following::
 
    $ bitbake -c testimage image
 
-The ``testimage-auto`` class
-runs tests on an image after the image is constructed (i.e.
-:term:`TESTIMAGE_AUTO` must be set to "1").
+Alternatively, if you wish to have tests automatically run for each image
+after it is built, you can set :term:`TESTIMAGE_AUTO`::
+
+   TESTIMAGE_AUTO = "1"
 
 For information on how to enable, run, and create new tests, see the
 ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
documentation/ref-manual/release-process.rst +1 -1
index 8acb4b8..c36fa55 100644
@@ -127,7 +127,7 @@ consists of the following pieces:
    an ARM target, did the build produce ARM binaries. If, for example,
    the build produced PPC binaries then there is a problem.
 
--  :ref:`ref-classes-testimage*`: This class
+-  :ref:`ref-classes-testimage`: This class
    performs runtime testing of images after they are built. The tests
    are usually used with :doc:`QEMU </dev-manual/qemu>`
    to boot the images and check the combined runtime result boot
documentation/ref-manual/variables.rst +1 -1
index 7c4a3dc..ec2e326 100644
@@ -8342,7 +8342,7 @@ system and gives an overview of their function and contents.
       on enabling, running, and writing these tests, see the
       ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
       section in the Yocto Project Development Tasks Manual and the
-      ":ref:`ref-classes-testimage*`" section.
+      ":ref:`ref-classes-testimage`" section.
 
    :term:`THISDIR`
       The directory in which the file BitBake is currently parsing is
documentation/test-manual/intro.rst +2 -2
index 6421dd5..36958d0 100644
@@ -132,8 +132,8 @@ the following types of tests:
 
       $ bitbake image -c testimage
 
-   The tests utilize the :ref:`testimage* <ref-classes-testimage*>`
-   classes and the :ref:`ref-tasks-testimage` task.
+   The tests utilize the :ref:`testimage <ref-classes-testimage>`
+   class and the :ref:`ref-tasks-testimage` task.
 
 -  *Layer Testing:* The Autobuilder has the possibility to test whether
    specific layers work with the test of the system. The layers tested
Signature · 1 line
1.8.3.1
#39 lore raw

PATCH 23/34 Update documentation for classes split

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

* Make reference to meta/classes* instead of just meta/classes
* Update each reference to the path where the class has moved
* Add a brief explanation to the classes reference explaining the split
* Add a note to INHERIT, INHERIT_DISTRO, IMAGE_CLASSES and USER_CLASSES variable glossary entries mentioning where the specified classes must be located. I contemplated adding the same note to PACKAGE_CLASSES but decided against it, as it has a very specific usage and such a note might distract from the narrative of that entry.
* Also trim the IMAGE_CLASSES entry which was quite outdated.
* INHERIT += no longer works with testimage so drop the note about that

---
 documentation/dev-manual/common-tasks.rst  |  4 +-
 documentation/overview-manual/concepts.rst |  4 +-
 documentation/ref-manual/classes.rst       | 20 ++++++----
 documentation/ref-manual/faq.rst           |  2 +-
 documentation/ref-manual/structure.rst     |  6 +--
 documentation/ref-manual/tasks.rst         |  4 +-
 documentation/ref-manual/variables.rst     | 59 ++++++++++++++++--------------
 7 files changed, 53 insertions(+), 46 deletions(-)
documentation/dev-manual/common-tasks.rst +2 -2
index 68ce2b8..0d4e814 100644
@@ -973,7 +973,7 @@ a recipe and using :term:`EXTRA_IMAGE_FEATURES` from within your
 :term:`Build Directory`.
 
 To understand how these features work, the best reference is
-:ref:`meta/classes/image.bbclass <ref-classes-image>`.
+:ref:`meta/classes-recipe/image.bbclass <ref-classes-image>`.
 This class lists out the available
 :term:`IMAGE_FEATURES` of which most map to package groups while some, such
 as ``debug-tweaks`` and ``read-only-rootfs``, resolve as general
@@ -6889,7 +6889,7 @@ multiple times if you have more than one set of modules to package.
 For more examples that show how to use ``do_split_packages``, see the
 ``connman.inc`` file in the ``meta/recipes-connectivity/connman/``
 directory of the ``poky`` :ref:`source repository <overview-manual/development-environment:yocto project source repositories>`. You can
-also find examples in ``meta/classes/kernel.bbclass``.
+also find examples in ``meta/classes-recipe/kernel.bbclass``.
 
 Following is a reference that shows ``do_split_packages`` mandatory and
 optional arguments::
documentation/overview-manual/concepts.rst +2 -2
index 35d6feb..a978e2c 100644
@@ -853,7 +853,7 @@ This step in the build process consists of the following tasks:
    variables. For information on how this variable works within that
    class, see the
    :ref:`autotools <ref-classes-autotools>` class
-   :yocto_git:`here </poky/tree/meta/classes/autotools.bbclass>`.
+   :yocto_git:`here </poky/tree/meta/classes-recipe/autotools.bbclass>`.
 
 -  *do_compile*: Once a configuration task has been satisfied,
    BitBake compiles the source using the
@@ -931,7 +931,7 @@ The :term:`FILES` variable defines the
 files that go into each package in
 :term:`PACKAGES`. If you want
 details on how this is accomplished, you can look at
-:yocto_git:`package.bbclass </poky/tree/meta/classes/package.bbclass>`.
+:yocto_git:`package.bbclass </poky/tree/meta/classes-global/package.bbclass>`.
 
 Depending on the type of packages being created (RPM, DEB, or IPK), the
 :ref:`do_package_write_* <ref-tasks-package_write_deb>`
documentation/ref-manual/classes.rst +12 -8
index 0a83d04..652c2f3 100644
@@ -13,8 +13,14 @@ some default behavior.
 
 Any :term:`Metadata` usually found in a recipe can also be
 placed in a class file. Class files are identified by the extension
-``.bbclass`` and are usually placed in a ``classes/`` directory beneath
-the ``meta*/`` directory found in the :term:`Source Directory`.
+``.bbclass`` and are usually placed in one of a set of subdirectories
+beneath the ``meta*/`` directory found in the :term:`Source Directory`:
+
+  - ``classes-recipe/`` - classes intended to be inherited by recipes
+    individually
+  - ``classes-global/`` - classes intended to be inherited globally
+  - ``classes/`` - classes whose usage context is not clearly defined
+
 Class files can also be pointed to by
 :term:`BUILDDIR` (e.g. ``build/``) in the same way as
 ``.conf`` files in the ``conf`` directory. Class files are searched for
@@ -22,7 +28,7 @@ in :term:`BBPATH` using the same method by which ``.conf``
 files are searched.
 
 This chapter discusses only the most useful and important classes. Other
-classes do exist within the ``meta/classes`` directory in the Source
+classes do exist within the ``meta/classes*`` directories in the Source
 Directory. You can reference the ``.bbclass`` files directly for more
 information.
 
@@ -2777,11 +2783,9 @@ images using QEMU and on actual hardware. The classes handle loading the
 tests and starting the image. To use the classes, you need to perform
 steps to set up the environment.
 
-.. note::
+To enable this class, add the following to your configuration::
 
-   Best practices include using :term:`IMAGE_CLASSES` rather than
-   :term:`INHERIT` to inherit the ``testimage`` class for automated image
-   testing.
+   IMAGE_CLASSES += "testimage"
 
 The tests are commands that run on the target system over ``ssh``. Each
 test is written in Python and makes use of the ``unittest`` module.
@@ -2936,7 +2940,7 @@ To use this class, you need to define a number of variables:
 These variables list alternative commands needed by a package, provide
 pathnames for links, default links for targets, and so forth. For
 details on how to use this class, see the comments in the
-:yocto_git:`update-alternatives.bbclass </poky/tree/meta/classes/update-alternatives.bbclass>`
+:yocto_git:`update-alternatives.bbclass </poky/tree/meta/classes-recipe/update-alternatives.bbclass>`
 file.
 
 .. note::
documentation/ref-manual/faq.rst +1 -1
index af49d57..84affdd 100644
@@ -109,7 +109,7 @@ I prevent this?
 but make sure the package is manually marked as machine-specific for the
 case that needs it. The code that handles
 :term:`SRC_URI_OVERRIDES_PACKAGE_ARCH` is in the
-``meta/classes/base.bbclass`` file.
+``meta/classes-global/base.bbclass`` file.
 
 **Q:** I'm behind a firewall and need to use a proxy server. How do I do
 that?
documentation/ref-manual/structure.rst +3 -3
index 533745b..fe27d17 100644
@@ -669,10 +669,10 @@ Yocto Project. Metadata has several important subdivisions:
 
 .. _structure-meta-classes:
 
-``meta/classes/``
------------------
+``meta/classes*/``
+------------------
 
-This directory contains the ``*.bbclass`` files. Class files are used to
+These directories contain the ``*.bbclass`` files. Class files are used to
 abstract common code so it can be reused by multiple packages. Every
 package inherits the :ref:`ref-classes-base` file. Examples of other important
 classes are :ref:`ref-classes-autotools`, which in theory allows any
documentation/ref-manual/tasks.rst +2 -2
index d4408d1..b17c09c 100644
@@ -190,8 +190,8 @@ that either directly or indirectly depend on the installed files (e.g.
    -  The ``cp`` command with the ``--no-preserve=ownership`` option.
 
    -  The ``tar`` command with the ``--no-same-owner`` option. See the
-      ``bin_package.bbclass`` file in the ``meta/classes`` directory of
-      the :term:`Source Directory` for an example.
+      ``bin_package.bbclass`` file in the ``meta/classes-recipe``
+      subdirectory of the :term:`Source Directory` for an example.
 
 .. _ref-tasks-install_ptest_base:
 
documentation/ref-manual/variables.rst +31 -28

198 lines not on this page · raw message

Signature · 1 line
1.8.3.1
#40 lore raw

PATCH 24/34 ref-manual: complementary package installation recommends

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

Add a note to the COMPLEMENTARY_GLOB variable glossary entry mentioning that recommends aren't installed (since this seems to be the only place that complementary package installation is really discussed). Also turn the paragraph about globbing into a regular paragraph as I don't think it should be called out in a note block.

---
 documentation/ref-manual/variables.rst | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)
documentation/ref-manual/variables.rst +9 -6
index c2e75d0..ade7c03 100644
@@ -1213,12 +1213,10 @@ system and gives an overview of their function and contents.
       packages for all the packages explicitly (or implicitly) installed in
       an image.
 
-      .. note::
-
-         The :term:`COMPLEMENTARY_GLOB` variable uses Unix filename pattern matching
-         (`fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__),
-         which is similar to the Unix style pathname pattern expansion
-         (`glob <https://docs.python.org/3/library/glob.html>`__).
+      The :term:`COMPLEMENTARY_GLOB` variable uses Unix filename pattern matching
+      (`fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`__),
+      which is similar to the Unix style pathname pattern expansion
+      (`glob <https://docs.python.org/3/library/glob.html>`__).
 
       The resulting list of complementary packages is associated with an
       item that can be added to
@@ -1233,6 +1231,11 @@ system and gives an overview of their function and contents.
 
          COMPLEMENTARY_GLOB[dev-pkgs] = '*-dev'
 
+      .. note::
+
+         When installing complementary packages, recommends relationships
+         (set via :term:`RRECOMMENDS`) are always ignored.
+
    :term:`COMPONENTS_DIR`
       Stores sysroot components for each recipe. The OpenEmbedded build
       system uses :term:`COMPONENTS_DIR` when constructing recipe-specific
Signature · 1 line
1.8.3.1
#41 lore raw

PATCH 25/34 ref-manual: remove reference to largefile in DISTRO_FEATURES

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

This no longer does anything in 4.1.

---
 documentation/ref-manual/features.rst | 3 ---
 1 file changed, 3 deletions(-)
documentation/ref-manual/features.rst +0 -3
index 9dc73db..dad871d 100644
@@ -152,9 +152,6 @@ metadata, as extra layers can define their own:
 -  *keyboard:* Include keyboard support (e.g. keymaps will be loaded
    during boot).
 
--  *largefile:* Enable building applications with
-   `argefile support <https://en.wikipedia.org/wiki/Large-file_support>`__.
-
 -  *multiarch:* Enable building applications with multiple architecture
    support.
 
Signature · 1 line
1.8.3.1
#42 lore raw

PATCH 26/34 ref-manual: add missing features

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

Add missing IMAGE_FEATURES, DISTRO_FEATURES and MACHINE_FEATURES items. Additionally, add a note that DISTRO_FEATURES doesn't have any impact on the kernel configuration so that users are aware they have to take care of that as well. (I thought the same was true of MACHINE_FEATURES, but it seems we have a couple of isolated cases where that will adjust the kernel configuration - few enough that I suspect they might have slipped in and thus probably shouldn't be documented yet.)

---
 documentation/ref-manual/features.rst | 50 +++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
documentation/ref-manual/features.rst +50 -0
index dad871d..ea4d257 100644
@@ -72,6 +72,8 @@ Project metadata:
 
 -  *phone:* Mobile phone (voice) support
 
+-  *qemu-usermode:* QEMU can support user-mode emulation for this machine
+
 -  *qvga:* Machine has a QVGA (320x240) display
 
 -  *rtc:* Machine has a Real-Time Clock
@@ -112,6 +114,13 @@ configuration level. See the
 :term:`COMBINED_FEATURES` variable for more
 information.
 
+.. note::
+
+   :term:`DISTRO_FEATURES` is normally independent of kernel configuration,
+   so if a feature specified in :term:`DISTRO_FEATURES` also relies on
+   support in the kernel, you will also need to ensure that support is
+   enabled in the kernel configuration.
+
 This list only represents features as shipped with the Yocto Project
 metadata, as extra layers can define their own:
 
@@ -143,6 +152,9 @@ metadata, as extra layers can define their own:
 -  *ext2:* Include tools for supporting for devices with internal
    HDD/Microdrive for storing files (instead of Flash only devices).
 
+-  *gobject-introspection-data:* Include data to support
+   `GObject Introspection <https://gi.readthedocs.io/en/latest/>`__.
+
 -  *ipsec:* Include IPSec support.
 
 -  *ipv4:* Include IPv4 support.
@@ -155,23 +167,38 @@ metadata, as extra layers can define their own:
 -  *multiarch:* Enable building applications with multiple architecture
    support.
 
+-  *ld-is-gold:* Use the `gold <https://en.wikipedia.org/wiki/Gold_(linker)>`__
+   linker instead of the standard GCC linker (bfd).
+
 -  *ldconfig:* Include support for ldconfig and ``ld.so.conf`` on the
    target.
 
+-  *lto:* Enable `Link-Time Optimisation <https://gcc.gnu.org/wiki/LinkTimeOptimization>`__.
+
 -  *nfc:* Include support for
    `Near Field Communication <https://en.wikipedia.org/wiki/Near-field_communication>`__.
 
 -  *nfs:* Include NFS client support (for mounting NFS exports on
    device).
 
+-  *nls:* Include National Language Support (NLS).
+
 -  *opengl:* Include the Open Graphics Library, which is a
    cross-language, multi-platform application programming interface used
    for rendering two and three-dimensional graphics.
 
+-  *overlayfs:* Include `OverlayFS <https://docs.kernel.org/filesystems/overlayfs.html>`__
+   support.
+
+-  *pam:* Include `Pluggable Authentication Module (PAM) <https://en.wikipedia.org/wiki/Pluggable_authentication_module>`__
+   support.
+
 -  *pci:* Include PCI bus support.
 
 -  *pcmcia:* Include PCMCIA/CompactFlash support.
 
+-  *polkit:* Include `Polkit <https://en.wikipedia.org/wiki/Polkit>`__ support.
+
 -  *ppp:* Include PPP dialup support.
 
 -  *ptest:* Enables building the package tests where supported by
@@ -179,6 +206,13 @@ metadata, as extra layers can define their own:
    ":ref:`dev-manual/common-tasks:testing packages with ptest`" section
    in the Yocto Project Development Tasks Manual.
 
+-  *pulseaudio:* Include support for
+   `PulseAudio <https://www.freedesktop.org/wiki/Software/PulseAudio/>`__.
+
+-  *selinux:* Include support for
+   `Security-Enhanced Linux (SELinux) <https://en.wikipedia.org/wiki/Security-Enhanced_Linux>`__
+   (requires `meta-selinux <https://layers.openembedded.org/layerindex/layer/meta-selinux/>`__).
+
 -  *seccomp:* Enables building applications with
    `seccomp <https://en.wikipedia.org/wiki/Seccomp>`__ support, to
    allow them to strictly restrict the system calls that they are allowed
@@ -270,6 +304,9 @@ Here are the image features available for all images:
        just disables the mechanism which forces an non-empty password for the
        root user.
 
+-  *lic-pkgs:* Installs license packages for all packages installed in a
+   given image.
+
 -  *overlayfs-etc:* Configures the ``/etc`` directory to be in ``overlayfs``.
    This allows to store device specific information elsewhere, especially
    if the root filesystem is configured to be read-only.
@@ -294,6 +331,12 @@ Here are the image features available for all images:
    section in the Yocto Project Development Tasks Manual for more
    information.
 
+-  *read-only-rootfs-delayed-postinsts:* when specified in conjunction
+   with ``read-only-rootfs``, specifies that post-install scripts are
+   still permitted (this assumes that the root filesystem will be made
+   writeable for the first boot; this feature does not do anything to
+   ensure that - it just disables the check for post-install scripts.)
+
 -  *splash:* Enables showing a splash screen during boot. By default,
    this screen is provided by ``psplash``, which does allow
    customization. If you prefer to use an alternative splash screen
@@ -301,6 +344,11 @@ Here are the image features available for all images:
    different package name (or names) within the image recipe or at the
    distro configuration level.
 
+-  *stateless-rootfs:*: specifies that the image should be created as
+   stateless - when using ``systemd``, ``systemctl-native`` will not
+   be run on the image, leaving the image for population at runtime by
+   systemd.
+
 -  *staticdev-pkgs:* Installs static development packages, which are
    static libraries (i.e. ``*.a`` files), for all packages installed in
    a given image.
@@ -351,6 +399,8 @@ these valid features is as follows:
 -  *tools-testapps:* Installs device testing tools (e.g. touchscreen
    debugging).
 
+-  *weston:* Installs Weston (reference Wayland environment).
+
 -  *x11:* Installs the X server.
 
 -  *x11-base:* Installs the X server with a minimal environment.
Signature · 1 line
1.8.3.1
#43 lore raw

PATCH 27/34 ref-manual: add serial-autologin-root to IMAGE_FEATURES documentation

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

New IMAGE_FEATURES item in 4.1.

---
 documentation/ref-manual/features.rst | 6 ++++++
 1 file changed, 6 insertions(+)
documentation/ref-manual/features.rst +6 -0
index ea4d257..a5b01e8 100644
@@ -337,6 +337,12 @@ Here are the image features available for all images:
    writeable for the first boot; this feature does not do anything to
    ensure that - it just disables the check for post-install scripts.)
 
+-  *serial-autologin-root:* when specified in conjunction with
+   ``empty-root-password`` will automatically login as root on the
+   serial console. This of course opens up a security hole if the
+   serial console is potentially accessible to an attacker, so use
+   with caution.
+
 -  *splash:* Enables showing a splash screen during boot. By default,
    this screen is provided by ``psplash``, which does allow
    customization. If you prefer to use an alternative splash screen
Signature · 1 line
1.8.3.1
#44 lore raw

PATCH 28/34 ref-manual: add previous overlayfs-etc variables

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

These were supported in releases prior to 4.1.

---
 documentation/ref-manual/variables.rst | 38 ++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
documentation/ref-manual/variables.rst +38 -0
index ade7c03..9c510b8 100644
@@ -5229,6 +5229,44 @@ system and gives an overview of their function and contents.
       default by setting the variable in a custom distribution
       configuration file.
 
+   :term:`OVERLAYFS_ETC_DEVICE`
+      When the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` class is
+      inherited, specifies the device to be mounted for the read/write
+      layer of ``/etc``. There is no default, so you must set this if you
+      wish to enable :ref:`overlayfs-etc <ref-classes-overlayfs-etc>`, for
+      example, assuming ``/dev/mmcblk0p2`` was the desired device::
+
+         OVERLAYFS_ETC_DEVICE = "/dev/mmcblk0p2"
+
+   :term:`OVERLAYFS_ETC_FSTYPE`
+      When the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` class is
+      inherited, specifies the file system type for the read/write
+      layer of ``/etc``. There is no default, so you must set this if you
+      wish to enable :ref:`overlayfs-etc <ref-classes-overlayfs-etc>`,
+      for example, assuming the file system is ext4::
+
+         OVERLAYFS_ETC_FSTYPE = "ext4"
+
+   :term:`OVERLAYFS_ETC_MOUNT_OPTIONS`
+      When the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` class is
+      inherited, specifies the mount options for the read-write layer.
+      The default value is "defaults".
+
+   :term:`OVERLAYFS_ETC_MOUNT_POINT`
+      When the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` class is
+      inherited, specifies the parent mount path for the filesystem layers.
+      There is no default, so you must set this if you wish to enable
+      :ref:`overlayfs-etc <ref-classes-overlayfs-etc>`, for example if
+      the desired path is "/data"::
+
+         OVERLAYFS_ETC_MOUNT_POINT = "/data"
+
+   :term:`OVERLAYFS_ETC_USE_ORIG_INIT_NAME`
+      When the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` class is
+      inherited, controls how the generated init will be named. For more
+      information, see the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>`
+      class documentation. The default value is "1".
+
    :term:`OVERRIDES`
       A colon-separated list of overrides that currently apply. Overrides
       are a BitBake mechanism that allows variables to be selectively
Signature · 1 line
1.8.3.1
#45 lore raw

PATCH 29/34 ref-manual: add OVERLAYFS_ETC_EXPOSE_LOWER

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

New variable in 4.1.

---
 documentation/ref-manual/variables.rst | 6 ++++++
 1 file changed, 6 insertions(+)
documentation/ref-manual/variables.rst +6 -0
index 9c510b8..503926b 100644
@@ -5238,6 +5238,12 @@ system and gives an overview of their function and contents.
 
          OVERLAYFS_ETC_DEVICE = "/dev/mmcblk0p2"
 
+   :term:`OVERLAYFS_ETC_EXPOSE_LOWER`
+      When the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` class is
+      inherited, if set to "1" then a read-only access to the original
+      ``/etc`` content will be provided as a ``lower/`` subdirectory of
+      :term:`OVERLAYFS_ETC_MOUNT_POINT`. The default value is "0".
+
    :term:`OVERLAYFS_ETC_FSTYPE`
       When the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` class is
       inherited, specifies the file system type for the read/write
Signature · 1 line
1.8.3.1
#46 lore raw

PATCH 30/34 ref-manual: add WIRELESS_DAEMON

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

Not new in 4.1, but the syntax and usage in packagegroup-base is.

---
 documentation/ref-manual/variables.rst | 5 +++++
 1 file changed, 5 insertions(+)
documentation/ref-manual/variables.rst +5 -0
index 503926b..a14288e 100644
@@ -9027,6 +9027,11 @@ system and gives an overview of their function and contents.
       Specifies the timeout in seconds used by the ``watchdog`` recipe and
       also by ``systemd`` during reboot. The default is 60 seconds.
 
+   :term:`WIRELESS_DAEMON`
+      For ``connman`` and ``packagegroup-base``, specifies the wireless
+      daemon to use. The default is "wpa-supplicant" (note that the value
+      uses a dash and not an underscore).
+
    :term:`WKS_FILE`
       Specifies the location of the Wic kickstart file that is used by the
       OpenEmbedded build system to create a partitioned image
Signature · 1 line
1.8.3.1
#47 lore raw

PATCH 31/34 ref-manual: add section for create-spdx class

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

create-spdx was added in the honister release. This is a stub since I unfortunately don't have time to fully document this class and related variables, hopefully someone else can expand it in future.

---
 documentation/ref-manual/classes.rst | 8 ++++++++
 1 file changed, 8 insertions(+)
documentation/ref-manual/classes.rst +8 -0
index 652c2f3..dad78ef 100644
@@ -368,6 +368,14 @@ authors used.
 Both build methods inherit the ``cpan-base`` class for basic Perl
 support.
 
+.. _ref-classes-create-spdx:
+
+``create-spdx.bbclass``
+=======================
+
+The ``create-spdx`` class provides support for automatically creating
+SPDX SBoM documents based upon image and SDK contents.
+
 .. _ref-classes-cross:
 
 ``cross.bbclass``
Signature · 1 line
1.8.3.1
#48 lore raw

PATCH 32/34 ref-manual: add overlayfs class variables

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

The overlayfs class was added in the honister release.

---
 documentation/ref-manual/variables.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
documentation/ref-manual/variables.rst +24 -0
index a14288e..00d51e5 100644
@@ -5273,6 +5273,30 @@ system and gives an overview of their function and contents.
       information, see the :ref:`overlayfs-etc <ref-classes-overlayfs-etc>`
       class documentation. The default value is "1".
 
+   :term:`OVERLAYFS_MOUNT_POINT`
+      When inheriting the :ref:`overlayfs <ref-classes-overlayfs>` class,
+      specifies mount point(s) to be used. For example::
+
+         OVERLAYFS_MOUNT_POINT[data] = "/data"
+
+      The assumes you have a ``data.mount`` systemd unit defined elsewhere
+      in your BSP (e.g. in ``systemd-machine-units`` recipe) and it is
+      installed into the image. For more information see
+      :ref:`overlayfs <ref-classes-overlayfs>`.
+
+      .. note::
+
+         Although the :ref:`overlayfs <ref-classes-overlayfs>` class is
+         inherited by individual recipes, :term:`OVERLAYFS_MOUNT_POINT`
+         should be set in your machine configuration.
+
+   :term:`OVERLAYFS_WRITABLE_PATHS`
+      When inheriting the :ref:`overlayfs <ref-classes-overlayfs>` class,
+      specifies writable paths used at runtime for the recipe. For
+      example::
+
+         OVERLAYFS_WRITABLE_PATHS[data] = "/usr/share/my-custom-application"
+
    :term:`OVERRIDES`
       A colon-separated list of overrides that currently apply. Overrides
       are a BitBake mechanism that allows variables to be selectively
Signature · 1 line
1.8.3.1
#49 lore raw

PATCH 33/34 ref-manual: add OVERLAYFS_QA_SKIP

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

New variable in 4.1.

---
 documentation/ref-manual/variables.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)
documentation/ref-manual/variables.rst +13 -0
index 00d51e5..c5ab0ff 100644
@@ -5290,6 +5290,19 @@ system and gives an overview of their function and contents.
          inherited by individual recipes, :term:`OVERLAYFS_MOUNT_POINT`
          should be set in your machine configuration.
 
+   :term:`OVERLAYFS_QA_SKIP`
+      When inheriting the :ref:`overlayfs <ref-classes-overlayfs>` class,
+      provides the ability to disable QA checks for particular overlayfs
+      mounts. For example::
+
+         OVERLAYFS_QA_SKIP[data] = "mount-configured"
+
+      .. note::
+
+         Although the :ref:`overlayfs <ref-classes-overlayfs>` class is
+         inherited by individual recipes, :term:`OVERLAYFS_QA_SKIP`
+         should be set in your machine configuration.
+
    :term:`OVERLAYFS_WRITABLE_PATHS`
       When inheriting the :ref:`overlayfs <ref-classes-overlayfs>` class,
       specifies writable paths used at runtime for the recipe. For
Signature · 1 line
1.8.3.1
#50 lore raw

PATCH 34/34 Add 4.1 migration guide & release notes

In reply to Paul Eggleton

From: Paul Eggleton <[email protected]>

This currently does not include known issues or download information.

---
 documentation/migration-guides/index.rst           |   1 +
 documentation/migration-guides/migration-4.1.rst   | 214 +++++++
 documentation/migration-guides/release-4.1.rst     |   7 +
 .../migration-guides/release-notes-4.1.rst         | 687 +++++++++++++++++++++
 4 files changed, 909 insertions(+)
 create mode 100644 documentation/migration-guides/migration-4.1.rst
 create mode 100644 documentation/migration-guides/release-4.1.rst
 create mode 100644 documentation/migration-guides/release-notes-4.1.rst
documentation/migration-guides/index.rst +1 -0
index 4597506..ce0ca8c 100644
@@ -12,6 +12,7 @@ to move to one release of the Yocto Project from the previous one.
 .. toctree::
 
    migration-general
+   release-4.1
    release-4.0
    release-3.4
    migration-3.3
documentation/migration-guides/migration-4.1.rst new file +214 -0

214 lines not on this page · raw message

documentation/migration-guides/release-4.1.rst new file +7 -0
new file mode 100644
index 0000000..8ebf4a4
@@ -0,0 +1,7 @@
+Release 4.1 (langdale)
+======================
+
+.. toctree::
+
+   migration-4.1
+   release-notes-4.1
documentation/migration-guides/release-notes-4.1.rst new file +687 -0

687 lines not on this page · raw message

Signature · 1 line
1.8.3.1
#51 lore raw

Re: [docs] [PATCH 34/34] Add 4.1 migration guide & release notes

Hi Paul

Quoted 11 lines · Paul Eggleton

From: Paul Eggleton <[email protected]>

This currently does not include known issues or download information.

---
  documentation/migration-guides/index.rst           |   1 +
  documentation/migration-guides/migration-4.1.rst   | 214 +++++++
  documentation/migration-guides/release-4.1.rst     |   7 +
  .../migration-guides/release-notes-4.1.rst         | 687 +++++++++++++++++++++
  4 files changed, 909 insertions(+)
Quoted 3 lines

create mode 100644 documentation/migration-guides/migration-4.1.rst create mode 100644 documentation/migration-guides/release-4.1.rst create mode 100644 documentation/migration-guides/release-notes-4.1.rst

This all looks great, including these last two documents. I'd really like to include these changes in the "master-next" branch, so that we can base our new work on them. Would you be able to share an update of your branch taking into account the few comments that we had?

Many thanks again!
Cheers
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

A message that is not in the archive (sent off-list or not yet received): [email protected]

#53 lore raw

Re: [docs] [PATCH 34/34] Add 4.1 migration guide & release notes

Hi Paul,

Quoted 20 lines · Michael Opdenacker via lists.yoctoproject.org

Hi Paul

Quoted 11 lines · Paul Eggleton

From: Paul Eggleton <[email protected]>

This currently does not include known issues or download information.

---
  documentation/migration-guides/index.rst           |   1 + documentation/migration-guides/migration-4.1.rst   | 214 +++++++ documentation/migration-guides/release-4.1.rst     |   7 + .../migration-guides/release-notes-4.1.rst         | 687
+++++++++++++++++++++

Quoted 4 lines
  4 files changed, 909 insertions(+)

  create mode 100644 documentation/migration-guides/migration-4.1.rst create mode 100644 documentation/migration-guides/release-4.1.rst create mode 100644 documentation/migration-guides/release-notes-4.1.rst

Quoted 2 lines

This all looks great, including these last two documents. I'd really like to include these changes in the "master-next" branch, so that we can base our new work on them. Would you be able to share an update of your branch taking into account the few comments that we had?

As you already updated your branch for most of the items, I'll take care of merging your changes into master-next right away. This way, I won't make further changes which will conflict with yours.

Thanks again
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

A message that is not in the archive (sent off-list or not yet received): [email protected]

#55 lore raw

Re: [docs] [PATCH 34/34] Add 4.1 migration guide & release notes

Quoted 3 lines · Michael Opdenacker via lists.yoctoproject.org

As you already updated your branch for most of the items, I'll take care of merging your changes into master-next right away. This way, I won't make further changes which will conflict with yours.

Done: https://git.yoctoproject.org/yocto-docs/log/?h=master-next
I just didn't pick the change that was adding Ubuntu 21.10 to the supported distros (we could discuss this further) and the documentation of the pressure variables, which I intend to submit for the BitBake User Manual.

To contributors on this list: given the number of patches in yocto-docs' master-next, it's best if your patches are based on this branch. This always makes my life easier, though conflicts are rare.

Thanks again
Cheers
Michael.

Signature · 3 lines
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com