ref-manual/classes.rst: remove .bbclass from section titles
PATCH 1/2 ref-manual/classes.rst: remove .bbclass from section titles
From: Michael Opdenacker <[email protected]>
This is unnecessary and allows to simplify the references to such sections, most of which are removing the .bbclass extension anyway, for example in :ref:insane <ref-classes-insane>.
--- documentation/ref-manual/classes.rst | 588 +++++++++++++-------------- 1 file changed, 294 insertions(+), 294 deletions(-)
documentation/ref-manual/classes.rst +294 -294
@@ -34,8 +34,8 @@ information. .. _ref-classes-allarch: -``allarch.bbclass`` -=================== +``allarch`` +=========== The :ref:`allarch <ref-classes-allarch>` class is inherited by recipes that do not produce architecture-specific output. The class disables functionality that is
@@ -67,8 +67,8 @@ inherit the :ref:`allarch <ref-classes-allarch>` class. .. _ref-classes-archiver: -``archiver.bbclass`` -==================== +``archiver`` +============ The :ref:`archiver <ref-classes-archiver>` class supports releasing source code and other materials with the binaries.
@@ -81,8 +81,8 @@ about the variable flags (varflags) that help control archive creation. .. _ref-classes-autotools: -``autotools*.bbclass`` -====================== +``autotools*`` +============== The :ref:`autotools* <ref-classes-autotools>` classes support packages built with the :wikipedia:`GNU Autotools <GNU_Autotools>`.
@@ -130,8 +130,8 @@ It's useful to have some idea of how the tasks defined by the .. _ref-classes-base: -``base.bbclass`` -================ +``base`` +======== The :ref:`base <ref-classes-base>` class is special in that every ``.bb`` file implicitly inherits the class. This class contains definitions for standard basic
@@ -149,16 +149,16 @@ arguments passed directly to ``oe_runmake``. .. _ref-classes-bash-completion: -``bash-completion.bbclass`` -=========================== +``bash-completion`` +=================== Sets up packaging and dependencies appropriate for recipes that build software that includes bash-completion data. .. _ref-classes-bin-package: -``bin_package.bbclass`` -======================= +``bin_package`` +=============== The :ref:`bin_package <ref-classes-bin-package>` class is a helper class for recipes that extract the contents of a binary package (e.g. an RPM) and install those contents
@@ -184,8 +184,8 @@ example use for this class. .. _ref-classes-binconfig: -``binconfig.bbclass`` -===================== +``binconfig`` +============= The :ref:`binconfig <ref-classes-binconfig>` class helps to correct paths in shell scripts.
@@ -204,8 +204,8 @@ information. .. _ref-classes-binconfig-disabled: -``binconfig-disabled.bbclass`` -============================== +``binconfig-disabled`` +====================== An alternative version of the :ref:`binconfig <ref-classes-binconfig>` class, which disables binary configuration scripts by making them return
@@ -215,8 +215,8 @@ variable within the recipe inheriting the class. .. _ref-classes-buildhistory: -``buildhistory.bbclass`` -======================== +``buildhistory`` +================ The :ref:`buildhistory <ref-classes-buildhistory>` class records a history of build output metadata, which can be used to detect possible regressions as well as used for
@@ -227,8 +227,8 @@ section in the Yocto Project Development Tasks Manual. .. _ref-classes-buildstats: -``buildstats.bbclass`` -====================== +``buildstats`` +============== The :ref:`buildstats <ref-classes-buildstats>` class records performance statistics about each task executed during the build (e.g. elapsed time, CPU usage, and I/O usage).
@@ -248,8 +248,8 @@ remove ":ref:`buildstats <ref-classes-buildstats>`" from the :term:`USER_CLASSES .. _ref-classes-buildstats-summary: -``buildstats-summary.bbclass`` -============================== +``buildstats-summary`` +====================== When inherited globally, prints statistics at the end of the build on sstate re-use. In order to function, this class requires the
@@ -257,8 +257,8 @@ sstate re-use. In order to function, this class requires the .. _ref-classes-ccache: -``ccache.bbclass`` -================== +``ccache`` +========== The :ref:`ccache <ref-classes-ccache>` class enables the C/C++ Compiler Cache for the build. This class is used to give a minor performance boost during the build.
@@ -274,8 +274,8 @@ this class is not recommended. .. _ref-classes-chrpath: -``chrpath.bbclass`` -=================== +``chrpath`` +=========== The :ref:`chrpath <ref-classes-chrpath>` class is a wrapper around the "chrpath" utility, which is used during the build process for :ref:`nativesdk <ref-classes-nativesdk>`, :ref:`cross <ref-classes-cross>`, and
@@ -284,8 +284,8 @@ in order to make them relocatable. .. _ref-classes-cmake: -``cmake.bbclass`` -================= +``cmake`` +========= The ref:`cmake <ref-classes-cmake>` class allows for recipes that need to build software using the `CMake <https://cmake.org/overview/>`__ build system. You can use
@@ -301,16 +301,16 @@ Modules during .. _ref-classes-cml1: -``cml1.bbclass`` -================ +``cml1`` +======== The :ref:`cml1 <ref-classes-cml1>` class provides basic support for the Linux kernel style build configuration system. .. _ref-classes-compress_doc: -``compress_doc.bbclass`` -======================== +``compress_doc`` +================ Enables compression for man pages and info pages. This class is intended to be inherited globally. The default compression mechanism is gz (gzip)
@@ -319,8 +319,8 @@ but you can select an alternative mechanism by setting the .. _ref-classes-copyleft_compliance: -``copyleft_compliance.bbclass`` -=============================== +``copyleft_compliance`` +======================= The :ref:`copyleft_compliance <ref-classes-copyleft_compliance>` class preserves source code for the purposes of license compliance. This class is an alternative to the :ref:`archiver <ref-classes-archiver>`
@@ -329,8 +329,8 @@ in favor of the :ref:`archiver <ref-classes-archiver>` class. .. _ref-classes-copyleft_filter: -``copyleft_filter.bbclass`` -=========================== +``copyleft_filter`` +=================== A class used by the :ref:`archiver <ref-classes-archiver>` and :ref:`copyleft_compliance <ref-classes-copyleft_compliance>` classes
@@ -339,8 +339,8 @@ class and is not intended to be used directly. .. _ref-classes-core-image: -``core-image.bbclass`` -====================== +``core-image`` +============== The :ref:`core-image <ref-classes-core-image>` class provides common definitions for the ``core-image-*`` image recipes, such as support for additional
@@ -348,8 +348,8 @@ The :ref:`core-image <ref-classes-core-image>` class provides common definitions .. _ref-classes-cpan: -``cpan*.bbclass`` -================= +``cpan*`` +========= The :ref:`cpan* <ref-classes-cpan>` classes support Perl modules.
@@ -369,8 +369,8 @@ support. .. _ref-classes-create-spdx: -``create-spdx.bbclass`` -======================= +``create-spdx`` +=============== The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for automatically creating :term:`SPDX` :term:`SBOM` documents based upon image
@@ -395,16 +395,16 @@ section in the Yocto Project Development Manual for more details. .. _ref-classes-cross: -``cross.bbclass`` -================= +``cross`` +========= The :ref:`cross <ref-classes-cross>` class provides support for the recipes that build the cross-compilation tools. .. _ref-classes-cross-canadian: -``cross-canadian.bbclass`` -========================== +``cross-canadian`` +================== The :ref:`cross-canadian <ref-classes-cross-canadian>` class provides support for the recipes that build the Canadian Cross-compilation tools for SDKs. See the
@@ -414,8 +414,8 @@ discussion on these cross-compilation tools. .. _ref-classes-crosssdk: -``crosssdk.bbclass`` -==================== +``crosssdk`` +============ The :ref:`crosssdk <ref-classes-crosssdk>` class provides support for the recipes that build the cross-compilation tools used for building SDKs. See the
@@ -425,8 +425,8 @@ discussion on these cross-compilation tools. .. _ref-classes-cve-check: -``cve-check.bbclass`` -===================== +``cve-check`` +============= The :ref:`cve-check <ref-classes-cve-check>` class looks for known CVEs (Common Vulnerabilities and Exposures) while building with BitBake. This class is meant to be
@@ -489,8 +489,8 @@ section in the Development Tasks Manual. .. _ref-classes-debian: -``debian.bbclass`` -================== +``debian`` +========== The :ref:`debian <ref-classes-debian>` class renames output packages so that they follow the Debian naming policy (i.e. ``glibc`` becomes ``libc6`` and
@@ -504,8 +504,8 @@ naming scheme. .. _ref-classes-deploy: -``deploy.bbclass`` -================== +``deploy`` +========== The :ref:`deploy <ref-classes-deploy>` class handles deploying files to the :term:`DEPLOY_DIR_IMAGE` directory. The main
@@ -520,8 +520,8 @@ staging the files from :term:`DEPLOYDIR` to :term:`DEPLOY_DIR_IMAGE`. .. _ref-classes-devshell: -``devshell.bbclass`` -==================== +``devshell`` +============ The :ref:`devshell <ref-classes-devshell>` class adds the :ref:`ref-tasks-devshell` task. Distribution policy dictates whether to include this class. See the ":ref:`dev-manual/development-shell:using a development shell`"
@@ -530,8 +530,8 @@ information about using :ref:`devshell <ref-classes-devshell>`. .. _ref-classes-devupstream: -``devupstream.bbclass`` -======================= +``devupstream`` +=============== The :ref:`devupstream <ref-classes-devupstream>` class uses :term:`BBCLASSEXTEND` to add a variant of the
@@ -567,8 +567,8 @@ due to BitBake's automatic fetch dependencies (e.g. .. _ref-classes-externalsrc: -``externalsrc.bbclass`` -======================= +``externalsrc`` +=============== The :ref:`externalsrc <ref-classes-externalsrc>` class supports building software from source code that is external to the OpenEmbedded build system. Building software
@@ -603,8 +603,8 @@ section in the Yocto Project Development Tasks Manual. .. _ref-classes-extrausers: -``extrausers.bbclass`` -====================== +``extrausers`` +============== The :ref:`extrausers <ref-classes-extrausers>` class allows additional user and group configuration to be applied at the image level. Inheriting this class either globally
@@ -665,8 +665,8 @@ Finally, here is an example that sets the root password:: .. _ref-classes-features_check: -``features_check.bbclass`` -================================= +``features_check`` +================== The :ref:`features_check <ref-classes-features_check>` class allows individual recipes to check for required and conflicting
@@ -691,8 +691,8 @@ triggered. .. _ref-classes-fontcache: -``fontcache.bbclass`` -===================== +``fontcache`` +============= The :ref:`fontcache <ref-classes-fontcache>` class generates the proper post-install and post-remove (postinst and postrm) scriptlets for font packages. These
@@ -707,8 +707,8 @@ packages containing the fonts. .. _ref-classes-fs-uuid: -``fs-uuid.bbclass`` -=================== +``fs-uuid`` +=========== The :ref:`fs-uuid <ref-classes-fs-uuid>` class extracts UUID from ``${``\ :term:`ROOTFS`\ ``}``, which must have been built
@@ -717,8 +717,8 @@ works on ``ext`` file systems and depends on ``tune2fs``. .. _ref-classes-gconf: -``gconf.bbclass`` -================= +``gconf`` +========= The :ref:`gconf <ref-classes-gconf>` class provides common functionality for recipes that need to install GConf schemas. The schemas will be put into a separate
@@ -729,8 +729,8 @@ register and unregister the schemas in the target image. .. _ref-classes-gettext: -``gettext.bbclass`` -=================== +``gettext`` +=========== The :ref:`gettext <ref-classes-gettext>` class provides support for building software that uses the GNU ``gettext`` internationalization and localization
@@ -739,8 +739,8 @@ class. .. _ref-classes-github-releases: -``github-releases.bbclass`` -=========================== +``github-releases`` +=================== For recipes that fetch release tarballs from github, the :ref:`github-releases <ref-classes-github-releases>` class sets up a standard way for checking available upstream versions
@@ -753,8 +753,8 @@ in the value you set for :term:`SRC_URI` within the recipe. .. _ref-classes-gnomebase: -``gnomebase.bbclass`` -===================== +``gnomebase`` +============= The :ref:`gnomebase <ref-classes-gnomebase>` class is the base class for recipes that build software from the GNOME stack. This class sets
@@ -764,8 +764,8 @@ GNOME installation paths. .. _ref-classes-gobject-introspection: -``gobject-introspection.bbclass`` -================================= +``gobject-introspection`` +========================= Provides support for recipes building software that supports GObject introspection. This functionality is only enabled if the
@@ -782,8 +782,8 @@ introspection. This functionality is only enabled if the .. _ref-classes-grub-efi: -``grub-efi.bbclass`` -==================== +``grub-efi`` +============ The :ref:`grub-efi <ref-classes-grub-efi>` class provides ``grub-efi``-specific functions for building bootable images.
@@ -814,8 +814,8 @@ This class supports several variables: .. _ref-classes-gsettings: -``gsettings.bbclass`` -===================== +``gsettings`` +============= The :ref:`gsettings <ref-classes-gsettings>` class provides common functionality for recipes that need to install GSettings (glib) schemas. The schemas are assumed to be
@@ -825,16 +825,16 @@ schemas in the target image. .. _ref-classes-gtk-doc: -``gtk-doc.bbclass`` -=================== +``gtk-doc`` +=========== The :ref:`gtk-doc <ref-classes-gtk-doc>` class is a helper class to pull in the appropriate ``gtk-doc`` dependencies and disable ``gtk-doc``. .. _ref-classes-gtk-icon-cache: -``gtk-icon-cache.bbclass`` -========================== +``gtk-icon-cache`` +================== The :ref:`gtk-icon-cache <ref-classes-gtk-icon-cache>` class generates the proper post-install and post-remove (postinst/postrm) scriptlets for packages that use GTK+ and
@@ -846,8 +846,8 @@ creation. .. _ref-classes-gtk-immodules-cache: -``gtk-immodules-cache.bbclass`` -=============================== +``gtk-immodules-cache`` +======================= The :ref:`gtk-immodules-cache <ref-classes-gtk-immodules-cache>` class generates the proper post-install and post-remove (postinst/postrm) scriptlets for packages that install GTK+
@@ -864,8 +864,8 @@ the packages containing the modules. .. _ref-classes-gzipnative: -``gzipnative.bbclass`` -====================== +``gzipnative`` +============== The :ref:`gzipnative <ref-classes-gzipnative>` class enables the use of different native versions of ``gzip`` and ``pigz`` rather than the versions of these tools from the
@@ -873,8 +873,8 @@ build host. .. _ref-classes-icecc: -``icecc.bbclass`` -================= +``icecc`` +========= The :ref:`icecc <ref-classes-icecc>` class supports `Icecream <https://github.com/icecc/icecream>`__, which facilitates
@@ -947,8 +947,8 @@ individually as follows in your ``local.conf`` file:: .. _ref-classes-image: -``image.bbclass`` -================= +``image`` +========= The :ref:`image <ref-classes-image>` class helps support creating images in different formats. First, the root filesystem is created from packages using one of the
@@ -970,8 +970,8 @@ Yocto Project Overview and Concepts Manual. .. _ref-classes-image-buildinfo: -``image-buildinfo.bbclass`` -=========================== +``image-buildinfo`` +=================== The :ref:`image-buildinfo <ref-classes-image-buildinfo>` class writes a plain text file containing build information to the target filesystem at ``${sysconfdir}/buildinfo``
@@ -992,8 +992,8 @@ to ``/buildinfo`` by default (as specified by .. _ref-classes-image_types: -``image_types.bbclass`` -======================= +``image_types`` +=============== The :ref:`image_types <ref-classes-image_types>` class defines all of the standard image output types that you can enable through the
@@ -1024,8 +1024,8 @@ The :ref:`image_types <ref-classes-image_types>` class also handles conversion a .. _ref-classes-image-live: -``image-live.bbclass`` -====================== +``image-live`` +============== This class controls building "live" (i.e. HDDIMG and ISO) images. Live images contain syslinux for legacy booting, as well as the bootloader
@@ -1037,8 +1037,8 @@ Normally, you do not use this class directly. Instead, you add "live" to .. _ref-classes-insane: -``insane.bbclass`` -================== +``insane`` +========== The :ref:`insane <ref-classes-insane>` class adds a step to the package generation process so that output quality assurance checks are generated by the OpenEmbedded
@@ -1337,8 +1337,8 @@ Here are the tests you can list with the :term:`WARN_QA` and .. _ref-classes-insserv: -``insserv.bbclass`` -=================== +``insserv`` +=========== The :ref:`insserv <ref-classes-insserv>` class uses the ``insserv`` utility to update the order of symbolic links in ``/etc/rc?.d/`` within an image based on
@@ -1347,8 +1347,8 @@ themselves. .. _ref-classes-kernel: -``kernel.bbclass`` -================== +``kernel`` +========== The :ref:`kernel <ref-classes-kernel>` class handles building Linux kernels. The class contains code to build all kernel trees. All needed headers are staged into the
@@ -1374,16 +1374,16 @@ internally including the :ref:`kernel-arch <ref-classes-kernel-arch>`, .. _ref-classes-kernel-arch: -``kernel-arch.bbclass`` -======================= +``kernel-arch`` +=============== The :ref:`kernel-arch <ref-classes-kernel-arch>` class sets the ``ARCH`` environment variable for Linux kernel compilation (including modules). .. _ref-classes-kernel-devicetree: -``kernel-devicetree.bbclass`` -============================= +``kernel-devicetree`` +===================== The :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class, which is inherited by the :ref:`kernel <ref-classes-kernel>` class, supports device tree
@@ -1391,8 +1391,8 @@ generation. .. _ref-classes-kernel-fitimage: -``kernel-fitimage.bbclass`` -=========================== +``kernel-fitimage`` +=================== The :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class provides support to pack a kernel image, device trees, a U-boot script, a :term:`Initramfs` bundle and a RAM disk
@@ -1462,8 +1462,8 @@ the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class when both :term:` .. _ref-classes-kernel-grub: -``kernel-grub.bbclass`` -======================= +``kernel-grub`` +=============== The :ref:`kernel-grub <ref-classes-kernel-grub>` class updates the boot area and the boot menu with the kernel as the priority boot mechanism while installing a RPM to
@@ -1471,46 +1471,46 @@ update the kernel on a deployed target. .. _ref-classes-kernel-module-split: -``kernel-module-split.bbclass`` -=============================== +``kernel-module-split`` +======================= The :ref:`kernel-module-split <ref-classes-kernel-module-split>` class provides common functionality for splitting Linux kernel modules into separate packages. .. _ref-classes-kernel-uboot: -``kernel-uboot.bbclass`` -======================== +``kernel-uboot`` +================ The :ref:`kernel-uboot <ref-classes-kernel-uboot>` class provides support for building from vmlinux-style kernel sources. .. _ref-classes-kernel-uimage: -``kernel-uimage.bbclass`` -========================= +``kernel-uimage`` +================= The :ref:`kernel-uimage <ref-classes-kernel-uimage>` class provides support to pack uImage. .. _ref-classes-kernel-yocto: -``kernel-yocto.bbclass`` -======================== +``kernel-yocto`` +================ The :ref:`kernel-yocto <ref-classes-kernel-yocto>` class provides common functionality for building from linux-yocto style kernel source repositories. .. _ref-classes-kernelsrc: -``kernelsrc.bbclass`` -===================== +``kernelsrc`` +============= The :ref:`kernelsrc <ref-classes-kernelsrc>` class sets the Linux kernel source and version. .. _ref-classes-lib_package: -``lib_package.bbclass`` -======================= +``lib_package`` +=============== The :ref:`lib_package <ref-classes-lib_package>` class supports recipes that build libraries and produce executable binaries, where those binaries should not be
@@ -1520,8 +1520,8 @@ make their installation optional. .. _ref-classes-libc*: -``libc*.bbclass`` -================= +``libc*`` +========= The :ref:`libc* <ref-classes-libc*>` classes support recipes that build packages with ``libc``:
@@ -1533,8 +1533,8 @@ The :ref:`libc* <ref-classes-libc*>` classes support recipes that build packages .. _ref-classes-license: -``license.bbclass`` -=================== +``license`` +=========== The :ref:`license <ref-classes-license>` class provides license manifest creation and license exclusion. This class is enabled by default using the default value for
@@ -1542,8 +1542,8 @@ the :term:`INHERIT_DISTRO` variable. .. _ref-classes-linux-kernel-base: -``linux-kernel-base.bbclass`` -============================= +``linux-kernel-base`` +===================== The :ref:`linux-kernel-base <ref-classes-linux-kernel-base>` class provides common functionality for recipes that build out of the Linux kernel source tree. These builds
@@ -1552,8 +1552,8 @@ inherits this class. .. _ref-classes-linuxloader: -``linuxloader.bbclass`` -======================= +``linuxloader`` +=============== Provides the function ``linuxloader()``, which gives the value of the dynamic loader/linker provided on the platform. This value is used by a
@@ -1561,8 +1561,8 @@ number of other classes. .. _ref-classes-logging: -``logging.bbclass`` -=================== +``logging`` +=========== The :ref:`logging <ref-classes-logging>` class provides the standard shell functions used to log messages for various BitBake severity levels (i.e. ``bbplain``,
@@ -1573,8 +1573,8 @@ class. .. _ref-classes-metadata_scm: -``metadata_scm.bbclass`` -======================== +``metadata_scm`` +================ The :ref:`metadata_scm <ref-classes-metadata_scm>` class provides functionality for querying the branch and revision of a Source Code Manager (SCM) repository.
@@ -1586,16 +1586,16 @@ the :ref:`base <ref-classes-base>` class. .. _ref-classes-migrate_localcount: -``migrate_localcount.bbclass`` -============================== +``migrate_localcount`` +====================== The :ref:`migrate_localcount <ref-classes-migrate_localcount>` class verifies a recipe's localcount data and increments it appropriately. .. _ref-classes-mime: -``mime.bbclass`` -================ +``mime`` +======== The :ref:`mime <ref-classes-mime>` class generates the proper post-install and post-remove (postinst/postrm) scriptlets for packages that install MIME type files.
@@ -1604,8 +1604,8 @@ the shared database. .. _ref-classes-mime-xdg: -``mime-xdg.bbclass`` -==================== +``mime-xdg`` +============ The :ref:`mime-xdg <ref-classes-mime-xdg>` class generates the proper post-install and post-remove (postinst/postrm) scriptlets for packages
@@ -1625,8 +1625,8 @@ package names to the :term:`MIME_XDG_PACKAGES` variable. .. _ref-classes-mirrors: -``mirrors.bbclass`` -=================== +``mirrors`` +=========== The :ref:`mirrors <ref-classes-mirrors>` class sets up some standard :term:`MIRRORS` entries for source code mirrors. These
@@ -1638,8 +1638,8 @@ This class is enabled by default since it is inherited by the .. _ref-classes-module: -``module.bbclass`` -================== +``module`` +========== The :ref:`module <ref-classes-module>` class provides support for building out-of-tree Linux kernel modules. The class inherits the
@@ -1655,8 +1655,8 @@ section in the Yocto Project Linux Kernel Development Manual. .. _ref-classes-module-base: -``module-base.bbclass`` -======================= +``module-base`` +=============== The :ref:`module-base <ref-classes-module-base>` class provides the base functionality for building Linux kernel modules. Typically, a recipe that builds software that
@@ -1666,8 +1666,8 @@ the module inherits this class as opposed to inheriting the .. _ref-classes-multilib*: -``multilib*.bbclass`` -===================== +``multilib*`` +============= The :ref:`multilib* <ref-classes-multilib*>` classes provide support for building libraries with different target optimizations or target architectures and installing
@@ -1679,8 +1679,8 @@ section in the Yocto Project Development Tasks Manual. .. _ref-classes-native: -``native.bbclass`` -================== +``native`` +========== The :ref:`native <ref-classes-native>` class provides common functionality for recipes that build tools to run on the :term:`Build Host` (i.e. tools that use the compiler
@@ -1721,8 +1721,8 @@ target. All common parts of the recipe are automatically shared. .. _ref-classes-nativesdk: -``nativesdk.bbclass`` -===================== +``nativesdk`` +============= The :ref:`nativesdk <ref-classes-nativesdk>` class provides common functionality for recipes that wish to build tools to run as part of an SDK (i.e. tools that run on
@@ -1762,16 +1762,16 @@ and the target. All common parts of the recipe are automatically shared. .. _ref-classes-nopackages: -``nopackages.bbclass`` -====================== +``nopackages`` +============== Disables packaging tasks for those recipes and classes where packaging is not needed. .. _ref-classes-npm: -``npm.bbclass`` -=============== +``npm`` +======= Provides support for building Node.js software fetched using the :wikipedia:`node package manager (NPM) <Npm_(software)>`.
@@ -1787,8 +1787,8 @@ section in the Yocto Project Development Tasks Manual. .. _ref-classes-oelint: -``oelint.bbclass`` -================== +``oelint`` +========== The :ref:`oelint <ref-classes-oelint>` class is an obsolete lint checking tool available in ``meta/classes`` in the :term:`Source Directory`.
@@ -1801,8 +1801,8 @@ layers. .. _ref-classes-overlayfs: -``overlayfs.bbclass`` -======================= +``overlayfs`` +============= It's often desired in Embedded System design to have a read-only root filesystem. But a lot of different applications might want to have read-write access to
@@ -1865,8 +1865,8 @@ to the unit the following:: .. _ref-classes-overlayfs-etc: -``overlayfs-etc.bbclass`` -========================= +``overlayfs-etc`` +================= In order to have the ``/etc`` directory in overlayfs a special handling at early boot stage is required. The idea is to supply a custom init script that mounts
@@ -1910,8 +1910,8 @@ The class provides two options for ``/sbin/init`` generation: .. _ref-classes-own-mirrors: -``own-mirrors.bbclass`` -======================= +``own-mirrors`` +=============== The :ref:`own-mirrors <ref-classes-own-mirrors>` class makes it easier to set up your own :term:`PREMIRRORS` from which to first fetch source
@@ -1929,8 +1929,8 @@ in :term:`SOURCE_MIRROR_URL`. .. _ref-classes-package: -``package.bbclass`` -=================== +``package`` +=========== The :ref:`package <ref-classes-package>` class supports generating packages from a build's output. The core generic functionality is in ``package.bbclass``. The
@@ -1994,8 +1994,8 @@ at these two Yocto Project mailing list links: .. _ref-classes-package_deb: -``package_deb.bbclass`` -======================= +``package_deb`` +=============== The :ref:`package_deb <ref-classes-package_deb>` class provides support for creating packages that use the Debian (i.e. ``.deb``) file format. The class ensures the
@@ -2008,8 +2008,8 @@ variable in the ``local.conf`` file. .. _ref-classes-package_ipk: -``package_ipk.bbclass`` -======================= +``package_ipk`` +=============== The :ref:`package_ipk <ref-classes-package_ipk>` class provides support for creating packages that use the IPK (i.e. ``.ipk``) file format. The class ensures the packages
@@ -2022,8 +2022,8 @@ variable in the ``local.conf`` file. .. _ref-classes-package_rpm: -``package_rpm.bbclass`` -======================= +``package_rpm`` +=============== The :ref:`package_rpm <ref-classes-package_rpm>` class provides support for creating packages that use the RPM (i.e. ``.rpm``) file format. The class ensures the packages
@@ -2036,8 +2036,8 @@ variable in the ``local.conf`` file. .. _ref-classes-package_tar: -``package_tar.bbclass`` -======================= +``package_tar`` +=============== The :ref:`package_tar <ref-classes-package_tar>` class provides support for creating tarballs. The class ensures the packages are written out in a tarball format to the
@@ -2055,8 +2055,8 @@ variable in the ``local.conf`` file. .. _ref-classes-packagedata: -``packagedata.bbclass`` -======================= +``packagedata`` +=============== The :ref:`packagedata <ref-classes-packagedata>` class provides common functionality for reading ``pkgdata`` files found in :term:`PKGDATA_DIR`. These
@@ -2068,8 +2068,8 @@ This class is enabled by default because it is inherited by the .. _ref-classes-packagegroup: -``packagegroup.bbclass`` -======================== +``packagegroup`` +================ The :ref:`packagegroup <ref-classes-packagegroup>` class sets default values appropriate for package group recipes (e.g. :term:`PACKAGES`, :term:`PACKAGE_ARCH`, :term:`ALLOW_EMPTY`, and
@@ -2084,8 +2084,8 @@ Previously, this class was called the ``task`` class. .. _ref-classes-patch: -``patch.bbclass`` -================= +``patch`` +========= The :ref:`patch <ref-classes-patch>` class provides all functionality for applying patches during the :ref:`ref-tasks-patch` task.
@@ -2095,8 +2095,8 @@ This class is enabled by default because it is inherited by the .. _ref-classes-perlnative: -``perlnative.bbclass`` -====================== +``perlnative`` +============== When inherited by a recipe, the :ref:`perlnative <ref-classes-perlnative>` class supports using the native version of Perl built by the build system rather than using the
@@ -2104,8 +2104,8 @@ version provided by the build host. .. _ref-classes-pypi: -``pypi.bbclass`` -================ +``pypi`` +======== The :ref:`pypi <ref-classes-pypi>` class sets variables appropriately for recipes that build Python modules from `PyPI <https://pypi.org/>`__, the Python Package Index.
@@ -2120,8 +2120,8 @@ and :term:`CVE_PRODUCT`. .. _ref-classes-python_flit_core: -``python_flit_core.bbclass`` -============================ +``python_flit_core`` +==================== The :ref:`python_flit_core <ref-classes-python_flit_core>` class enables building Python modules which declare the `PEP-517 <https://www.python.org/dev/peps/pep-0517/>`__ compliant
@@ -2135,8 +2135,8 @@ Internally this uses the :ref:`python_pep517 <ref-classes-python_pep517>` class. .. _ref-classes-python_pep517: -``python_pep517.bbclass`` -========================= +``python_pep517`` +================= The :ref:`python_pep517 <ref-classes-python_pep517>` class builds and installs a Python ``wheel`` binary archive (see `PEP-517 <https://peps.python.org/pep-0517/>`__).
@@ -2151,8 +2151,8 @@ Examples of classes which do this are :ref:`python_flit_core .. _ref-classes-python_poetry_core: -``python_poetry_core.bbclass`` -============================== +``python_poetry_core`` +====================== The :ref:`python_poetry_core <ref-classes-python_poetry_core>` class enables building Python modules which use the `Poetry Core <https://python-poetry.org>`__ build system.
@@ -2161,8 +2161,8 @@ Internally this uses the :ref:`python_pep517 <ref-classes-python_pep517>` class. .. _ref-classes-pixbufcache: -``pixbufcache.bbclass`` -======================= +``pixbufcache`` +=============== The :ref:`pixbufcache <ref-classes-pixbufcache>` class generates the proper post-install and post-remove (postinst/postrm) scriptlets for packages that install
@@ -2179,8 +2179,8 @@ containing the loaders. .. _ref-classes-pkgconfig: -``pkgconfig.bbclass`` -===================== +``pkgconfig`` +============= The :ref:`pkgconfig <ref-classes-pkgconfig>` class provides a standard way to get header and library information by using ``pkg-config``. This class aims to smooth
@@ -2193,8 +2193,8 @@ files. .. _ref-classes-populate-sdk: -``populate_sdk.bbclass`` -======================== +``populate_sdk`` +================ The :ref:`populate_sdk <ref-classes-populate-sdk>` class provides support for SDK-only recipes. For information on advantages gained when building a cross-development
@@ -2205,8 +2205,8 @@ Software Development Kit (eSDK) manual. .. _ref-classes-populate-sdk-*: -``populate_sdk_*.bbclass`` -========================== +``populate_sdk_*`` +================== The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` classes support SDK creation and consist of the following classes:
@@ -2262,8 +2262,8 @@ Software Development Kit (eSDK) manual. .. _ref-classes-prexport: -``prexport.bbclass`` -==================== +``prexport`` +============ The :ref:`prexport <ref-classes-prexport>` class provides functionality for exporting :term:`PR` values.
@@ -2275,8 +2275,8 @@ The :ref:`prexport <ref-classes-prexport>` class provides functionality for expo .. _ref-classes-primport: -``primport.bbclass`` -==================== +``primport`` +============ The :ref:`primport <ref-classes-primport>` class provides functionality for importing :term:`PR` values.
@@ -2288,8 +2288,8 @@ The :ref:`primport <ref-classes-primport>` class provides functionality for impo .. _ref-classes-prserv: -``prserv.bbclass`` -================== +``prserv`` +========== The :ref:`prserv <ref-classes-prserv>` class provides functionality for using a :ref:`PR service <dev-manual/packages:working with a pr service>` in order to
@@ -2303,8 +2303,8 @@ build system will not enable the functionality of this class unless .. _ref-classes-ptest: -``ptest.bbclass`` -================= +``ptest`` +========= The :ref:`ptest <ref-classes-ptest>` class provides functionality for packaging and installing runtime tests for recipes that build software that provides these tests.
@@ -2318,8 +2318,8 @@ on ptest. .. _ref-classes-ptest-gnome: -``ptest-gnome.bbclass`` -======================= +``ptest-gnome`` +=============== Enables package tests (ptests) specifically for GNOME packages, which have tests intended to be executed with ``gnome-desktop-testing``.
@@ -2330,16 +2330,16 @@ section in the Yocto Project Development Tasks Manual. .. _ref-classes-python3-dir: -``python3-dir.bbclass`` -======================= +``python3-dir`` +=============== The :ref:`python3-dir <ref-classes-python3-dir>` class provides the base version, location, and site package location for Python 3. .. _ref-classes-python3native: -``python3native.bbclass`` -========================= +``python3native`` +================= The :ref:`python3native <ref-classes-python3native>` class supports using the native version of Python 3 built by the build system rather than support of the version provided
@@ -2347,8 +2347,8 @@ by the build host. .. _ref-classes-python3targetconfig: -``python3targetconfig.bbclass`` -=============================== +``python3targetconfig`` +======================= The :ref:`python3targetconfig <ref-classes-python3targetconfig>` class supports using the native version of Python 3 built by the build system rather than support of the version provided
@@ -2359,8 +2359,8 @@ in order to avoid unnecessarily lengthening builds. .. _ref-classes-qemu: -``qemu.bbclass`` -================ +``qemu`` +======== The :ref:`qemu <ref-classes-qemu>` class provides functionality for recipes that either need QEMU or test for the existence of QEMU. Typically, this class is used to
@@ -2369,8 +2369,8 @@ application emulation mode. .. _ref-classes-recipe_sanity: -``recipe_sanity.bbclass`` -========================= +``recipe_sanity`` +================= The :ref:`recipe_sanity <ref-classes-recipe_sanity>` class checks for the presence of any host system recipe prerequisites that might affect the build (e.g. variables that
@@ -2378,8 +2378,8 @@ are set or software that is present). .. _ref-classes-relocatable: -``relocatable.bbclass`` -======================= +``relocatable`` +=============== The :ref:`relocatable <ref-classes-relocatable>` class enables relocation of binaries when they are installed into the sysroot.
@@ -2390,8 +2390,8 @@ and is used by both the :ref:`cross <ref-classes-cross>` and .. _ref-classes-remove-libtool: -``remove-libtool.bbclass`` -========================== +``remove-libtool`` +================== The :ref:`remove-libtool <ref-classes-remove-libtool>` class adds a post function to the :ref:`ref-tasks-install` task to remove all ``.la`` files
@@ -2409,8 +2409,8 @@ override the removal by setting ``REMOVE_LIBTOOL_LA`` to "0" as follows:: .. _ref-classes-report-error: -``report-error.bbclass`` -======================== +``report-error`` +================ The :ref:`report-error <ref-classes-report-error>` class supports enabling the :ref:`error reporting tool <dev-manual/error-reporting-tool:using the error reporting tool>`",
@@ -2424,8 +2424,8 @@ are created and stored in .. _ref-classes-rm-work: -``rm_work.bbclass`` -=================== +``rm_work`` +=========== The :ref:`rm_work <ref-classes-rm-work>` class supports deletion of temporary workspace, which can ease your hard drive demands during builds.
@@ -2454,8 +2454,8 @@ can also be set in your ``local.conf`` file. Here is an example:: .. _ref-classes-rootfs*: -``rootfs*.bbclass`` -=================== +``rootfs*`` +=========== The :ref:`rootfs* <ref-classes-rootfs*>` classes support creating the root filesystem for an image and consist of the following classes:
@@ -2485,8 +2485,8 @@ section in the Yocto Project Overview and Concepts Manual. .. _ref-classes-sanity: -``sanity.bbclass`` -================== +``sanity`` +========== The :ref:`sanity <ref-classes-sanity>` class checks to see if prerequisite software is present on the host system so that users can be notified of potential problems
@@ -2497,8 +2497,8 @@ usually determines whether to include this class. .. _ref-classes-scons: -``scons.bbclass`` -================= +``scons`` +========= The :ref:`scons <ref-classes-scons>` class supports recipes that need to build software that uses the SCons build system. You can use the
@@ -2507,16 +2507,16 @@ additional configuration options you want to pass SCons command line. .. _ref-classes-sdl: -``sdl.bbclass`` -=============== +``sdl`` +======= The :ref:`sdl <ref-classes-sdl>` class supports recipes that need to build software that uses the Simple DirectMedia Layer (SDL) library. .. _ref-classes-python_setuptools_build_meta: -``python_setuptools_build_meta.bbclass`` -======================================== +``python_setuptools_build_meta`` +================================ The :ref:`python_setuptools_build_meta <ref-classes-python_setuptools_build_meta>` class enables building Python modules which declare the
@@ -2531,8 +2531,8 @@ Internally this uses the :ref:`python_pep517 <ref-classes-python_pep517>` class. .. _ref-classes-setuptools3: -``setuptools3.bbclass`` -======================= +``setuptools3`` +=============== The :ref:`setuptools3 <ref-classes-setuptools3>` class supports Python version 3.x extensions that use build systems based on ``setuptools`` (e.g. only have a ``setup.py`` and
@@ -2561,8 +2561,8 @@ uses these build systems, the recipe needs to inherit the :ref:`setuptools3 <ref .. _ref-classes-setuptools3_legacy: -``setuptools3_legacy.bbclass`` -============================== +``setuptools3_legacy`` +====================== The :ref:`setuptools3_legacy <ref-classes-setuptools3_legacy>` class supports Python version 3.x extensions that use build systems based on ``setuptools``
@@ -2575,8 +2575,8 @@ but still relatively common. .. _ref-classes-setuptools3-base: -``setuptools3-base.bbclass`` -============================ +``setuptools3-base`` +==================== The :ref:`setuptools3-base <ref-classes-setuptools3-base>` class provides a reusable base for other classes that support building Python version 3.x extensions. If you need
@@ -2586,15 +2586,15 @@ in the :ref:`setuptools3 <ref-classes-setuptools3>` class and inherit this class .. _ref-classes-sign_rpm: -``sign_rpm.bbclass`` -==================== +``sign_rpm`` +============ The :ref:`sign_rpm <ref-classes-sign_rpm>` class supports generating signed RPM packages. .. _ref-classes-siteconfig: -``siteconfig.bbclass`` -====================== +``siteconfig`` +============== The :ref:`siteconfig <ref-classes-siteconfig>` class provides functionality for handling site configuration. The class is used by the
@@ -2603,8 +2603,8 @@ configuration. The class is used by the .. _ref-classes-siteinfo: -``siteinfo.bbclass`` -==================== +``siteinfo`` +============ The :ref:`siteinfo <ref-classes-siteinfo>` class provides information about the targets that might be needed by other classes or recipes.
@@ -2624,8 +2624,8 @@ The class also provides variables like :term:`SITEINFO_ENDIANNESS` and .. _ref-classes-sstate: -``sstate.bbclass`` -================== +``sstate`` +========== The :ref:`sstate <ref-classes-sstate>` class provides support for Shared State (sstate). By default, the class is enabled through the
@@ -2637,8 +2637,8 @@ section in the Yocto Project Overview and Concepts Manual. .. _ref-classes-staging: -``staging.bbclass`` -=================== +``staging`` +=========== The :ref:`staging <ref-classes-staging>` class installs files into individual recipe work directories for sysroots. The class contains the following key tasks:
@@ -2737,8 +2737,8 @@ stages: .. _ref-classes-syslinux: -``syslinux.bbclass`` -==================== +``syslinux`` +============ The :ref:`syslinux <ref-classes-syslinux>` class provides syslinux-specific functions for building bootable images.
@@ -2780,8 +2780,8 @@ The class supports the following variables: .. _ref-classes-systemd: -``systemd.bbclass`` -=================== +``systemd`` +=========== The :ref:`systemd <ref-classes-systemd>` class provides support for recipes that install systemd unit files.
@@ -2815,8 +2815,8 @@ section in the Yocto Project Development Tasks Manual. .. _ref-classes-systemd-boot: -``systemd-boot.bbclass`` -======================== +``systemd-boot`` +================ The :ref:`systemd-boot <ref-classes-systemd-boot>` class provides functions specific to the systemd-boot bootloader for building bootable images. This is an
@@ -2842,8 +2842,8 @@ for more information. .. _ref-classes-terminal: -``terminal.bbclass`` -==================== +``terminal`` +============ The :ref:`terminal <ref-classes-terminal>` class provides support for starting a terminal session. The :term:`OE_TERMINAL` variable controls which
@@ -2859,8 +2859,8 @@ class. .. _ref-classes-testimage: -``testimage.bbclass`` -===================== +``testimage`` +============= The :ref:`testimage <ref-classes-testimage>` class supports running automated tests against images using QEMU and on actual hardware. The classes handle loading the
@@ -2890,8 +2890,8 @@ section in the Yocto Project Development Tasks Manual. .. _ref-classes-testsdk: -``testsdk.bbclass`` -=================== +``testsdk`` +=========== This class supports running automated tests against software development kits (SDKs). The :ref:`testsdk <ref-classes-testsdk>` class runs tests on an SDK when called
@@ -2907,8 +2907,8 @@ using the following:: .. _ref-classes-texinfo: -``texinfo.bbclass`` -=================== +``texinfo`` +=========== This class should be inherited by recipes whose upstream packages invoke the ``texinfo`` utilities at build-time. Native and cross recipes are
@@ -2925,8 +2925,8 @@ host system. .. _ref-classes-toaster: -``toaster.bbclass`` -=================== +``toaster`` +=========== The :ref:`toaster <ref-classes-toaster>` class collects information about packages and images and sends them as events that the BitBake user interface can receive. The
@@ -2936,16 +2936,16 @@ This class is not intended to be used directly. .. _ref-classes-toolchain-scripts: -``toolchain-scripts.bbclass`` -============================= +``toolchain-scripts`` +===================== The :ref:`toolchain-scripts <ref-classes-toolchain-scripts>` class provides the scripts used for setting up the environment for installed SDKs. .. _ref-classes-typecheck: -``typecheck.bbclass`` -===================== +``typecheck`` +============= The :ref:`typecheck <ref-classes-typecheck>` class provides support for validating the values of variables set at the configuration level against their defined types.
@@ -2956,8 +2956,8 @@ variable using the "type" varflag. Here is an example:: .. _ref-classes-uboot-config: -``uboot-config.bbclass`` -======================== +``uboot-config`` +================ The :ref:`uboot-config <ref-classes-uboot-config>` class provides support for U-Boot configuration for a machine. Specify the machine in your recipe as follows::
@@ -2974,8 +2974,8 @@ information. .. _ref-classes-uninative: -``uninative.bbclass`` -===================== +``uninative`` +============= Attempts to isolate the build system from the host distribution's C library in order to make re-use of native shared state artifacts across
@@ -2996,8 +2996,8 @@ and the resulting tarball is included within the SDK. .. _ref-classes-update-alternatives: -``update-alternatives.bbclass`` -=============================== +``update-alternatives`` +======================= The :ref:`update-alternatives <ref-classes-update-alternatives>` class helps the alternatives system when multiple sources provide the same command. This situation occurs when
@@ -3034,8 +3034,8 @@ file. .. _ref-classes-update-rc.d: -``update-rc.d.bbclass`` -======================= +``update-rc.d`` +=============== The :ref:`update-rc.d <ref-classes-update-rc.d>` class uses ``update-rc.d`` to safely install an initialization script on behalf of the package. The OpenEmbedded build
@@ -3048,8 +3048,8 @@ for details. .. _ref-classes-useradd: -``useradd*.bbclass`` -==================== +``useradd*`` +============ The :ref:`useradd* <ref-classes-useradd>` classes support the addition of users or groups for usage by the package on the target. For example, if you have packages
@@ -3103,8 +3103,8 @@ additional information. .. _ref-classes-utility-tasks: -``utility-tasks.bbclass`` -========================= +``utility-tasks`` +================= The :ref:`utility-tasks <ref-classes-utility-tasks>` class provides support for various "utility" type tasks that are applicable to all recipes, such as
@@ -3116,8 +3116,8 @@ This class is enabled by default because it is inherited by the .. _ref-classes-utils: -``utils.bbclass`` -================= +``utils`` +========= The :ref:`utils <ref-classes-utils>` class provides some useful Python functions that are typically used in inline Python expressions (e.g. ``${@...}``). One
@@ -3128,16 +3128,16 @@ This class is enabled by default because it is inherited by the .. _ref-classes-vala: -``vala.bbclass`` -================ +``vala`` +======== The :ref:`vala <ref-classes-vala>` class supports recipes that need to build software written using the Vala programming language. .. _ref-classes-waf: -``waf.bbclass`` -=============== +``waf`` +======= The :ref:`waf <ref-classes-waf>` class supports recipes that need to build software that uses the Waf build system. You can use the
Signature · 1 line
2.37.2
PATCH 2/2 manuals: simplify references to classes
From: Michael Opdenacker <[email protected]>
Now that .bbclass is removed from class section titles. We can now have, for example, :ref:ref-classes-insane instead of :ref:insane <ref-classes-insane>.
Then, when necessary, rework paragraphs so that they have even lines of even length, not exceeding 80 characters.
--- documentation/bsp-guide/bsp.rst | 2 +- documentation/dev-manual/build-quality.rst | 12 +- documentation/dev-manual/building.rst | 15 +- documentation/dev-manual/debugging.rst | 8 +- documentation/dev-manual/disk-space.rst | 3 +- .../dev-manual/error-reporting-tool.rst | 6 +- .../dev-manual/gobject-introspection.rst | 4 +- documentation/dev-manual/licenses.rst | 19 +- documentation/dev-manual/new-recipe.rst | 85 +-- documentation/dev-manual/packages.rst | 16 +- documentation/dev-manual/quilt.rst | 4 +- documentation/dev-manual/read-only-rootfs.rst | 2 +- documentation/dev-manual/runtime-testing.rst | 4 +- documentation/dev-manual/sbom.rst | 4 +- documentation/dev-manual/securing-images.rst | 8 +- .../dev-manual/speeding-up-build.rst | 3 +- .../dev-manual/upgrading-recipes.rst | 3 +- documentation/dev-manual/vulnerabilities.rst | 10 +- documentation/dev-manual/wic.rst | 3 +- documentation/kernel-dev/common.rst | 10 +- .../migration-guides/migration-1.3.rst | 12 +- .../migration-guides/migration-1.5.rst | 9 +- .../migration-guides/migration-1.6.rst | 13 +- .../migration-guides/migration-1.7.rst | 13 +- .../migration-guides/migration-1.8.rst | 28 +- .../migration-guides/migration-2.0.rst | 2 +- .../migration-guides/migration-2.1.rst | 32 +- .../migration-guides/migration-2.3.rst | 22 +- .../migration-guides/migration-2.4.rst | 12 +- .../migration-guides/migration-2.5.rst | 10 +- .../migration-guides/migration-2.6.rst | 18 +- .../migration-guides/migration-2.7.rst | 3 +- .../migration-guides/migration-3.0.rst | 6 +- .../migration-guides/migration-3.1.rst | 6 +- .../migration-guides/migration-3.2.rst | 33 +- .../migration-guides/migration-3.3.rst | 17 +- .../migration-guides/migration-3.4.rst | 4 +- .../migration-guides/migration-4.0.rst | 21 +- .../migration-guides/migration-4.1.rst | 10 +- .../migration-guides/migration-general.rst | 14 +- .../migration-guides/release-notes-3.4.rst | 4 +- .../migration-guides/release-notes-4.0.rst | 11 +- .../migration-guides/release-notes-4.1.rst | 30 +- documentation/overview-manual/concepts.rst | 58 +- documentation/ref-manual/classes.rst | 611 ++++++++-------- documentation/ref-manual/features.rst | 2 +- documentation/ref-manual/qa-checks.rst | 12 +- documentation/ref-manual/structure.rst | 4 +- documentation/ref-manual/tasks.rst | 10 +- documentation/ref-manual/variables.rst | 690 ++++++++---------- .../sdk-manual/appendix-customizing.rst | 3 +- documentation/sdk-manual/extensible.rst | 5 +- documentation/test-manual/intro.rst | 18 +- .../test-manual/understand-autobuilder.rst | 2 +- 54 files changed, 930 insertions(+), 1036 deletions(-)
documentation/bsp-guide/bsp.rst +1 -1
@@ -1365,7 +1365,7 @@ Project Reference Manual. - :term:`IMAGE_INSTALL`: Specifies packages to install into an image through the - :ref:`image <ref-classes-image>` class. Recipes + :ref:`ref-classes-image` class. Recipes use the :term:`IMAGE_INSTALL` variable. - ``do_image_wic[depends]``: A task that is constructed during the
documentation/dev-manual/build-quality.rst +5 -7
@@ -14,13 +14,11 @@ has already been built when the software is building, the software will link to the built library and that library will be pulled into your image along with the new software even if you did not want the library. -The :ref:`buildhistory <ref-classes-buildhistory>` -class helps you maintain the quality of your build output. You -can use the class to highlight unexpected and possibly unwanted changes -in the build output. When you enable build history, it records -information about the contents of each package and image and then -commits that information to a local Git repository where you can examine -the information. +The :ref:`ref-classes-buildhistory` class helps you maintain the quality of +your build output. You can use the class to highlight unexpected and possibly +unwanted changes in the build output. When you enable build history, it records +information about the contents of each package and image and then commits that +information to a local Git repository where you can examine the information. The remainder of this section describes the following:
documentation/dev-manual/building.rst +7 -8
@@ -295,8 +295,8 @@ Follow these steps to create an :term:`Initramfs` image: recipe, you should use :term:`PACKAGE_INSTALL` rather than :term:`IMAGE_INSTALL`. :term:`PACKAGE_INSTALL` gives more direct control of what is added to the image as compared to the defaults you might not - necessarily want that are set by the :ref:`image <ref-classes-image>` - or :ref:`core-image <ref-classes-core-image>` classes. + necessarily want that are set by the :ref:`ref-classes-image` + or :ref:`ref-classes-core-image` classes. #. *Build the Kernel Image and the Initramfs Image:* Build your kernel image using BitBake. Because the :term:`Initramfs` image recipe is a
@@ -683,7 +683,7 @@ your tunings to best consider build times and package feed maintenance. A recipe that just generates scripts can enable "all" architecture because there are no binaries to build. To specifically enable "all" architecture, be sure your recipe inherits the - :ref:`allarch <ref-classes-allarch>` class. + :ref:`ref-classes-allarch` class. This class is useful for "all" architectures because it configures many variables so packages can be used across multiple architectures.
@@ -796,7 +796,7 @@ where the development occurs. You want the recipe's the external directory and use it as is, not copy it. To build from software that comes from an external source, all you need to do -is inherit the :ref:`externalsrc <ref-classes-externalsrc>` class and then set +is inherit the :ref:`ref-classes-externalsrc` class and then set the :term:`EXTERNALSRC` variable to point to your external source code. Here are the statements to put in your ``local.conf`` file::
@@ -812,8 +812,7 @@ This next example shows how to accomplish the same thing by setting .. note:: In order for these settings to take effect, you must globally or - locally inherit the :ref:`externalsrc <ref-classes-externalsrc>` - class. + locally inherit the :ref:`ref-classes-externalsrc` class. By default, :ref:`ref-classes-externalsrc` builds the source code in a directory separate from the external source directory as specified by
@@ -881,14 +880,14 @@ directory: #. *Using Local Files Only:* Inside your ``local.conf`` file, add the :term:`SOURCE_MIRROR_URL` variable, inherit the - :ref:`own-mirrors <ref-classes-own-mirrors>` class, and use the + :ref:`ref-classes-own-mirrors` class, and use the :term:`BB_NO_NETWORK` variable to your ``local.conf``:: SOURCE_MIRROR_URL ?= "file:///home/your-download-dir/" INHERIT += "own-mirrors" BB_NO_NETWORK = "1" - The :term:`SOURCE_MIRROR_URL` and :ref:`own-mirrors <ref-classes-own-mirrors>` + The :term:`SOURCE_MIRROR_URL` and :ref:`ref-classes-own-mirrors` class set up the system to use the downloads directory as your "own mirror". Using the :term:`BB_NO_NETWORK` variable makes sure that BitBake's fetching process in step 3 stays local, which means files
documentation/dev-manual/debugging.rst +3 -5
@@ -153,7 +153,7 @@ In addition to variable values, the output of the ``bitbake -e`` and classes included globally, recursively listing the files they include or inherit in turn. Much of the behavior of the OpenEmbedded build system (including the behavior of the :ref:`ref-manual/tasks:normal recipe build tasks`) is - implemented in the :ref:`base <ref-classes-base>` class and the + implemented in the :ref:`ref-classes-base` class and the classes it inherits, rather than being built into BitBake itself. - After the variable values, all functions appear in the output. For
@@ -196,8 +196,7 @@ Following are a few of the available ``oe-pkgdata-util`` subcommands. which contains the files stored in that package. If you want to inspect the ``${WORKDIR}/packages-split`` - directory, make sure that - :ref:`rm_work <ref-classes-rm-work>` is not + directory, make sure that :ref:`ref-classes-rm-work` is not enabled when you build the recipe. - ``oe-pkgdata-util find-path path ...``: Lists the names of
@@ -598,8 +597,7 @@ log to ``${T}/log.do_``\ `task`, and can also log to standard output The same logging functions are also available in shell functions, under the names ``bbplain``, ``bbnote``, ``bbdebug``, ``bbwarn``, ``bberror``, -and ``bbfatal``. The -:ref:`logging <ref-classes-logging>` class +and ``bbfatal``. The :ref:`ref-classes-logging` class implements these functions. See that class in the ``meta/classes`` folder of the :term:`Source Directory` for information.
documentation/dev-manual/disk-space.rst +1 -2
@@ -14,8 +14,7 @@ the :term:`Build Directory`:: Adding this statement deletes the work directory used for building a recipe once the recipe is built. For more information on -"rm_work", see the -:ref:`rm_work <ref-classes-rm-work>` class in the +"rm_work", see the :ref:`ref-classes-rm-work` class in the Yocto Project Reference Manual. Purging Duplicate Shared State Cache Files
documentation/dev-manual/error-reporting-tool.rst +3 -3
@@ -27,9 +27,9 @@ Enabling and Using the Tool =========================== By default, the error reporting tool is disabled. You can enable it by -inheriting the :ref:`report-error <ref-classes-report-error>` -class by adding the following statement to the end of your -``local.conf`` file in your :term:`Build Directory`:: +inheriting the :ref:`ref-classes-report-error` class by adding the +following statement to the end of your ``local.conf`` file in your +:term:`Build Directory`:: INHERIT += "report-error"
documentation/dev-manual/gobject-introspection.rst +1 -3
@@ -39,9 +39,7 @@ Enabling the Generation of Introspection Data Enabling the generation of introspection data (GIR files) in your library package involves the following: -#. Inherit the - :ref:`gobject-introspection <ref-classes-gobject-introspection>` - class. +#. Inherit the :ref:`ref-classes-gobject-introspection` class. #. Make sure introspection is not disabled anywhere in the recipe or from anything the recipe includes. Also, make sure that
documentation/dev-manual/licenses.rst +9 -10
@@ -325,13 +325,12 @@ and not just the source used in the released image. It will include toolchain source, and other artifacts, which you would not generally release. However, the more serious issue for most companies is accidental release of proprietary software. The Yocto Project provides -an :ref:`archiver <ref-classes-archiver>` class to -help avoid some of these concerns. +an :ref:`ref-classes-archiver` class to help avoid some of these concerns. -Before you employ :term:`DL_DIR` or the :ref:`archiver <ref-classes-archiver>` class, you need to -decide how you choose to provide source. The source :ref:`archiver <ref-classes-archiver>` class -can generate tarballs and SRPMs and can create them with various levels -of compliance in mind. +Before you employ :term:`DL_DIR` or the :ref:`ref-classes-archiver` class, you +need to decide how you choose to provide source. The source +:ref:`ref-classes-archiver` class can generate tarballs and SRPMs and can +create them with various levels of compliance in mind. One way of doing this (but certainly not the only way) is to release just the source as a tarball. You can do this by adding the following to
@@ -417,8 +416,8 @@ generation are included on your image. adds a separate package and an upgrade path for adding licenses to an image. -As the source :ref:`archiver <ref-classes-archiver>` class has already archived the original -unmodified source that contains the license files, you would have +As the source :ref:`ref-classes-archiver` class has already archived the +original unmodified source that contains the license files, you would have already met the requirements for inclusion of the license information with source as defined by the GPL and other open source licenses.
@@ -488,8 +487,8 @@ mechanisms as well as explicitly included in the image recipe with :term:`IMAGE_INSTALL`, and depends on a static linked library recipe B (``DEPENDS += "B"``), package B will neither appear in the generated license manifest nor in the generated source tarballs. This occurs as the -:ref:`license <ref-classes-license>` and :ref:`archiver <ref-classes-archiver>` -classes assume that only packages included via :term:`RDEPENDS` or :term:`RRECOMMENDS` +:ref:`ref-classes-license` and :ref:`ref-classes-archiver` classes assume that +only packages included via :term:`RDEPENDS` or :term:`RRECOMMENDS` end up in the image. As a result, potential obligations regarding license compliance for package B
documentation/dev-manual/new-recipe.rst +37 -48
164 lines not on this page · raw message
documentation/dev-manual/packages.rst +7 -9
@@ -643,8 +643,7 @@ Lighttpd, or Nginx), take the appropriate steps to do so. From within the :term:`Build Directory` where you have built an image based on your packaging choice (i.e. the :term:`PACKAGE_CLASSES` setting), simply start the server. The following example assumes a :term:`Build Directory` of ``poky/build`` -and a :term:`PACKAGE_CLASSES` setting of -":ref:`package_rpm <ref-classes-package_rpm>`":: +and a :term:`PACKAGE_CLASSES` setting of ":ref:`ref-classes-package_rpm`":: $ cd poky/build/tmp/deploy/rpm $ python3 -m http.server
@@ -909,8 +908,8 @@ see the :yocto_wiki:`Ptest </Ptest>` wiki page. .. note:: - A recipe is "ptest-enabled" if it inherits the - :ref:`ptest <ref-classes-ptest>` class. + A recipe is "ptest-enabled" if it inherits the :ref:`ref-classes-ptest` + class. Adding ptest to Your Build --------------------------
@@ -940,7 +939,7 @@ In order to enable a recipe to run installed ptests on target hardware, you need to prepare the recipes that build the packages you want to test. Here is what you have to do for each recipe: -- *Be sure the recipe inherits the* :ref:`ptest <ref-classes-ptest>` *class:* +- *Be sure the recipe inherits the* :ref:`ref-classes-ptest` *class:* Include the following line in each recipe:: inherit ptest
@@ -991,7 +990,7 @@ test. Here is what you have to do for each recipe: special configurations prior to compiling the test code, you must insert a ``do_configure_ptest`` function into the recipe. -- *Install the test suite:* The :ref:`ptest <ref-classes-ptest>` class +- *Install the test suite:* The :ref:`ref-classes-ptest` class automatically copies the file ``run-ptest`` to the target and then runs make ``install-ptest`` to run the tests. If this is not enough, you need to create a ``do_install_ptest`` function and make sure it gets
@@ -1145,9 +1144,8 @@ Here are three key points in the previous example: sub-module's license is unavailable, the sub-module's name appears in the comments. -- The ``inherit npm`` statement causes the - :ref:`npm <ref-classes-npm>` class to package - up all the modules. +- The ``inherit npm`` statement causes the :ref:`ref-classes-npm` class to + package up all the modules. You can run the following command to build the ``cute-files`` package::
documentation/dev-manual/quilt.rst +2 -2
@@ -12,7 +12,7 @@ form of a patch all using Quilt. .. note:: With regard to preserving changes to source files, if you clean a - recipe or have :ref:`rm_work <ref-classes-rm-work>` enabled, the + recipe or have :ref:`ref-classes-rm-work` enabled, the :ref:`devtool workflow <sdk-manual/extensible:using \`\`devtool\`\` in your sdk workflow>` as described in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual is a safer
@@ -61,7 +61,7 @@ Follow these general steps: once you run the :ref:`ref-tasks-clean` or :ref:`ref-tasks-cleanall` tasks using BitBake (i.e. ``bitbake -c clean package`` and ``bitbake -c cleanall package``). Modifications will also disappear if - you use the :ref:`rm_work <ref-classes-rm-work>` feature as described in + you use the :ref:`ref-classes-rm-work` feature as described in the ":ref:`dev-manual/disk-space:conserving disk space during builds`" section.
documentation/dev-manual/read-only-rootfs.rst +1 -1
@@ -76,7 +76,7 @@ from running during root filesystem creation: native tools, which run on the host system, to accomplish the same tasks, or by alternatively running the processes under QEMU, which has the ``qemu_run_binary`` function. For more information, see the - :ref:`qemu <ref-classes-qemu>` class. + :ref:`ref-classes-qemu` class. Areas With Write Access =======================
documentation/dev-manual/runtime-testing.rst +2 -2
@@ -332,8 +332,8 @@ You can start the tests automatically or manually: bitbake core-image-sato - *Manually running tests:* To manually run the tests, first globally - inherit the :ref:`testimage <ref-classes-testimage>` class - by editing your ``local.conf`` file:: + inherit the :ref:`ref-classes-testimage` class by editing your + ``local.conf`` file:: INHERIT += "testimage"
documentation/dev-manual/sbom.rst +2 -2
@@ -26,7 +26,7 @@ assessments, as all the components used in the Software Supply Chain are listed. The OpenEmbedded build system doesn't generate such information by default. To make this happen, you must inherit the -:ref:`create-spdx <ref-classes-create-spdx>` class from a configuration file:: +:ref:`ref-classes-create-spdx` class from a configuration file:: INHERIT += "create-spdx"
@@ -39,7 +39,7 @@ containing an index of JSON :term:`SPDX` files for individual recipes, together with an ``IMAGE-MACHINE.spdx.tar.zst`` compressed archive containing all such files. -The :ref:`create-spdx <ref-classes-create-spdx>` class offers options to include +The :ref:`ref-classes-create-spdx` class offers options to include more information in the output :term:`SPDX` data, such as making the generated files more human readable (:term:`SPDX_PRETTY`), adding compressed archives of the files in the generated target packages (:term:`SPDX_ARCHIVE_PACKAGED`),
documentation/dev-manual/securing-images.rst +3 -5
@@ -128,11 +128,9 @@ system to make your images more secure: service type users). When you set up passwords for multiple images or users, you should not duplicate passwords. - To set up passwords, use the - :ref:`extrausers <ref-classes-extrausers>` - class, which is the preferred method. For an example on how to set up - both root and user passwords, see the - ":ref:`ref-classes-extrausers`" section. + To set up passwords, use the :ref:`ref-classes-extrausers` class, which + is the preferred method. For an example on how to set up both root and + user passwords, see the ":ref:`ref-classes-extrausers`" section. .. note::
documentation/dev-manual/speeding-up-build.rst +1 -2
@@ -61,8 +61,7 @@ Following are additional factors that can affect build speed: file system on the principle that if there was a significant failure, the :term:`Build Directory` contents could easily be rebuilt. -- Inheriting the - :ref:`rm_work <ref-classes-rm-work>` class: +- Inheriting the :ref:`ref-classes-rm-work` class: Inheriting this class has shown to speed up builds due to significantly lower amounts of data stored in the data cache as well as on disk. Inheriting this class also makes cleanup of
documentation/dev-manual/upgrading-recipes.rst +1 -2
@@ -113,8 +113,7 @@ The following steps describe how to set up the AUH utility: ``upgrade-helper/work/recipe/buildhistory-diff.txt`` file found in your :term:`Build Directory`. - - If you want to enable testing through the - :ref:`testimage <ref-classes-testimage>` + - If you want to enable testing through the :ref:`ref-classes-testimage` class, which is optional, you need to have the following set in your ``conf/local.conf`` file::
documentation/dev-manual/vulnerabilities.rst +5 -5
@@ -27,8 +27,9 @@ patches to fix them, see ":ref:`dev-manual/changes:submitting a change to the yo Vulnerability check at build time ================================= -To enable a check for CVE security vulnerabilities using :ref:`cve-check <ref-classes-cve-check>` in the specific image -or target you are building, add the following setting to your configuration:: +To enable a check for CVE security vulnerabilities using +:ref:`ref-classes-cve-check` in the specific image or target you are building, +add the following setting to your configuration:: INHERIT += "cve-check"
@@ -100,7 +101,7 @@ It is also possible to check the CVE status of individual packages as follows:: Fixing CVE product name and version mappings ============================================ -By default, :ref:`cve-check <ref-classes-cve-check>` uses the recipe name :term:`BPN` as CVE +By default, :ref:`ref-classes-cve-check` uses the recipe name :term:`BPN` as CVE product name when querying the CVE database. If this mapping contains false positives, e.g. some reported CVEs are not for the software component in question, or false negatives like some CVEs are not found to impact the recipe when they should, then the problems can be
@@ -167,8 +168,7 @@ the :term:`CVE_CHECK_SKIP_RECIPE` variable. Implementation details ====================== -Here's what the :ref:`cve-check <ref-classes-cve-check>` class does to -find unpatched CVE IDs. +Here's what the :ref:`ref-classes-cve-check` class does to find unpatched CVE IDs. First the code goes through each patch file provided by a recipe. If a valid CVE ID is found in the name of the file, the corresponding CVE is considered as patched.
documentation/dev-manual/wic.rst +1 -2
@@ -59,8 +59,7 @@ this information is required to use Wic, you might find it interesting. - Wic is a completely independent standalone utility that initially provides easier-to-use and more flexible replacements for an existing - functionality in OE-Core's - :ref:`image-live <ref-classes-image-live>` + functionality in OE-Core's :ref:`ref-classes-image-live` class. The difference between Wic and those examples is that with Wic the functionality of those scripts is implemented by a general-purpose partitioning language, which is based on Redhat
documentation/kernel-dev/common.rst +4 -6
@@ -1685,12 +1685,10 @@ looks much like the one provided with the ``hello-mod`` template:: ... The important point to note here is the :term:`KERNEL_SRC` variable. The -:ref:`module <ref-classes-module>` class sets this variable and the -:term:`KERNEL_PATH` variable to -``${STAGING_KERNEL_DIR}`` with the necessary Linux kernel build -information to build modules. If your module ``Makefile`` uses a -different variable, you might want to override the -:ref:`ref-tasks-compile` step, or +:ref:`ref-classes-module` class sets this variable and the :term:`KERNEL_PATH` +variable to ``${STAGING_KERNEL_DIR}`` with the necessary Linux kernel build +information to build modules. If your module ``Makefile`` uses a different +variable, you might want to override the :ref:`ref-tasks-compile` step, or create a patch to the ``Makefile`` to work with the more typical :term:`KERNEL_SRC` or :term:`KERNEL_PATH` variables.
documentation/migration-guides/migration-1.3.rst +6 -6
@@ -91,11 +91,11 @@ consistency. nativesdk ~~~~~~~~~ -The suffix ``nativesdk`` is now implemented as a prefix, which simplifies a -lot of the packaging code for :ref:`nativesdk <ref-classes-nativesdk>` recipes. -All custom :ref:`nativesdk <ref-classes-nativesdk>` recipes, which are -relocatable packages that are native to :term:`SDK_ARCH`, and any references -need to be updated to use ``nativesdk-*`` instead of ``*-nativesdk``. +The suffix ``nativesdk`` is now implemented as a prefix, which simplifies a lot +of the packaging code for :ref:`ref-classes-nativesdk` recipes. All custom +:ref:`ref-classes-nativesdk` recipes, which are relocatable packages that are +native to :term:`SDK_ARCH`, and any references need to be updated to use +``nativesdk-*`` instead of ``*-nativesdk``. .. _migration-1.3-task-recipes:
@@ -109,7 +109,7 @@ automatic upgrade path for most packages. However, you should update references in your own recipes and configurations as they could be removed in future releases. You should also rename any custom ``task-*`` recipes to ``packagegroup-*``, and change them to inherit -:ref:`packagegroup <ref-classes-packagegroup>` instead of ``task``, as well +:ref:`ref-classes-packagegroup` instead of ``task``, as well as taking the opportunity to remove anything now handled by :ref:`ref-classes-packagegroup`, such as providing ``-dev`` and ``-dbg`` packages, setting :term:`LIC_FILES_CHKSUM`, and so forth. See the
documentation/migration-guides/migration-1.5.rst +4 -5
@@ -95,9 +95,8 @@ The following changes have been made to the package QA checks: this file within :ref:`ref-tasks-install` if "make install" is installing it. -- If you are using the :ref:`buildhistory <ref-classes-buildhistory>` class, - the check for the package - version going backwards is now controlled using a standard QA check. +- If you are using the :ref:`ref-classes-buildhistory` class, the check for the + package version going backwards is now controlled using a standard QA check. Thus, if you have customized your :term:`ERROR_QA` or :term:`WARN_QA` values and still wish to have this check performed, you should add "version-going-backwards" to your value for one or the other
@@ -131,7 +130,7 @@ The following directory changes exist: it easier to delete :term:`TMPDIR` and preserve the build history. Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`. -- When :ref:`buildhistory <ref-classes-buildhistory>` is enabled, its output +- When :ref:`ref-classes-buildhistory` is enabled, its output is now written under the :term:`Build Directory` rather than :term:`TMPDIR`. Doing so makes it easier to delete :term:`TMPDIR` and preserve the build history. Additionally, data for produced SDKs is now split by :term:`IMAGE_NAME`.
@@ -223,7 +222,7 @@ Task Recipes The previously deprecated ``task.bbclass`` has now been dropped. For recipes that previously inherited from this class, you should rename them from ``task-*`` to ``packagegroup-*`` and inherit -:ref:`packagegroup <ref-classes-packagegroup>` instead. +:ref:`ref-classes-packagegroup` instead. For more information, see the ":ref:`ref-classes-packagegroup`" section.
documentation/migration-guides/migration-1.6.rst +6 -7
@@ -11,9 +11,8 @@ Project 1.6 Release (codename "daisy") from the prior release. ``archiver`` Class ------------------ -The :ref:`archiver <ref-classes-archiver>` class has been rewritten -and its configuration has been simplified. For more details on the -source archiver, see the +The :ref:`ref-classes-archiver` class has been rewritten and its configuration +has been simplified. For more details on the source archiver, see the ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecycle`" section in the Yocto Project Development Tasks Manual.
@@ -224,7 +223,7 @@ Package Tests (ptest) are built but not installed by default. For information on using Package Tests, see the ":ref:`dev-manual/packages:testing packages with ptest`" section in the Yocto Project Development Tasks Manual. For information on the -:ref:`ptest <ref-classes-ptest>` class, see the ":ref:`ref-classes-ptest`" +:ref:`ref-classes-ptest` class, see the ":ref:`ref-classes-ptest`" section. .. _migration-1.6-build-changes:
@@ -234,13 +233,13 @@ Build Changes Separate build and source directories have been enabled by default for selected recipes where it is known to work and for all -recipes that inherit the :ref:`cmake <ref-classes-cmake>` class. In -future releases the :ref:`autotools <ref-classes-autotools>` class +recipes that inherit the :ref:`ref-classes-cmake` class. In +future releases the :ref:`ref-classes-autotools` class will enable a separate :term:`Build Directory` by default as well. Recipes building Autotools-based software that fails to build with a separate :term:`Build Directory` should be changed to inherit from the :ref:`autotools-brokensep <ref-classes-autotools>` class instead of -the :ref:`autotools <ref-classes-autotools>` or ``autotools_stage`` classes. +the :ref:`ref-classes-autotools` or ``autotools_stage`` classes. .. _migration-1.6-building-qemu-native:
documentation/migration-guides/migration-1.7.rst +5 -8
@@ -41,13 +41,11 @@ section for more information. Autotools Class Changes ----------------------- -The following :ref:`autotools <ref-classes-autotools>` class changes -occurred: +The following :ref:`ref-classes-autotools` class changes occurred: - *A separate :term:`Build Directory` is now used by default:* The - :ref:`autotools <ref-classes-autotools>` class has been - changed to use a directory for building - (:term:`B`), which is separate from the source directory + :ref:`ref-classes-autotools` class has been changed to use a directory for + building (:term:`B`), which is separate from the source directory (:term:`S`). This is commonly referred to as ``B != S``, or an out-of-tree build.
@@ -56,9 +54,8 @@ occurred: However, if the software is not capable of being built in this manner, you will need to either patch the software so that it can build separately, or you will need to change the recipe to inherit - the :ref:`autotools-brokensep <ref-classes-autotools>` class - instead of the :ref:`autotools <ref-classes-autotools>` - or ``autotools_stage`` classes. + the :ref:`autotools-brokensep <ref-classes-autotools>` class instead + of the :ref:`ref-classes-autotools` or ``autotools_stage`` classes. - The ``--foreign`` option is no longer passed to ``automake`` when running ``autoconf``: This option tells ``automake`` that a
documentation/migration-guides/migration-1.8.rst +13 -15
@@ -70,17 +70,16 @@ the following:: Kernel Build Changes -------------------- -The kernel build process was changed to place the source in a common -shared work area and to place build artifacts separately in the source -code tree. In theory, migration paths have been provided for most common -usages in kernel recipes but this might not work in all cases. In -particular, users need to ensure that ``${S}`` (source files) and -``${B}`` (build artifacts) are used correctly in functions such as -:ref:`ref-tasks-configure` and -:ref:`ref-tasks-install`. For kernel recipes that do not -inherit from :ref:`kernel-yocto <ref-classes-kernel-yocto>` or include ``linux-yocto.inc``, you might -wish to refer to the ``linux.inc`` file in the ``meta-oe`` layer for the -kinds of changes you need to make. For reference, here is the +The kernel build process was changed to place the source in a common shared work +area and to place build artifacts separately in the source code tree. In theory, +migration paths have been provided for most common usages in kernel recipes but +this might not work in all cases. In particular, users need to ensure that +``${S}`` (source files) and ``${B}`` (build artifacts) are used correctly in +functions such as :ref:`ref-tasks-configure` and :ref:`ref-tasks-install`. For +kernel recipes that do not inherit from :ref:`ref-classes-kernel-yocto` or +include ``linux-yocto.inc``, you might wish to refer to the ``linux.inc`` file +in the ``meta-oe`` layer for the kinds of changes you need to make. For reference, +here is the :oe_git:`commit </meta-openembedded/commit/meta-oe/recipes-kernel/linux/linux.inc?id=fc7132ede27ac67669448d3d2845ce7d46c6a1ee>` where the ``linux.inc`` file in ``meta-oe`` was updated.
@@ -123,10 +122,9 @@ need to take corrective steps. Rebuild Improvements -------------------- -Changes have been made to the :ref:`base <ref-classes-base>`, -:ref:`autotools <ref-classes-autotools>`, and -:ref:`cmake <ref-classes-cmake>` classes to clean out generated files -when the :ref:`ref-tasks-configure` task needs to be +Changes have been made to the :ref:`ref-classes-base`, +:ref:`ref-classes-autotools`, and :ref:`ref-classes-cmake` classes to clean out +generated files when the :ref:`ref-tasks-configure` task needs to be re-executed. One of the improvements is to attempt to run "make clean" during the
documentation/migration-guides/migration-2.0.rst +1 -1
@@ -216,7 +216,7 @@ modifications synchronized, it is not always obvious to developers how to manipulate the Metadata as compared to the source. Metadata processing has now been removed from the -:ref:`kernel-yocto <ref-classes-kernel-yocto>` class and the external +:ref:`ref-classes-kernel-yocto` class and the external Metadata repository ``yocto-kernel-cache``, which has always been used to seed the ``linux-yocto`` "meta" branch. This separate ``linux-yocto`` cache repository is now the primary location for this data. Due to this
documentation/migration-guides/migration-2.1.rst +15 -17
@@ -66,7 +66,7 @@ Makefile Environment Changes :term:`EXTRA_OEMAKE` now defaults to "" instead of "-e MAKEFLAGS=". Setting :term:`EXTRA_OEMAKE` to "-e MAKEFLAGS=" by default was a historical accident that has required many classes (e.g. -:ref:`autotools <ref-classes-autotools>`, ``module``) and recipes to override this default in order +:ref:`ref-classes-autotools`, ``module``) and recipes to override this default in order to work with sensible build systems. When upgrading to the release, you must edit any recipe that relies upon this old default by either setting :term:`EXTRA_OEMAKE` back to "-e MAKEFLAGS=" or by explicitly setting any
@@ -100,7 +100,7 @@ breaking FHS. ``ac_cv_sizeof_off_t`` is No Longer Cached in Site Files -------------------------------------------------------- -For recipes inheriting the :ref:`autotools <ref-classes-autotools>` +For recipes inheriting the :ref:`ref-classes-autotools` class, ``ac_cv_sizeof_off_t`` is no longer cached in the site files for ``autoconf``. The reason for this change is because the ``ac_cv_sizeof_off_t`` value is not necessarily static per architecture
@@ -108,12 +108,12 @@ as was previously assumed. Rather, the value changes based on whether large file support is enabled. For most software that uses ``autoconf``, this change should not be a problem. However, if you have a recipe that bypasses the standard :ref:`ref-tasks-configure` task -from the :ref:`autotools <ref-classes-autotools>` class and the software the recipe is building +from the :ref:`ref-classes-autotools` class and the software the recipe is building uses a very old version of ``autoconf``, the recipe might be incapable of determining the correct size of ``off_t`` during :ref:`ref-tasks-configure`. The best course of action is to patch the software as necessary to allow -the default implementation from the :ref:`autotools <ref-classes-autotools>` class to work such +the default implementation from the :ref:`ref-classes-autotools` class to work such that ``autoreconf`` succeeds and produces a working configure script, and to remove the overridden :ref:`ref-tasks-configure` task such that the default implementation does get used.
@@ -138,9 +138,8 @@ should make edits so that those tasks are after the after :ref:`ref-tasks-rootfs` so that your added tasks run at the correct time. -A minor part of this restructuring is that the post-processing -definitions and functions have been moved from the -:ref:`image <ref-classes-image>` class to the +A minor part of this restructuring is that the post-processing definitions and +functions have been moved from the :ref:`ref-classes-image` class to the :ref:`rootfs-postcommands <ref-classes-rootfs*>` class. Functionally, however, they remain unchanged.
@@ -191,18 +190,17 @@ Class Changes The following classes have changed: - ``autotools_stage``: Removed because the - :ref:`autotools <ref-classes-autotools>` class now provides its + :ref:`ref-classes-autotools` class now provides its functionality. Recipes that inherited from ``autotools_stage`` should - now inherit from :ref:`autotools <ref-classes-autotools>` instead. + now inherit from :ref:`ref-classes-autotools` instead. - ``boot-directdisk``: Merged into the ``image-vm`` class. The ``boot-directdisk`` class was rarely directly used. Consequently, this change should not cause any issues. -- ``bootimg``: Merged into the - :ref:`image-live <ref-classes-image-live>` class. The ``bootimg`` - class was rarely directly used. Consequently, this change should not - cause any issues. +- ``bootimg``: Merged into the :ref:`ref-classes-image-live` class. The + ``bootimg`` class was rarely directly used. Consequently, this change should + not cause any issues. - ``packageinfo``: Removed due to its limited use by the Hob UI, which has itself been removed.
@@ -257,14 +255,14 @@ The following changes have been made for the Poky distribution: not need to change anything unless you are relying on this naming elsewhere. -- The :ref:`uninative <ref-classes-uninative>` class is now enabled +- The :ref:`ref-classes-uninative` class is now enabled by default in Poky. This class attempts to isolate the build system from the host distribution's C library and makes re-use of native shared state artifacts across different host distributions practical. With this class enabled, a tarball containing a pre-built C library is downloaded at the start of the build. - The :ref:`uninative <ref-classes-uninative>` class is enabled through the + The :ref:`ref-classes-uninative` class is enabled through the ``meta/conf/distro/include/yocto-uninative.inc`` file, which for those not using the Poky distribution, can include to easily enable the same functionality.
@@ -403,9 +401,9 @@ These additional changes exist: as these directories are automatically found and added. - Inaccurate disk and CPU percentage data has been dropped from - :ref:`buildstats <ref-classes-buildstats>` output. This data has been replaced with + :ref:`ref-classes-buildstats` output. This data has been replaced with ``getrusage()`` data and corrected IO statistics. You will probably - need to update any custom code that reads the :ref:`buildstats <ref-classes-buildstats>` data. + need to update any custom code that reads the :ref:`ref-classes-buildstats` data. - The ``meta/conf/distro/include/package_regex.inc`` is now deprecated. The contents of this file have been moved to individual recipes.
documentation/migration-guides/migration-2.3.rst +10 -12
@@ -52,7 +52,7 @@ Consider the following: post-installation script that is installed by a function added to :term:`SYSROOT_PREPROCESS_FUNCS`. - For an example, see the :ref:`pixbufcache <ref-classes-pixbufcache>` class in ``meta/classes/`` in + For an example, see the :ref:`ref-classes-pixbufcache` class in ``meta/classes/`` in the :ref:`overview-manual/development-environment:yocto project source repositories`. .. note::
@@ -402,7 +402,7 @@ The following QA checks have changed: warning, you need to address missing runtime dependencies. For additional information, see the - :ref:`insane <ref-classes-insane>` class and the + :ref:`ref-classes-insane` class and the ":ref:`ref-manual/qa-checks:errors and warnings`" section. .. _migration-2.3-miscellaneous-changes:
@@ -446,7 +446,7 @@ The following miscellaneous changes have occurred: RSA keys only, and with recent versions of OpenSSH, which deprecates DSA host keys. -- The :ref:`buildhistory <ref-classes-buildhistory>` class now +- The :ref:`ref-classes-buildhistory` class now correctly uses tabs as separators between all columns in ``installed-package-sizes.txt`` in order to aid import into other tools.
@@ -484,26 +484,24 @@ The following miscellaneous changes have occurred: If you need to preserve these ``.la`` files (e.g. in a custom distribution), you must change :term:`INHERIT_DISTRO` such that - ":ref:`remove-libtool <ref-classes-remove-libtool>`" is not included + ":ref:`ref-classes-remove-libtool`" is not included in the value. - Extensible SDKs built for GCC 5+ now refuse to install on a distribution where the host GCC version is 4.8 or 4.9. This change resulted from the fact that the installation is known to fail due to the way the ``uninative`` shared state (sstate) package is built. See - the :ref:`uninative <ref-classes-uninative>` class for additional - information. + the :ref:`ref-classes-uninative` class for additional information. -- All :ref:`native <ref-classes-native>` and - :ref:`nativesdk <ref-classes-nativesdk>` recipes now use a separate - :term:`DISTRO_FEATURES` value instead of sharing the value used by - recipes for the target, in order to avoid unnecessary rebuilds. +- All :ref:`ref-classes-native` and :ref:`ref-classes-nativesdk` recipes now + use a separate :term:`DISTRO_FEATURES` value instead of sharing the value + used by recipes for the target, in order to avoid unnecessary rebuilds. - The :term:`DISTRO_FEATURES` for :ref:`native <ref-classes-native>` recipes + The :term:`DISTRO_FEATURES` for :ref:`ref-classes-native` recipes is :term:`DISTRO_FEATURES_NATIVE` added to an intersection of :term:`DISTRO_FEATURES` and :term:`DISTRO_FEATURES_FILTER_NATIVE`. - For :ref:`nativesdk <ref-classes-nativesdk>` recipes, the corresponding + For :ref:`ref-classes-nativesdk` recipes, the corresponding variables are :term:`DISTRO_FEATURES_NATIVESDK` and :term:`DISTRO_FEATURES_FILTER_NATIVESDK`.
documentation/migration-guides/migration-2.4.rst +5 -7
@@ -197,12 +197,10 @@ Kernel Device Tree Move ----------------------- Kernel Device Tree support is now easier to enable in a kernel recipe. -The Device Tree code has moved to a -:ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class. +The Device Tree code has moved to a :ref:`ref-classes-kernel-devicetree` class. Functionality is automatically enabled for any recipe that inherits the -:ref:`kernel <ref-classes-kernel>` class and sets the -:term:`KERNEL_DEVICETREE` variable. The -previous mechanism for doing this, +:ref:`kernel <ref-classes-kernel>` class and sets the :term:`KERNEL_DEVICETREE` +variable. The previous mechanism for doing this, ``meta/recipes-kernel/linux/linux-dtb.inc``, is still available to avoid breakage, but triggers a deprecation warning. Future releases of the Yocto Project will remove ``meta/recipes-kernel/linux/linux-dtb.inc``.
@@ -271,11 +269,11 @@ The following are additional changes: from ``meta-poky`` to OE-Core (i.e. from ``meta-poky/conf/distro/include`` to ``meta/conf/distro/include``). -- The :ref:`buildhistory <ref-classes-buildhistory>` class now makes +- The :ref:`ref-classes-buildhistory` class now makes a single commit per build rather than one commit per subdirectory in the repository. This behavior assumes the commits are enabled with :term:`BUILDHISTORY_COMMIT` = "1", which - is typical. Previously, the :ref:`buildhistory <ref-classes-buildhistory>` class made one commit + is typical. Previously, the :ref:`ref-classes-buildhistory` class made one commit per subdirectory in the repository in order to make it easier to see the changes for a particular subdirectory. To view a particular change, specify that subdirectory as the last parameter on the
documentation/migration-guides/migration-2.5.rst +5 -5
@@ -139,7 +139,7 @@ The following are BitBake changes: - Several explicit "run this task for all recipes in the dependency tree" tasks have been removed (e.g. ``fetchall``, ``checkuriall``, and the ``*all`` tasks provided by the ``distrodata`` and - :ref:`archiver <ref-classes-archiver>` classes). There is a BitBake option to complete this for + :ref:`ref-classes-archiver` classes). There is a BitBake option to complete this for any arbitrary task. For example:: bitbake <target> -c fetchall
@@ -189,7 +189,7 @@ Miscellaneous Changes The following are additional changes: -- The :ref:`kernel <ref-classes-kernel>` class supports building packages for multiple kernels. +- The :ref:`ref-classes-kernel` class supports building packages for multiple kernels. If your kernel recipe or ``.bbappend`` file mentions packaging at all, you should replace references to the kernel in package names with ``${KERNEL_PACKAGE_NAME}``. For example, if you disable
@@ -197,7 +197,7 @@ The following are additional changes: ``RDEPENDS_kernel-base = ""`` you can avoid warnings using ``RDEPENDS_${KERNEL_PACKAGE_NAME}-base = ""`` instead. -- The :ref:`buildhistory <ref-classes-buildhistory>` class commits changes to the repository by +- The :ref:`ref-classes-buildhistory` class commits changes to the repository by default so you no longer need to set ``BUILDHISTORY_COMMIT = "1"``. If you want to disable commits you need to set ``BUILDHISTORY_COMMIT = "0"`` in your configuration.
@@ -209,12 +209,12 @@ The following are additional changes: maintains a full-featured BSP in the ``meta-ti`` layer. This rename avoids the previous name clash that existed between the two BSPs. -- The :ref:`update-alternatives <ref-classes-update-alternatives>` class no longer works with SysV ``init`` +- The :ref:`ref-classes-update-alternatives` class no longer works with SysV ``init`` scripts because this usage has been problematic. Also, the ``sysklogd`` recipe no longer uses ``update-alternatives`` because it is incompatible with other implementations. -- By default, the :ref:`cmake <ref-classes-cmake>` class uses +- By default, the :ref:`ref-classes-cmake` class uses ``ninja`` instead of ``make`` for building. This improves build performance. If a recipe is broken with ``ninja``, then the recipe can set ``OECMAKE_GENERATOR = "Unix Makefiles"`` to change back to
documentation/migration-guides/migration-2.6.rst +8 -10
@@ -128,10 +128,9 @@ missing from :term:`DEPENDS`). .. note:: - This change affects classes beyond just the two mentioned (i.e. - ``distutils`` and ``distutils3``). Any recipe that inherits ``distutils*`` - classes are affected. For example, the ``setuptools`` and - :ref:`setuptools3 <ref-classes-setuptools3>` + This change affects classes beyond just the two mentioned (i.e. ``distutils`` + and ``distutils3``). Any recipe that inherits ``distutils*`` classes are + affected. For example, the ``setuptools`` and :ref:`ref-classes-setuptools3` recipes are affected since they inherit the ``distutils*`` classes. Fetching these types of dependencies that are not provided in the
@@ -315,12 +314,11 @@ This section provides information about automatic testing changes: exists and has been replaced by the :term:`TESTIMAGE_AUTO` variable. -- Inheriting the :ref:`testimage <ref-classes-testimage>` and - :ref:`testsdk <ref-classes-testsdk>` classes: best 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:`testsdk <ref-classes-testsdk>` classes used for automatic testing. +- Inheriting the :ref:`ref-classes-testimage` and :ref:`ref-classes-testsdk` + classes: best practices now dictate that you use the :term:`IMAGE_CLASSES` + variable rather than the :term:`INHERIT` variable when you inherit the + :ref:`ref-classes-testimage` and :ref:`ref-classes-testsdk` classes used + for automatic testing. .. _migration-2.6-openssl-changes:
documentation/migration-guides/migration-2.7.rst +1 -2
@@ -174,8 +174,7 @@ The following miscellaneous changes occurred: - ``base/pixbufcache``: Obsolete ``sstatecompletions`` code has been removed. -- :ref:`native <ref-classes-native>` class: - :term:`RDEPENDS` handling has been enabled. +- :ref:`ref-classes-native` class: :term:`RDEPENDS` handling has been enabled. - ``inetutils``: This recipe has rsh disabled.
documentation/migration-guides/migration-3.0.rst +3 -3
@@ -49,7 +49,7 @@ The following recipes have been removed. - ``core-image-lsb-sdk``: Part of removed LSB support. - ``cve-check-tool``: Functionally replaced by the ``cve-update-db`` - recipe and :ref:`cve-check <ref-classes-cve-check>` class. + recipe and :ref:`ref-classes-cve-check` class. - ``eglinfo``: No longer maintained. ``eglinfo`` from ``mesa-demos`` is an adequate and maintained alternative.
@@ -144,7 +144,7 @@ CVE Checking ------------ ``cve-check-tool`` has been functionally replaced by a new -``cve-update-db`` recipe and functionality built into the :ref:`cve-check <ref-classes-cve-check>` +``cve-update-db`` recipe and functionality built into the :ref:`ref-classes-cve-check` class. The result uses NVD JSON data feeds rather than the deprecated XML feeds that ``cve-check-tool`` was using, supports CVSSv3 scoring, and makes other improvements.
@@ -287,7 +287,7 @@ The following miscellaneous changes have occurred. :term:`NATIVELSBSTRING` to use all lowercase characters even if it does not contain a version number. This change is necessary only if you are not using - :ref:`uninative <ref-classes-uninative>` and :term:`SANITY_TESTED_DISTROS`. + :ref:`ref-classes-uninative` and :term:`SANITY_TESTED_DISTROS`. - In the ``base-files`` recipe, writing the hostname into ``/etc/hosts`` and ``/etc/hostname`` is now done within the main
documentation/migration-guides/migration-3.1.rst +3 -3
@@ -127,7 +127,7 @@ renamed to ``features_check``; the ``distro_features_check`` class still exists but generates a warning and redirects to the new class. In preparation for a future removal of the old class it is recommended that you update recipes currently inheriting ``distro_features_check`` to -inherit :ref:`features_check <ref-classes-features_check>` instead. +inherit :ref:`ref-classes-features_check` instead. .. _migration-3.1-removed-classes:
@@ -240,10 +240,10 @@ Warnings will now be shown at :ref:`ref-tasks-package_qa` time in the following circumstances: - A recipe installs ``.desktop`` files containing ``MimeType`` keys but - does not inherit the new :ref:`mime-xdg <ref-classes-mime-xdg>` class + does not inherit the new :ref:`ref-classes-mime-xdg` class - A recipe installs ``.xml`` files into ``${datadir}/mime/packages`` - but does not inherit the :ref:`mime <ref-classes-mime>` class + but does not inherit the :ref:`ref-classes-mime` class .. _migration-3.1-x86-live-wic:
documentation/migration-guides/migration-3.2.rst +26 -7
@@ -177,13 +177,23 @@ errors: In addition, the following new checks were added and default to triggering an error: -- :ref:`shebang-size <qa-check-shebang-size>`: Check for shebang (#!) lines longer than 128 characters, which can give an error at runtime depending on the operating system. +- :ref:`shebang-size <qa-check-shebang-size>`: Check for shebang (#!) lines + longer than 128 characters, which can give an error at runtime depending on + the operating system. -- :ref:`unhandled-features-check <qa-check-unhandled-features-check>`: Check if any of the variables supported by the :ref:`features_check <ref-classes-features_check>` class is set while not inheriting the class itself. +- :ref:`unhandled-features-check <qa-check-unhandled-features-check>`: Check + if any of the variables supported by the :ref:`ref-classes-features_check` + class is set while not inheriting the class itself. -- :ref:`missing-update-alternatives <qa-check-missing-update-alternatives>`: Check if the recipe sets the :term:`ALTERNATIVE` variable for any of its packages, and does not inherit the :ref:`update-alternatives <ref-classes-update-alternatives>` class. +- :ref:`missing-update-alternatives <qa-check-missing-update-alternatives>`: + Check if the recipe sets the :term:`ALTERNATIVE` variable for any of its + packages, and does not inherit the :ref:`ref-classes-update-alternatives` + class. -- A trailing slash or duplicated slashes in the value of :term:`S` or :term:`B` will now trigger a warning so that they can be removed and path comparisons can be more reliable --- remove any instances of these in your recipes if the warning is displayed. +- A trailing slash or duplicated slashes in the value of :term:`S` or :term:`B` + will now trigger a warning so that they can be removed and path comparisons + can be more reliable --- remove any instances of these in your recipes if the + warning is displayed. .. _migration-3.2-src-uri-file-globbing:
@@ -209,9 +219,18 @@ files into a subdirectory and reference that instead. deploy class now cleans ``DEPLOYDIR`` before ``do_deploy`` ---------------------------------------------------------- -:ref:`ref-tasks-deploy` as implemented in the :ref:`deploy <ref-classes-deploy>` class now cleans up ${:term:`DEPLOYDIR`} before running, just as :ref:`ref-tasks-install` cleans up ${:term:`D`} before running. This reduces the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from previous runs, possibly even with different config, in case of incremental builds. +:ref:`ref-tasks-deploy` as implemented in the :ref:`ref-classes-deploy` class +now cleans up ${:term:`DEPLOYDIR`} before running, just as +:ref:`ref-tasks-install` cleans up ${:term:`D`} before running. This reduces +the risk of :term:`DEPLOYDIR` being accidentally contaminated by files from +previous runs, possibly even with different config, in case of incremental +builds. -Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` class or interact with :ref:`ref-tasks-deploy` are unlikely to be affected by this unless they add ``prefuncs`` to :ref:`ref-tasks-deploy` *which also* put files into ``${DEPLOYDIR}`` --- these should be refactored to use ``do_deploy_prepend`` instead. +Most recipes and classes that inherit the :ref:`ref-classes-deploy` class or +interact with :ref:`ref-tasks-deploy` are unlikely to be affected by this +unless they add ``prefuncs`` to :ref:`ref-tasks-deploy` *which also* put files +into ``${DEPLOYDIR}`` --- these should be refactored to use +``do_deploy_prepend`` instead. .. _migration-3.2-nativesdk-sdk-provides-dummy:
@@ -219,7 +238,7 @@ Most recipes and classes that inherit the :ref:`deploy <ref-classes-deploy>` cla Custom SDK / SDK-style recipes need to include ``nativesdk-sdk-provides-dummy`` ------------------------------------------------------------------------------- -All :ref:`nativesdk <ref-classes-nativesdk>` packages require ``/bin/sh`` due +All :ref:`ref-classes-nativesdk` packages require ``/bin/sh`` due to their postinstall scriptlets, thus this package has to be dummy-provided within the SDK and ``nativesdk-sdk-provides-dummy`` now does this. If you have a custom SDK recipe (or your own SDK-style recipe similar to e.g.
documentation/migration-guides/migration-3.3.rst +8 -9
@@ -63,13 +63,13 @@ need to update those. New ``python3targetconfig`` class --------------------------------- -A new :ref:`python3targetconfig <ref-classes-python3targetconfig>` class has +A new :ref:`ref-classes-python3targetconfig` class has been created for situations where you would previously have inherited the -:ref:`python3native <ref-classes-python3native>` class but need access to +:ref:`ref-classes-python3native` class but need access to target configuration data (such as correct installation directories). Recipes where this situation applies should be changed to inherit -:ref:`python3targetconfig <ref-classes-python3targetconfig>` instead of -:ref:`python3native <ref-classes-python3native>`. This also adds a dependency +:ref:`ref-classes-python3targetconfig` instead of +:ref:`ref-classes-python3native`. This also adds a dependency on target ``python3``, so it should only be used where appropriate in order to avoid unnecessarily lengthening builds.
@@ -99,11 +99,10 @@ variable so that recipes can specify it explicitly, for example:: S = "${WORKDIR}/git" DISTUTILS_SETUP_PATH = "${S}/python/pythonmodule" -Recipes that inherit from ``distutils3`` (or -:ref:`setuptools3 <ref-classes-setuptools3>` which itself inherits -``distutils3``) that also set :term:`S` to point to a Python module within a -subdirectory in the aforementioned manner should be changed to set -``DISTUTILS_SETUP_PATH`` instead. +Recipes that inherit from ``distutils3`` (or :ref:`ref-classes-setuptools3` +which itself inherits ``distutils3``) that also set :term:`S` to point to a +Python module within a subdirectory in the aforementioned manner should be +changed to set ``DISTUTILS_SETUP_PATH`` instead. .. _migration-3.3-bitbake:
documentation/migration-guides/migration-3.4.rst +2 -2
@@ -126,7 +126,7 @@ Removed classes - ``image-mklibs``: not actively tested and upstream mklibs still requires Python 2 - ``meta``: no longer useful. Recipes that need to skip installing - packages should inherit :ref:`nopackages <ref-classes-nopackages>` instead. + packages should inherit :ref:`ref-classes-nopackages` instead. Prelinking disabled by default ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -259,7 +259,7 @@ Miscellaneous instead. - The obsolete ``oe_machinstall`` function previously provided in the - :ref:`utils <ref-classes-utils>` class has been removed. For + :ref:`ref-classes-utils` class has been removed. For machine-specific installation it is recommended that you use the built-in override support in the fetcher or overrides in general instead.
documentation/migration-guides/migration-4.0.rst +10 -11
@@ -119,7 +119,7 @@ License changes - The ``AVAILABLE_LICENSES`` variable has been removed. This variable was a performance liability and is highly dependent on which layers are added to the configuration, which can cause signature issues for users. In addition the ``available_licenses()`` - function has been removed from the :ref:`license <ref-classes-license>` class as + function has been removed from the :ref:`ref-classes-license` class as it is no longer needed. Removed recipes
@@ -143,15 +143,14 @@ Python changes - The Python package build process is now based on `wheels <https://pythonwheels.com/>`__. Here are the new Python packaging classes that should be used: - :ref:`python_flit_core <ref-classes-python_flit_core>`, - :ref:`python_setuptools_build_meta <ref-classes-python_setuptools_build_meta>` - and :ref:`python_poetry_core <ref-classes-python_poetry_core>`. + :ref:`ref-classes-python_flit_core`, :ref:`ref-classes-python_setuptools_build_meta` + and :ref:`ref-classes-python_poetry_core`. -- The :ref:`setuptools3 <ref-classes-setuptools3>` class :ref:`ref-tasks-install` task now +- The :ref:`ref-classes-setuptools3` class :ref:`ref-tasks-install` task now installs the ``wheel`` binary archive. In current versions of ``setuptools`` the legacy ``setup.py install`` method is deprecated. If the ``setup.py`` cannot be used with wheels, for example it creates files outside of the Python module or standard - entry points, then :ref:`setuptools3_legacy <ref-classes-setuptools3_legacy>` should + entry points, then :ref:`ref-classes-setuptools3_legacy` should be used instead. Prelink removed
@@ -173,7 +172,7 @@ Reproducible as standard Reproducibility is now considered as standard functionality, thus the ``reproducible`` class has been removed and its previous contents merged into the -:ref:`base <ref-classes-base>` class. If you have references in your configuration to +:ref:`ref-classes-base` class. If you have references in your configuration to ``reproducible`` in :term:`INHERIT`, :term:`USER_CLASSES` etc. then they should be removed.
@@ -215,15 +214,15 @@ Miscellaneous changes ~~~~~~~~~~~~~~~~~~~~~ - ``blacklist.bbclass`` is removed and the functionality moved to the - :ref:`base <ref-classes-base>` class with a more descriptive + :ref:`ref-classes-base` class with a more descriptive ``varflag`` variable named :term:`SKIP_RECIPE` which will use the `bb.parse.SkipRecipe()` function. The usage remains the same, for example:: SKIP_RECIPE[my-recipe] = "Reason for skipping recipe" -- :ref:`allarch <ref-classes-allarch>` packagegroups can no longer depend on packages +- :ref:`ref-classes-allarch` packagegroups can no longer depend on packages which use :term:`PKG` renaming such as :ref:`ref-classes-debian`. Such packagegroups - recipes should be changed to avoid inheriting :ref:`allarch <ref-classes-allarch>`. + recipes should be changed to avoid inheriting :ref:`ref-classes-allarch`. - The ``lnr`` script has been removed. ``lnr`` implemented the same behaviour as `ln --relative --symbolic`, since at the time of creation `--relative` was only available in coreutils 8.16
@@ -232,7 +231,7 @@ Miscellaneous changes any calls to ``lnr`` in your recipes or classes, they should be replaced with `ln --relative --symbolic` or `ln -rs` if you prefer the short version. -- The ``package_qa_handle_error()`` function formerly in the :ref:`insane <ref-classes-insane>` +- The ``package_qa_handle_error()`` function formerly in the :ref:`ref-classes-insane` class has been moved and renamed - if you have any references in your own custom classes they should be changed to ``oe.qa.handle_error()``.
documentation/migration-guides/migration-4.1.rst +5 -5
@@ -92,7 +92,7 @@ now cause an error:: INHERIT += "testimage" -Since :ref:`testimage <ref-classes-testimage>` is a class intended solely to +Since :ref:`ref-classes-testimage` is a class intended solely to affect image recipes, this would be correctly specified as:: IMAGE_CLASSES += "testimage"
@@ -154,16 +154,16 @@ Miscellaneous changes you can set :term:`WATCHDOG_TIMEOUT` to the desired timeout in seconds. Note that the same :term:`WATCHDOG_TIMEOUT` variable also specifies the timeout used for the ``watchdog`` tool (if that is being built). -- The :ref:`image-buildinfo <ref-classes-image-buildinfo>` class now writes to +- The :ref:`ref-classes-image-buildinfo` class now writes to ``${sysconfdir}/buildinfo`` instead of ``${sysconfdir}/build`` by default (i.e. the default value of :term:`IMAGE_BUILDINFO_FILE` has been changed). If you have code that reads this from images at build or runtime you will need to update it or specify your own value for :term:`IMAGE_BUILDINFO_FILE`. -- In the :ref:`archiver <ref-classes-archiver>` class, the default +- In the :ref:`ref-classes-archiver` class, the default ``ARCHIVER_OUTDIR`` value no longer includes the :term:`MACHINE` value in order to avoid the archive task running multiple times in a multiconfig setup. If you have custom code that does something with the files archived by the - :ref:`archiver <ref-classes-archiver>` class then you may need to adjust it to + :ref:`ref-classes-archiver` class then you may need to adjust it to the new structure. - If you are not using `systemd` then udev is now configured to use labels (``LABEL`` or ``PARTLABEL``) to set the mount point for the device. For example::
@@ -194,7 +194,7 @@ Miscellaneous changes :term:`PACKAGECONFIG`. If you are customising this file you will need to update your customisations. - With the introduction of picobuild in - :ref:`python_pep517 <ref-classes-python_pep517>`, The ``PEP517_BUILD_API`` + :ref:`ref-classes-python_pep517`, The ``PEP517_BUILD_API`` variable is no longer supported. If you have any references to this variable you should remove them.
documentation/migration-guides/migration-general.rst +7 -7
@@ -76,24 +76,24 @@ any new Yocto Project release. - *Checking Image / SDK Changes*: - The :ref:`buildhistory <ref-classes-buildhistory>` class can be used + The :ref:`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: - #. Enable :ref:`buildhistory <ref-classes-buildhistory>` before the migration + #. Enable :ref:`ref-classes-buildhistory` before the migration #. Run a pre-migration build - #. Capture the :ref:`buildhistory <ref-classes-buildhistory>` output (as + #. Capture the :ref:`ref-classes-buildhistory` output (as specified by :term:`BUILDHISTORY_DIR`) and ensure it is preserved for subsequent builds. How you would do this depends on how you are running your builds - if you are doing this all on one workstation in the same :term:`Build Directory` you may not need to do anything other than not - deleting the :ref:`buildhistory <ref-classes-buildhistory>` output + deleting the :ref:`ref-classes-buildhistory` output directory. For builds in a pipeline it may be more complicated. - #. Set a tag in the :ref:`buildhistory <ref-classes-buildhistory>` output (which is a git repository) before + #. Set a tag in the :ref:`ref-classes-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.
@@ -102,7 +102,7 @@ any new Yocto Project release. #. Run a build #. Check the output changes between the previously set tag and HEAD in the - :ref:`buildhistory <ref-classes-buildhistory>` output using ``git diff`` or ``buildhistory-diff``. + :ref:`ref-classes-buildhistory` output using ``git diff`` or ``buildhistory-diff``. - For more information on using :ref:`buildhistory <ref-classes-buildhistory>`, see + For more information on using :ref:`ref-classes-buildhistory`, see :ref:`dev-manual/build-quality:maintaining build output quality`.
documentation/migration-guides/release-notes-3.4.rst +2 -2
@@ -9,7 +9,7 @@ New Features / Enhancements in 3.4 - Linux kernel 5.14, glibc 2.34 and ~280 other recipe upgrades - Switched override character to ':' (replacing '_') for more robust parsing and improved performance --- see the above migration guide for help - Rust integrated into core, providing rust support for cross-compilation and SDK -- New :ref:`create-spdx <ref-classes-create-spdx>` class for creating SPDX SBoM documents +- New :ref:`ref-classes-create-spdx` class for creating SPDX SBoM documents - New recipes: cargo, core-image-ptest-all, core-image-ptest-fast, core-image-weston-sdk, erofs-utils, gcompat, gi-docgen, libmicrohttpd, libseccomp, libstd-rs, perlcross, python3-markdown, python3-pyyaml, python3-smartypants, python3-typogrify, rust, rust-cross, rust-cross-canadian, rust-hello-world, rust-llvm, rust-tools-cross-canadian, rustfmt, xwayland - Several optimisations to reduce unnecessary task dependencies for faster builds - seccomp integrated into core, with additional enabling for gnutls, systemd, qemu
@@ -71,7 +71,7 @@ New Features / Enhancements in 3.4 - Enable :ref:`ref-tasks-populate_sdk` with multilibs - New ``SDKPATHINSTALL`` variable decouples default install path from - built in path to avoid rebuilding :ref:`nativesdk <ref-classes-nativesdk>` + built in path to avoid rebuilding :ref:`ref-classes-nativesdk` components on e.g. :term:`DISTRO_VERSION` changes - eSDK: Error if trying to generate an eSDK from a multiconfig - eSDK: introduce :term:`TOOLCHAIN_HOST_TASK_ESDK` to be used in place of :term:`TOOLCHAIN_HOST_TASK` to add components to the host part of the eSDK
documentation/migration-guides/release-notes-4.0.rst +5 -6
@@ -13,7 +13,7 @@ New Features / Enhancements in 4.0 - Reproducibility: this release fixes the reproducibility issues with ``rust-llvm`` and ``golang``. Recipes in OpenEmbedded-Core are now fully reproducible. Functionality previously in the optional "reproducible" - class has been merged into the :ref:`base <ref-classes-base>` class. + class has been merged into the :ref:`ref-classes-base` class. - Network access is now disabled by default for tasks other than where it is expected to ensure build integrity (where host kernel supports it)
@@ -31,8 +31,7 @@ New Features / Enhancements in 4.0 - The Python package build process is now based on `wheels <https://pythonwheels.com/>`__ in line with the upstream direction. -- New :ref:`overlayfs <ref-classes-overlayfs>` and - :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` classes and +- New :ref:`ref-classes-overlayfs` and :ref:`ref-classes-overlayfs-etc` classes and ``overlayroot`` support in the :term:`Initramfs` framework to make it easier to overlay read-only filesystems (for example) with :wikipedia:`OverlayFS <OverlayFS>`.
@@ -218,7 +217,7 @@ New Features / Enhancements in 4.0 - Ensure addition of patch-fuzz retriggers do_qa_patch - Added a sanity check for allarch packagegroups -- :ref:`create-spdx <ref-classes-create-spdx>` class improvements: +- :ref:`ref-classes-create-spdx` class improvements: - Get SPDX-License-Identifier from source files - Generate manifest also for SDKs
@@ -238,9 +237,9 @@ New Features / Enhancements in 4.0 - SDK-related enhancements: - - Extended recipes to :ref:`nativesdk <ref-classes-nativesdk>`: ``cargo``, + - Extended recipes to :ref:`ref-classes-nativesdk`: ``cargo``, ``librsvg``, ``libstd-rs``, ``libva``, ``python3-docutil``, ``python3-packaging`` - - Enabled :ref:`nativesdk <ref-classes-nativesdk>` recipes to find a correct version + - Enabled :ref:`ref-classes-nativesdk` recipes to find a correct version of the rust cross compiler - Support creating per-toolchain cmake file in SDK
documentation/migration-guides/release-notes-4.1.rst +15 -15
@@ -30,7 +30,7 @@ New Features / Enhancements in 4.1 - Support for building rust for the target - Significant SDK toolchain build optimisation - Support for building native components in the SDK - - Support ``crate://`` fetcher with :ref:`externalsrc <ref-classes-externalsrc>` + - Support ``crate://`` fetcher with :ref:`ref-classes-externalsrc` - New core recipes:
@@ -52,7 +52,7 @@ New Features / Enhancements in 4.1 - Added support for Ignored CVEs - Enable recursive CVE checking also for ``do_populate_sdk`` - New :term:`CVE_CHECK_SHOW_WARNINGS` variable to disable unpatched CVE warning messages - - The :ref:`pypi <ref-classes-pypi>` class now defaults :term:`CVE_PRODUCT` from :term:`PYPI_PACKAGE` + - The :ref:`ref-classes-pypi` class now defaults :term:`CVE_PRODUCT` from :term:`PYPI_PACKAGE` - Added current kernel CVEs to ignore list since we stay as close to the kernel stable releases as we can - Optimisations to avoid dependencies on fetching
@@ -60,9 +60,9 @@ New Features / Enhancements in 4.1 - Dependency of -dev package on main package is now an :term:`RRECOMMENDS` and can be easily set via new :term:`DEV_PKG_DEPENDENCY` variable - Support for CPU, I/O and memory pressure regulation in BitBake -- Pressure data gathering in :ref:`buildstats <ref-classes-buildstats>` and rendering in ``pybootchartgui`` +- Pressure data gathering in :ref:`ref-classes-buildstats` and rendering in ``pybootchartgui`` -- New Picobuild system for lightweight Python PEP-517 build support in the :ref:`python_pep517 <ref-classes-python_pep517>` class +- New Picobuild system for lightweight Python PEP-517 build support in the :ref:`ref-classes-python_pep517` class - Many classes are now split into global and recipe contexts for better validation. For more information, see
@@ -99,10 +99,10 @@ New Features / Enhancements in 4.1 - SDK-related enhancements: - :ref:`Support for using the regular build system as an SDK <sdk-manual/extensible:Setting up the Extensible SDK environment directly in a Yocto build>` - - :ref:`image-buildinfo <ref-classes-image-buildinfo>` class now also writes build information to SDKs + - :ref:`ref-classes-image-buildinfo` class now also writes build information to SDKs - New :term:`SDK_TOOLCHAIN_LANGS` variable to control support of rust / go in SDK - - rust-llvm: enabled :ref:`nativesdk <ref-classes-nativesdk>` variant - - python3-pluggy: enabled for :ref:`native <ref-classes-native>` / :ref:`nativesdk <ref-classes-nativesdk>` + - rust-llvm: enabled :ref:`ref-classes-nativesdk` variant + - python3-pluggy: enabled for :ref:`ref-classes-native` / :ref:`ref-classes-nativesdk` - QEMU/runqemu enhancements:
@@ -115,11 +115,11 @@ New Features / Enhancements in 4.1 - New variable :term:`UBOOT_MKIMAGE_KERNEL_TYPE` - New variable :term:`FIT_PAD_ALG` to control FIT image padding algorithm - New :term:`KERNEL_DEPLOY_DEPEND` variable to allow disabling image dependency on deploying the kernel - - :ref:`image_types <ref-classes-image_types>`: isolate the write of UBI + - :ref:`ref-classes-image_types`: isolate the write of UBI configuration to a ``write_ubi_config`` function that can be easily overridden - openssh: add support for config snippet includes to ssh and sshd -- :ref:`create-spdx <ref-classes-create-spdx>`: Add :term:`SPDX_PRETTY` option +- :ref:`ref-classes-create-spdx`: Add :term:`SPDX_PRETTY` option - wpa-supplicant: build static library if not disabled via :term:`DISABLE_STATIC` - wpa-supplicant: package dynamic modules - openssl: extract legacy provider module to a separate package
@@ -132,11 +132,11 @@ New Features / Enhancements in 4.1 - systemd: systemd-systemctl: Support instance conf files during enable - weston.init: enable ``xwayland`` in weston.ini if ``x11`` is in :term:`DISTRO_FEATURES` - New ``npm_registry`` Python module to enable caching with nodejs 16+ -- :ref:`npm <ref-classes-npm>`: replaced ``npm pack`` call with ``tar czf`` for nodejs 16+ compatibility and improved ``do_configure`` performance -- Enabled :ref:`bin_package <ref-classes-bin-package>` class to work properly in the native case +- :ref:`ref-classes-npm`: replaced ``npm pack`` call with ``tar czf`` for nodejs 16+ compatibility and improved ``do_configure`` performance +- Enabled :ref:`ref-classes-bin-package` class to work properly in the native case - Enabled :ref:`buildpaths <qa-check-buildpaths>` QA check as a warning by default -- New :term:`OVERLAYFS_ETC_EXPOSE_LOWER` to provide read-only access to the original ``/etc`` content with :ref:`overlayfs-etc <ref-classes-overlayfs-etc>` -- New :term:`OVERLAYFS_QA_SKIP` variable to allow skipping check on :ref:`overlayfs <ref-classes-overlayfs>` mounts +- New :term:`OVERLAYFS_ETC_EXPOSE_LOWER` to provide read-only access to the original ``/etc`` content with :ref:`ref-classes-overlayfs-etc` +- New :term:`OVERLAYFS_QA_SKIP` variable to allow skipping check on :ref:`ref-classes-overlayfs` mounts - New :term:`PACKAGECONFIG` options for individual recipes: - apr: xsi-strerror
@@ -176,7 +176,7 @@ New Features / Enhancements in 4.1 - The Python ``zoneinfo`` module is now split out to its own ``python3-zoneinfo`` package. - busybox: added devmem 128-bit support - vim: split xxd out into its own package -- New :ref:`github-releases <ref-classes-github-releases>` class to consolidate version checks for github-based packages +- New :ref:`ref-classes-github-releases` class to consolidate version checks for github-based packages - ``devtool reset`` now preserves ``workspace/sources`` source trees in ``workspace/attic/sources/`` instead of leaving them in-place - scripts/patchreview: Add commit to stored json data - scripts/patchreview: Make json output human parsable
@@ -204,7 +204,7 @@ Known Issues in 4.1 :yocto_bugs:`bug 14626 </show_bug.cgi?id=14626>`, which also details the fix. - The change to :ref:`migration-4.1-classes-split` inadvertently moved the - :ref:`externalsrc <ref-classes-externalsrc>` class to ``meta/classes-recipe``, + :ref:`ref-classes-externalsrc` class to ``meta/classes-recipe``, when it is not recipe-specific and can also be used in a global context. The class will be moved back to ``meta/classes`` in the next point release. Filed as :yocto_bugs:`bug 14940 </show_bug.cgi?id=14940>`.
documentation/overview-manual/concepts.rst +24 -34
118 lines not on this page · raw message
documentation/ref-manual/classes.rst +296 -315
1,534 lines not on this page · raw message
documentation/ref-manual/variables.rst +322 -368
690 lines not on this page · raw message
documentation/sdk-manual/appendix-customizing.rst +1 -2
Lines of this file are not shown. View the raw message.
documentation/sdk-manual/extensible.rst +2 -3
Lines of this file are not shown. View the raw message.
documentation/test-manual/understand-autobuilder.rst +1 -1
Lines of this file are not shown. View the raw message.
The rest of this diff is not shown. View the raw message.
Signature · 1 line
2.37.2
Part of the diff is not shown here. View the raw message.