subtree updates
poky: 3e5faccfaf..95c802b0be:
Alexander Kanavin (1):
sdk-manual: correct the bitbake target for a unified sysroot build
Michael Opdenacker (6):
ref-manual/variables.rst: clarify sentence
test-manual: fix typo in machine name
ref-manual: faq.rst: reorganize into subsections, contents at top
migration-guides: use contributor real name
manuals: fix misc typos
migration-guides: use contributor real name
Paul Eggleton (31):
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: update buildpaths QA check documentation
ref-manual: add UBOOT_MKIMAGE_KERNEL_TYPE
ref-manual: add DEV_PKG_DEPENDENCY
ref-manual: add SDK_TOOLCHAIN_LANGS
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 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
Ross Burton (2):
migration-guides: add known issues for 4.1
migration-guides/release-notes-4.1.rst: add more known issues
Takayasu Ito (1):
release-notes-4.1.rst remove bitbake-layers subcommand argument
meta-arm: 13199c55c0..14c7e5b336:
Jon Mason (1):
CI: track langdale branch
Mohamed Omar Asaker (1):
arm-bsp/u-boot: corstone1000: support 32bit ffa direct messaging
Ross Burton (3):
arm-bsp: remove TC0
arm-bsp/scp-firmware: remove TC0 patches
arm/fvp-tc0: remove Total Compute 2020 FVP
Rui Miguel Silva (2):
arm-bsp/optee: add log handler
arm-bsp/trusted-services: support for libmetal and openamp
Vishnu Banavath (1):
arm-bsp/linux: add kernel file search path for N1SDP
meta-openembedded: 6529e5f963..8073ec2275:
Alex Kiernan (4):
conntrack-tools: Upgrade 1.4.6 -> 1.4.7
conntrack-tools: Add PACKAGECONFIGs for build options
conntrack-tools: Use canonical shell spacing
uriparser: Upgrade 0.9.6 -> 0.9.7
Andreas Müller (1):
onboard: remove
Changqing Li (1):
redis: upgrade 7.0.4 to 7.0.5
Fabio Estevam (2):
remmina: Update to 1.4.27
crucible: Add recipe
Khem Raj (1):
grpc: Update to 1.50.x release
Leon Anavi (2):
python3-imageio: Upgrade 2.22.1 -> 2.22.2
python3-distro: Upgrade 1.7.0 -> 1.8.0
Markus Volk (2):
pipewire: upgrade 0.3.57 -> 0.3.59
wireplumber: upgrade 0.4.11 -> 0.4.12
Peter Kjellerstedt (1):
v4l-utils: Support building without NLS
Sebastian Suesens (2):
md4c: added md4c lib
double-conversion: added double-conversion lib
Sui Chen (1):
Add recipe for Perfetto
Thomas Perrot (1):
xfce4-settings: upgrade 4.16.2 -> 4.16.3
Ulysse Manceron (1):
abseil-cpp: Upgrade to head on 2022-10-14
Wang Mingyu (19):
broadcom-bt-firmware: upgrade
cppzmq: upgrade 4.8.1 -> 4.9.0
ctags: upgrade 5.9.20221002.0 -> 5.9.20221009.0
debootstrap: upgrade 1.0.127 -> 1.0.128
freerdp: upgrade 2.8.0 -> 2.8.1
gst-editing-services: upgrade 1.20.3 -> 1.20.4
libwacom: upgrade 2.4.0 -> 2.5.0
nbdkit: upgrade 1.33.1 -> 1.33.2
xfstests: upgrade 2022.09.25 -> 2022.10.09
blueman: upgrade 2.3.2 -> 2.3.4
cli11: upgrade 2.2.0 -> 2.3.0
tesseract: upgrade 4.1.3 -> 5.2.0
python3-absl: upgrade 1.2.0 -> 1.3.0
python3-gevent: upgrade 22.8.0 -> 22.10.1
python3-google-api-core: upgrade 2.10.1 -> 2.10.2
python3-google-api-python-client: upgrade 2.62.0 -> 2.64.0
python3-google-auth: upgrade 2.11.1 -> 2.12.0
python3-pymodbus: upgrade 2.5.3 -> 3.0.0
python3-pywbem: upgrade 1.4.1 -> 1.5.0
homalozoa (1):
Add condition for libusbgx-examples
zhengrq.fnst (5):
python3-stevedore: upgrade 4.0.0 -> 4.0.1
yelp: upgrade 42.1 -> 42.2
tio: upgrade 2.0 -> 2.1
python3-zopeinterface: upgrade 5.4.0 -> 5.5.0
unbound: upgrade 1.16.3 -> 1.17.0
meta-raspberrypi: fc5f80a47e..722c51647c:
Oliver Lang (1):
rpi-base.inc: handle empty/undefined KERNEL_DEVICETREE
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I555ec2b7aca80e0511bf112acd0a045de17fe91b
diff --git a/poky/documentation/ref-manual/variables.rst b/poky/documentation/ref-manual/variables.rst
index 1685a26..71e8c27 100644
--- a/poky/documentation/ref-manual/variables.rst
+++ b/poky/documentation/ref-manual/variables.rst
@@ -773,7 +773,7 @@
and `glob <https://docs.python.org/3/library/glob.html>`__.
For more information on how this variable works, see
- ``meta/classes/binconfig.bbclass`` in the :term:`Source Directory`.
+ ``meta/classes-recipe/binconfig.bbclass`` in the :term:`Source Directory`.
You can also find general
information on the class in the
":ref:`ref-classes-binconfig`" section.
@@ -920,10 +920,10 @@
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>`
@@ -1171,12 +1171,10 @@
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
@@ -1191,6 +1189,11 @@
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
@@ -1466,15 +1469,31 @@
# This is windows only issue.
CVE_CHECK_IGNORE += "CVE-2020-15523"
+ :term:`CVE_CHECK_SHOW_WARNINGS`
+ Specifies whether or not the :ref:`cve-check <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.
+ :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/>`__.
- 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.
@@ -1812,6 +1831,23 @@
: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.)
+ 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`
@@ -2029,7 +2065,7 @@
available are xz and bz2.
For information on policies and on how to use this variable, see the
- comments in the ``meta/classes/compress_doc.bbclass`` file.
+ comments in the ``meta/classes-recipe/compress_doc.bbclass`` file.
:term:`EFI_PROVIDER`
When building bootable images (i.e. where ``hddimg``, ``iso``, or
@@ -2197,7 +2233,7 @@
variable tells the OpenEmbedded build system to prefer the installed
external tools. See the
:ref:`kernel-yocto <ref-classes-kernel-yocto>` class in
- ``meta/classes`` to see how the variable is used.
+ ``meta/classes-recipe`` to see how the variable is used.
:term:`EXTERNALSRC`
When inheriting the :ref:`externalsrc <ref-classes-externalsrc>`
@@ -2574,7 +2610,7 @@
:term:`SRC_URI` statements.
The default value for the :term:`FILESPATH` variable is defined in the
- :ref:`ref-classes-base` class found in ``meta/classes`` in the
+ :ref:`ref-classes-base` class found in ``meta/classes-global`` in the
:term:`Source Directory`::
FILESPATH = "${@base_set_filespath(["${FILE_DIRNAME}/${BP}", \
@@ -2687,6 +2723,10 @@
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
@@ -2756,6 +2796,13 @@
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.
@@ -3041,17 +3088,23 @@
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
- different types of images the OpenEmbedded build system creates.
+ A list of classes that all images should inherit. This is typically used
+ to enable functionality across all image recipes.
- The default value for :term:`IMAGE_CLASSES` is ``image_types``. You can
- set this variable in your ``local.conf`` or in a distribution
- configuration file.
-
- For more information, see ``meta/classes/image_types.bbclass`` in the
- :term:`Source Directory`.
+ Classes specified in :term:`IMAGE_CLASSES` must be located in the
+ ``classes-recipe/`` or ``classes/`` subdirectories.
:term:`IMAGE_CMD`
Specifies the command to create the image file for a specific image
@@ -3067,7 +3120,7 @@
You typically do not need to set this variable unless you are adding
support for a new image type. For more examples on how to set this
variable, see the :ref:`image_types <ref-classes-image_types>`
- class file, which is ``meta/classes/image_types.bbclass``.
+ class file, which is ``meta/classes-recipe/image_types.bbclass``.
:term:`IMAGE_DEVICE_TABLES`
Specifies one or more files that contain custom device tables that
@@ -3463,7 +3516,7 @@
- wic.lzma
For more information about these types of images, see
- ``meta/classes/image_types*.bbclass`` in the :term:`Source Directory`.
+ ``meta/classes-recipe/image_types*.bbclass`` in the :term:`Source Directory`.
:term:`IMAGE_VERSION_SUFFIX`
Version suffix that is part of the default :term:`IMAGE_NAME` and
@@ -3546,7 +3599,7 @@
Although you can use other settings, you might be required to
- remove dependencies on or provide alternatives to components that
+ remove dependencies on (or provide alternatives to) components that
are required to produce a functional system image.
:term:`INCOMPATIBLE_LICENSE_EXCEPTIONS`
@@ -3562,6 +3615,8 @@
functions in the class or classes are not executed for the base
configuration and in each individual recipe. The OpenEmbedded build
system ignores changes to :term:`INHERIT` in individual recipes.
+ Classes inherited using :term:`INHERIT` must be located in the
+ ``classes-global/`` or ``classes/`` subdirectories.
For more information on :term:`INHERIT`, see the
:ref:`bitbake:bitbake-user-manual/bitbake-user-manual-metadata:\`\`inherit\`\` configuration directive`"
@@ -3571,6 +3626,9 @@
Lists classes that will be inherited at the distribution level. It is
unlikely that you want to edit this variable.
+ Classes specified in :term:`INHERIT_DISTRO` must be located in the
+ ``classes-global/`` or ``classes/`` subdirectories.
+
The default value of the variable is set as follows in the
``meta/conf/distro/defaultsetup.conf`` file::
@@ -3786,7 +3844,7 @@
:term:`INITRAMFS_LINK_NAME`
The link name of the initial RAM filesystem image. This variable is
- set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
+ set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as
follows::
INITRAMFS_LINK_NAME ?= "initramfs-${KERNEL_ARTIFACT_LINK_NAME}"
@@ -3812,7 +3870,7 @@
:term:`INITRAMFS_NAME`
The base name of the initial RAM filesystem image. This variable is
- set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
+ set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as
follows::
INITRAMFS_NAME ?= "initramfs-${KERNEL_ARTIFACT_NAME}"
@@ -4022,7 +4080,7 @@
variable.
The value of :term:`KERNEL_ARTIFACT_NAME`, which is set in the
- ``meta/classes/kernel-artifact-names.bbclass`` file, has the
+ ``meta/classes-recipe/kernel-artifact-names.bbclass`` file, has the
following default value::
KERNEL_ARTIFACT_NAME ?= "${PKGE}-${PKGV}-${PKGR}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
@@ -4035,7 +4093,7 @@
:ref:`kernel <ref-classes-kernel>` class should inherit. You
typically append this variable to enable extended image types. An
example is the "kernel-fitimage", which enables fitImage support and
- resides in ``meta/classes/kernel-fitimage.bbclass``. You can register
+ resides in ``meta/classes-recipe/kernel-fitimage.bbclass``. You can register
custom kernel image types with the :ref:`kernel <ref-classes-kernel>` class using this
variable.
@@ -4044,6 +4102,12 @@
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.
@@ -4059,7 +4123,7 @@
:term:`KERNEL_DTB_LINK_NAME`
The link name of the kernel device tree binary (DTB). This variable
- is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
+ is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as
follows::
KERNEL_DTB_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
@@ -4075,7 +4139,7 @@
:term:`KERNEL_DTB_NAME`
The base name of the kernel device tree binary (DTB). This variable
- is set in the ``meta/classes/kernel-artifact-names.bbclass`` file as
+ is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as
follows::
KERNEL_DTB_NAME ?= "${KERNEL_ARTIFACT_NAME}"
@@ -4126,7 +4190,7 @@
:term:`KERNEL_FIT_LINK_NAME`
The link name of the kernel flattened image tree (FIT) image. This
- variable is set in the ``meta/classes/kernel-artifact-names.bbclass``
+ variable is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass``
file as follows::
KERNEL_FIT_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
@@ -4142,7 +4206,7 @@
:term:`KERNEL_FIT_NAME`
The base name of the kernel flattened image tree (FIT) image. This
- variable is set in the ``meta/classes/kernel-artifact-names.bbclass``
+ variable is set in the ``meta/classes-recipe/kernel-artifact-names.bbclass``
file as follows::
KERNEL_FIT_NAME ?= "${KERNEL_ARTIFACT_NAME}"
@@ -4154,7 +4218,7 @@
:term:`KERNEL_IMAGE_LINK_NAME`
The link name for the kernel image. This variable is set in the
- ``meta/classes/kernel-artifact-names.bbclass`` file as follows::
+ ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows::
KERNEL_IMAGE_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
@@ -4182,7 +4246,7 @@
:term:`KERNEL_IMAGE_NAME`
The base name of the kernel image. This variable is set in the
- ``meta/classes/kernel-artifact-names.bbclass`` file as follows::
+ ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows::
KERNEL_IMAGE_NAME ?= "${KERNEL_ARTIFACT_NAME}"
@@ -4917,7 +4981,7 @@
:term:`MODULE_TARBALL_LINK_NAME`
The link name of the kernel module tarball. This variable is set in
- the ``meta/classes/kernel-artifact-names.bbclass`` file as follows::
+ the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows::
MODULE_TARBALL_LINK_NAME ?= "${KERNEL_ARTIFACT_LINK_NAME}"
@@ -4931,7 +4995,7 @@
:term:`MODULE_TARBALL_NAME`
The base name of the kernel module tarball. This variable is set in
- the ``meta/classes/kernel-artifact-names.bbclass`` file as follows::
+ the ``meta/classes-recipe/kernel-artifact-names.bbclass`` file as follows::
MODULE_TARBALL_NAME ?= "${KERNEL_ARTIFACT_NAME}"
@@ -4940,6 +5004,11 @@
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
@@ -5061,7 +5130,7 @@
``sysroots/`` directory so that all builds that use the script will
use the correct directories for the cross compiling layout.
- See the ``meta/classes/binconfig.bbclass`` in the
+ See the ``meta/classes-recipe/binconfig.bbclass`` in the
:term:`Source Directory` for details on how this class
applies these additional sed command arguments.
@@ -5118,6 +5187,87 @@
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_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
+ 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:`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_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
+ 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
@@ -6142,6 +6292,14 @@
: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
@@ -6615,6 +6773,11 @@
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
@@ -6814,6 +6977,10 @@
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
@@ -8217,7 +8384,7 @@
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
@@ -8529,6 +8696,10 @@
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
@@ -8696,6 +8867,9 @@
A list of classes to globally inherit. These classes are used by the
OpenEmbedded build system to enable extra features.
+ Classes inherited using :term:`USER_CLASSES` must be located in the
+ ``classes-global/`` or ``classes/`` subdirectories.
+
The default list is set in your ``local.conf`` file::
USER_CLASSES ?= "buildstats"
@@ -8844,6 +9018,15 @@
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:`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