documentation/ref-manual/classes.rst

40 The :ref:`ref-classes-allarch` class is inherited by recipes that do not produce
52    configured for all architectures using :ref:`ref-classes-allarch`. This is the case
56    :ref:`do_package_write_* <ref-tasks-package_write_deb>` tasks to
61 By default, all recipes inherit the :ref:`ref-classes-base` and
62 :ref:`ref-classes-package` classes, which enable
66 inherit the :ref:`ref-classes-allarch` class.
73 The :ref:`ref-classes-archiver` class supports releasing source code and other
76 For more details on the source :ref:`ref-classes-archiver`, see the
77 ":ref:`dev-manual/licenses:maintaining open source license compliance during your product's lifecyc…
87 The :ref:`autotools* <ref-classes-autotools>` classes support packages built with the
96 ":ref:`dev-manual/new-recipe:building an autotooled package`" section
99 By default, the :ref:`autotools* <ref-classes-autotools>` classes use out-of-tree builds (i.e.
104 :ref:`autotools-brokensep <ref-classes-autotools>` class. The :ref:`autotools-brokensep <ref-classe…
105 the same as the :ref:`ref-classes-autotools` class but builds with :term:`B`
115 :ref:`autotools* <ref-classes-autotools>` classes work and what they do behind the scenes.
117 -  :ref:`ref-tasks-configure` --- regenerates the
124 -  :ref:`ref-tasks-compile` --- runs ``make`` with
128 -  :ref:`ref-tasks-install` --- runs ``make install`` and
136 The :ref:`ref-classes-barebox` class manages building the barebox bootloader.
146 The :ref:`ref-classes-barebox` class supports config fragments and internally
147 includes the :ref:`ref-classes-cml1` class to provide `Kconfig
149 barebox, enabling tasks such as :ref:`ref-tasks-menuconfig` and
150 :ref:`ref-tasks-diffconfig`.
173 The :ref:`ref-classes-base` class is special in that every ``.bb`` file implicitly
178 extended by other classes such as the :ref:`ref-classes-autotools` class or the
179 :ref:`ref-classes-package` class.
199 The :ref:`ref-classes-bin-package` class is a helper class for recipes, that
200 disables the :ref:`ref-tasks-configure` and :ref:`ref-tasks-compile` tasks and
216 The :ref:`ref-classes-bin-package` class will copy the extracted content of the
228    :ref:`ref-classes-bin-package` class, but rather by the appropriate
229    :ref:`fetcher <bitbake-user-manual/bitbake-user-manual-fetching:fetchers>`
237 The :ref:`ref-classes-binconfig` class helps to correct paths in shell scripts.
257 An alternative version of the :ref:`ref-classes-binconfig`
268 The :ref:`ref-classes-buildhistory` class records a history of build output metadata,
272 ":ref:`dev-manual/build-quality:maintaining build output quality`"
280 The :ref:`ref-classes-buildstats` class records performance statistics about each task
294 remove ":ref:`ref-classes-buildstats`" from the :term:`USER_CLASSES` list.
303 :ref:`ref-classes-buildstats` class be enabled.
310 The :ref:`ref-classes-cargo` class allows to compile Rust language programs
321 :ref:`ref-classes-ptest-cargo` class instead of :ref:`ref-classes-cargo`.
330 This class inherits the :ref:`ref-classes-cargo_common` class.
337 The :ref:`ref-classes-cargo_c` class can be inherited by a recipe to generate
350 The :ref:`ref-classes-cargo_common` class is an internal class
354 library, which is built by Cargo but cannot use the :ref:`ref-classes-cargo`
362 The :ref:`ref-classes-cargo-update-recipe-crates` class allows
367 :doc:`devtool </ref-manual/devtool-reference>`,
368 make it inherit the :ref:`ref-classes-cargo` and
369 :ref:`ref-classes-cargo-update-recipe-crates` and run::
386 The :ref:`ref-classes-ccache` class enables the C/C++ Compiler Cache for the build.
403 The :ref:`ref-classes-chrpath` class is a wrapper around the "chrpath" utility, which
404 is used during the build process for :ref:`ref-classes-nativesdk`, :ref:`ref-classes-cross`, and
405 :ref:`ref-classes-cross-canadian` recipes to change ``RPATH`` records within binaries
413 The :ref:`ref-classes-cmake` class allows recipes to build software using the
418 By default, the :ref:`ref-classes-cmake` class uses
425 being built, you should install them (during :ref:`ref-tasks-install`) to the
433 The :ref:`ref-classes-cmake-qemu` class might be used instead of the
434 :ref:`ref-classes-cmake` class. In addition to the features provided by the
435 :ref:`ref-classes-cmake` class, the :ref:`ref-classes-cmake-qemu` class passes
443 ``qemu-usermode`` in the :ref:`ref-features-machine`. Using QEMU user-mode therefore
445 the main :ref:`ref-classes-cmake` class by default.
462 The :ref:`ref-classes-cml1` class provides basic support for the Linux kernel style
482 The :ref:`ref-classes-copyleft_compliance` class preserves source code for the purposes
483 of license compliance. This class is an alternative to the :ref:`ref-classes-archiver`
485 in favor of the :ref:`ref-classes-archiver` class.
492 A class used by the :ref:`ref-classes-archiver` and
493 :ref:`ref-classes-copyleft_compliance` classes
502 The :ref:`ref-classes-core-image` class provides common definitions for the
511 The :ref:`cpan* <ref-classes-cpan>` classes support Perl modules.
524 Both build methods inherit the :ref:`cpan-base <ref-classes-cpan>` class for basic Perl
532 The :ref:`ref-classes-create-spdx` class provides support for
550 ":ref:`dev-manual/sbom:creating a software bill of materials`"
558 The :ref:`ref-classes-cross` class provides support for the recipes that build the
566 The :ref:`ref-classes-cross-canadian` class provides support for the recipes that build
568 ":ref:`overview-manual/concepts:cross-development toolchain generation`"
577 The :ref:`ref-classes-crosssdk` class provides support for the recipes that build the
579 ":ref:`overview-manual/concepts:cross-development toolchain generation`"
588 The :ref:`ref-classes-cve-check` class looks for known CVEs (Common Vulnerabilities
651 ":ref:`dev-manual/vulnerabilities:checking for vulnerabilities`"
659 The :ref:`ref-classes-cython` class can be used by Python recipes that require
668 The :ref:`ref-classes-debian` class renames output packages so that they follow the
683 The :ref:`ref-classes-deploy` class handles deploying files to the
687 :ref:`ref-tasks-deploy` function to copy the files to be
690 :ref:`ref-tasks-compile` or
691 :ref:`ref-tasks-install`. The class then takes care of
699 The :ref:`ref-classes-devicetree` class allows to build a recipe that compiles
707 The :ref:`ref-tasks-compile` task will compile two kinds of files:
716 what the :ref:`ref-classes-kernel-devicetree` class does, with the added
747 The :ref:`ref-classes-devshell` class adds the :ref:`ref-tasks-devshell` task. Distribution
748 policy dictates whether to include this class. See the ":ref:`dev-manual/development-shell:using a …
750 information about using :ref:`ref-classes-devshell`.
757 The :ref:`ref-classes-devupstream` class uses
779 recipe, not :ref:`ref-classes-native` or :ref:`ref-classes-nativesdk` variants.
782 support for :ref:`ref-classes-native` and :ref:`ref-classes-nativesdk` variants. Consequently, this
794 The :ref:`ref-classes-externalsrc` class supports building software from source code
802 :ref:`ref-classes-externalsrc` class, you use the
818 For more information on the :ref:`ref-classes-externalsrc` class, see the comments in
820 For information on how to use the :ref:`ref-classes-externalsrc` class, see the
821 ":ref:`dev-manual/building:building software from an external source`"
829 The :ref:`ref-classes-extrausers` class allows additional user and group configuration
837    The user and group operations added using the :ref:`ref-classes-extrausers`
840    whole. Use the :ref:`ref-classes-useradd` class to add user and group
889 The :ref:`ref-classes-features_check` class allows individual recipes to check
915 The :ref:`ref-classes-fontcache` class generates the proper post-install and
931 The :ref:`ref-classes-fs-uuid` class extracts UUID from
933 by the time that this function gets called. The :ref:`ref-classes-fs-uuid` class only
941 The :ref:`ref-classes-gconf` class provides common functionality for recipes that need
953 The :ref:`ref-classes-gettext` class provides support for building
963 For recipes that fetch release tarballs from github, the :ref:`ref-classes-github-releases`
967 To use it, add ":ref:`ref-classes-github-releases`" to the inherit line in the recipe,
977 The :ref:`ref-classes-gnomebase` class is the base class for recipes that build
988 The :ref:`ref-classes-go` class supports building Go programs. The behavior of
1001 The :ref:`ref-classes-go-mod` class allows to use Go modules, and inherits the
1002 :ref:`ref-classes-go` class.
1011 The :ref:`ref-classes-go-vendor` class implements support for offline builds,
1013 downloaded during the :ref:`ref-tasks-fetch` task rather than when modules are
1034    This functionality is :ref:`backfilled <ref-features-backfill>` by default
1044 The :ref:`ref-classes-grub-efi` class provides ``grub-efi``-specific functions for
1092 The :ref:`ref-classes-gsettings` class provides common functionality for recipes that
1103 The :ref:`ref-classes-gtk-doc` class is a helper class to pull in the appropriate
1111 The :ref:`ref-classes-gtk-icon-cache` class generates the proper post-install and
1124 The :ref:`ref-classes-gtk-immodules-cache` class generates the proper post-install and
1142 The :ref:`ref-classes-gzipnative` class enables the use of different native versions of
1151 The :ref:`ref-classes-icecc` class supports
1199 Inheriting the :ref:`ref-classes-icecc` class changes all sstate signatures.
1203 system need to either inherit the :ref:`ref-classes-icecc` class or nobody should.
1205 At the distribution level, you can inherit the :ref:`ref-classes-icecc` class to be
1225 The :ref:`ref-classes-image` class helps support creating images in different formats.
1237 ":ref:`dev-manual/customizing-images:customizing images`" section
1240 ":ref:`overview-manual/concepts:images`" section in the
1248 The :ref:`ref-classes-image-buildinfo` class writes a plain text file containing
1270 The :ref:`ref-classes-image_types` class defines all of the standard image output types
1276 By default, the :ref:`ref-classes-image` class automatically
1277 enables the :ref:`ref-classes-image_types` class. The :ref:`ref-classes-image` class uses the
1293 The :ref:`ref-classes-image_types` class also handles conversion and compression of images.
1319 The :ref:`ref-classes-insane` class adds a step to the package generation process so
1329 condition. See the ":doc:`/ref-manual/qa-checks`" Chapter for a list of all the warning
1377    :ref:`ref-tasks-rootfs` task because the auto-detected
1379    :ref:`ref-classes-update-rc.d` class automatically
1390    directive, that the recipe also inherits the :ref:`ref-classes-gettext`
1394    :ref:`ref-tasks-compile` log for indications that
1464    :ref:`ref-tasks-install` task.
1471    :ref:`ref-tasks-install` log for indications that
1476    within :ref:`ref-tasks-install` but have not been included in any package by
1481    :ref:`ref-tasks-install` if the files are not needed in any package.
1516    the :ref:`ref-classes-mime` class in order to ensure that these get
1521    :ref:`ref-classes-mime-xdg` class that is required in order for that
1526    :ref:`ref-classes-update-alternatives` such that the alternative will
1541    :ref:`ref-classes-setuptools3` has a PEP517-compliant backend.
1569    undefined during :ref:`ref-tasks-package`.
1620    ":doc:`/ref-manual/qa-checks`" for more information regarding runtime performance
1624    the :ref:`ref-classes-features_check` class supports (e.g.
1626    also inherits :ref:`ref-classes-features_check` in order for the
1649    during :ref:`ref-tasks-package`.
1651 -  ``version-going-backwards:`` If the :ref:`ref-classes-buildhistory`
1683 The :ref:`ref-classes-kernel` class handles building Linux kernels. The class contains
1686 using the :ref:`ref-classes-module` class.
1689 :ref:`ref-tasks-configure` copies it as ``.config`` in the build directory,
1701 The :ref:`ref-classes-kernel` class contains logic that allows you to embed an initial
1704 ":ref:`dev-manual/building:building an initial ram filesystem (Initramfs) image`" section in
1707 Various other classes are used by the :ref:`ref-classes-kernel` and :ref:`ref-classes-module` class…
1708 internally including the :ref:`ref-classes-kernel-arch`, :ref:`ref-classes-module-base`, and
1709 :ref:`ref-classes-linux-kernel-base` classes.
1716 The :ref:`ref-classes-kernel-arch` class sets the ``ARCH`` environment variable for
1724 The :ref:`ref-classes-kernel-devicetree` class, which is inherited by the
1725 :ref:`ref-classes-kernel` class, supports device tree generation.
1740 The :ref:`ref-classes-kernel-fitimage` class provides support to pack a kernel image,
1744 However, :ref:`ref-classes-kernel-fitimage` currently only supports
1750 is set to include ":ref:`ref-classes-kernel-fitimage`" and one of :term:`KERNEL_IMAGETYPE`,
1758 :ref:`ref-classes-kernel-fitimage` and the kernel image in FIT is mandatory. The
1765 :ref:`ref-classes-kernel-fitimage` and the device tree is optional.
1771 :ref:`ref-classes-kernel-fitimage` and the RAM disk in FIT is optional.
1779 :ref:`ref-classes-kernel-fitimage` and the :term:`Initramfs` bundle in FIT is optional.
1789 :ref:`ref-classes-kernel-fitimage` and the boot script is optional.
1792 U-boot :ref:`ref-tasks-install` task to copy the script to sysroot.
1793 So the script can be included in the FIT image by the :ref:`ref-classes-kernel-fitimage`
1797 The FIT image generated by the :ref:`ref-classes-kernel-fitimage` class is signed when the
1801 :term:`FIT_SIGN_ALG` in :ref:`ref-classes-kernel-fitimage` are "sha256" and
1803 the :ref:`ref-classes-kernel-fitimage` class when both :term:`FIT_GENERATE_KEYS` and
1812 The :ref:`ref-classes-kernel-grub` class updates the boot area and the boot menu with
1821 The :ref:`ref-classes-kernel-module-split` class provides common functionality for
1829 The :ref:`ref-classes-kernel-uboot` class provides support for building from
1837 The :ref:`ref-classes-kernel-uimage` class provides support to pack uImage.
1844 The :ref:`ref-classes-kernel-yocto` class provides common functionality for building
1852 The :ref:`ref-classes-kernelsrc` class sets the Linux kernel source and version.
1859 The :ref:`ref-classes-lib_package` class supports recipes that build libraries and
1870 The :ref:`ref-classes-libc*` classes support recipes that build packages with ``libc``:
1872 -  The :ref:`libc-common <ref-classes-libc*>` class provides common support for building with
1875 -  The :ref:`libc-package <ref-classes-libc*>` class supports packaging up ``glibc`` and
1883 The :ref:`ref-classes-license` class provides license manifest creation and license
1892 The :ref:`ref-classes-linux-kernel-base` class provides common functionality for
1911 The :ref:`ref-classes-logging` class provides the standard shell functions used to log
1915 This class is enabled by default since it is inherited by the :ref:`ref-classes-base`
1923 The :ref:`ref-classes-meson` class allows to create recipes that build software
1934 The :ref:`ref-classes-metadata_scm` class provides functionality for querying the
1937 The :ref:`ref-classes-base` class uses this class to print the revisions of
1938 each layer before starting every build. The :ref:`ref-classes-metadata_scm`
1940 :ref:`ref-classes-base` class.
1947 The :ref:`ref-classes-mime` class generates the proper post-install and post-remove
1957 The :ref:`ref-classes-mime-xdg` class generates the proper
1978 The :ref:`ref-classes-mirrors` class sets up some standard
1984 :ref:`ref-classes-base` class.
1991 The :ref:`ref-classes-module` class provides support for building out-of-tree Linux
1992 kernel modules. The class inherits the :ref:`ref-classes-module-base` and
1993 :ref:`ref-classes-kernel-module-split` classes, and implements the
1994 :ref:`ref-tasks-compile` and :ref:`ref-tasks-install` tasks. The class provides
1998 ":ref:`kernel-dev/common:incorporating out-of-tree modules`"
2006 The :ref:`ref-classes-module-base` class provides the base functionality for
2009 inherits this class as opposed to inheriting the :ref:`ref-classes-module`
2017 The :ref:`ref-classes-multilib*` classes provide support for building libraries with
2022 ":ref:`dev-manual/libraries:combining multiple versions of library files into one image`"
2030 The :ref:`ref-classes-native` class provides common functionality for recipes that
2037 -  Create a ``myrecipe-native.bb`` recipe that inherits the :ref:`ref-classes-native`
2040    :ref:`ref-classes-native` class is inherited last.
2062 Although applied differently, the :ref:`ref-classes-native` class is used with both
2072 The :ref:`ref-classes-nativesdk` class provides common functionality for recipes that
2080    :ref:`ref-classes-nativesdk` class. If you use this method, you must order the
2082    that the :ref:`ref-classes-nativesdk` class is inherited last.
2084 -  Create a :ref:`ref-classes-nativesdk` variant of any recipe by adding the following::
2103 Although applied differently, the :ref:`ref-classes-nativesdk` class is used with both
2121 The :ref:`ref-classes-nospdx` allows a recipe to opt out of SPDX
2122 generation provided by :ref:`ref-classes-create-spdx`.
2138 ":ref:`dev-manual/packages:creating node package manager (npm) packages`"
2146 The :ref:`ref-classes-oelint` class is an obsolete lint checking tool available in
2150 are never actually used within OE-Core itself. The :ref:`ref-classes-oelint` class is
2164 between updates. The :ref:`ref-classes-overlayfs` class provides a way
2204 To achieve that :ref:`ref-classes-overlayfs` provides a ``systemd``
2217    In order to get ``/etc`` in overlayfs, see :ref:`ref-classes-overlayfs-etc`.
2269 The :ref:`ref-classes-own-mirrors` class makes it easier to set up your own
2288 The :ref:`ref-classes-package` class supports generating packages from a build's
2291 package-specific classes: :ref:`ref-classes-package_deb`,
2292 :ref:`ref-classes-package_rpm`, :ref:`ref-classes-package_ipk`.
2306 ":ref:`dev-manual/packages:using runtime package management`"
2317 ":ref:`ref-classes-package_ipk`" if you are building smaller systems.
2345 The :ref:`ref-classes-package_deb` class provides support for creating packages that
2350 This class inherits the :ref:`ref-classes-package` class and
2359 The :ref:`ref-classes-package_ipk` class provides support for creating packages that
2364 This class inherits the :ref:`ref-classes-package` class and
2373 The :ref:`ref-classes-package_rpm` class provides support for creating packages that
2378 This class inherits the :ref:`ref-classes-package` class and
2387 The :ref:`ref-classes-packagedata` class provides common functionality for reading
2393 :ref:`ref-classes-package` class.
2400 The :ref:`ref-classes-packagegroup` class sets default values appropriate for package
2406 ":ref:`dev-manual/customizing-images:customizing images using custom package groups`"
2416 The :ref:`ref-classes-patch` class provides all functionality for applying patches
2417 during the :ref:`ref-tasks-patch` task.
2420 :ref:`ref-classes-base` class.
2427 When inherited by a recipe, the :ref:`ref-classes-perlnative` class supports using the
2436 The :ref:`ref-classes-pypi` class sets variables appropriately for recipes that build
2443 Variables set by the :ref:`ref-classes-pypi` class include :term:`SRC_URI`, :term:`SECTION`,
2452 The :ref:`ref-classes-python_flit_core` class enables building Python modules which declare
2460 Internally this uses the :ref:`ref-classes-python_pep517` class.
2467 The :ref:`ref-classes-python_maturin` class provides support for python-maturin, a replacement
2475 The :ref:`ref-classes-python_mesonpy` class enables building Python modules which use the
2478 Internally this uses the :ref:`ref-classes-python_pep517` class.
2485 The :ref:`ref-classes-python_pep517` class builds and installs a Python ``wheel`` binary
2491 Examples of classes which do this are :ref:`ref-classes-python_flit_core`,
2492 :ref:`ref-classes-python_setuptools_build_meta`, and
2493 :ref:`ref-classes-python_poetry_core`.
2500 The :ref:`ref-classes-python_poetry_core` class enables building Python modules which use the
2503 Internally this uses the :ref:`ref-classes-python_pep517` class.
2510 The :ref:`ref-classes-python_pyo3` class helps make sure that Python extensions
2514 This class is internal to the :ref:`ref-classes-python-setuptools3_rust` class
2522 The :ref:`ref-classes-python-setuptools3_rust` class enables building Python
2527 This class inherits the :ref:`ref-classes-setuptools3` and
2528 :ref:`ref-classes-python_pyo3` classes.
2535 The :ref:`ref-classes-pixbufcache` class generates the proper post-install and
2553 The :ref:`ref-classes-pkgconfig` class provides a standard way to get header and
2559 ``pkg-config``, the :ref:`ref-classes-pkgconfig` class no longer has to manipulate the
2567 The :ref:`ref-classes-populate-sdk` class provides support for SDK-only recipes. For
2569 toolchain using the :ref:`ref-tasks-populate_sdk`
2570 task, see the ":ref:`sdk-manual/appendix-obtain:building an sdk installer`"
2579 The :ref:`ref-classes-populate-sdk-*` classes support SDK creation and consist of the
2582 -  :ref:`populate_sdk_base <ref-classes-populate-sdk-*>`: The base class supporting SDK creation un…
2585 -  :ref:`populate_sdk_deb <ref-classes-populate-sdk-*>`: Supports creation of the SDK given the Deb…
2588 -  :ref:`populate_sdk_rpm <ref-classes-populate-sdk-*>`: Supports creation of the SDK given the RPM
2591 -  :ref:`populate_sdk_ipk <ref-classes-populate-sdk-*>`: Supports creation of the SDK given the opkg
2594 -  :ref:`populate_sdk_ext <ref-classes-populate-sdk-*>`: Supports extensible SDK creation under all
2597 The :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class inherits the appropriate
2603 :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` class constructs two sysroots:
2616 The respective :ref:`populate_sdk_deb <ref-classes-populate-sdk-*>`, :ref:`populate_sdk_rpm <ref-cl…
2617 :ref:`populate_sdk_ipk <ref-classes-populate-sdk-*>` classes each support the specific type of SDK.
2618 These classes are inherited by and used with the :ref:`populate_sdk_base <ref-classes-populate-sdk-…
2622 the ":ref:`overview-manual/concepts:cross-development toolchain generation`"
2625 toolchain using the :ref:`ref-tasks-populate_sdk`
2627 ":ref:`sdk-manual/appendix-obtain:building an sdk installer`"
2636 The :ref:`ref-classes-prexport` class provides functionality for exporting
2649 The :ref:`ref-classes-primport` class provides functionality for importing
2662 The :ref:`ref-classes-prserv` class provides functionality for using a :ref:`PR
2668 :ref:`ref-classes-package` class. However, the OpenEmbedded
2677 The :ref:`ref-classes-ptest` class provides functionality for packaging and installing
2683 ":ref:`test-manual/ptest:testing packages with ptest`"
2692 The :ref:`ref-classes-ptest-cargo` class is a class which extends the
2693 :ref:`ref-classes-cargo` class and adds ``compile_ptest_cargo`` and
2707 ":ref:`test-manual/ptest:testing packages with ptest`"
2715 The :ref:`ref-classes-python3-dir` class provides the base version, location, and site
2723 The :ref:`ref-classes-python3native` class supports using the native version of Python
2732 The :ref:`ref-classes-python3targetconfig` class supports using the native version of Python
2744 The :ref:`ref-classes-qemu` class provides functionality for recipes that either need
2754 The :ref:`ref-classes-recipe_sanity` class checks for the presence of any host system
2763 The :ref:`ref-classes-relocatable` class enables relocation of binaries when they are
2766 This class makes use of the :ref:`ref-classes-chrpath` class and is used by
2767 both the :ref:`ref-classes-cross` and :ref:`ref-classes-native` classes.
2774 The :ref:`ref-classes-remove-libtool` class adds a post function to the
2775 :ref:`ref-tasks-install` task to remove all ``.la`` files
2786    The :ref:`ref-classes-remove-libtool` class is not enabled by default.
2793 The :ref:`ref-classes-report-error` class supports enabling the :ref:`error reporting
2808 The :ref:`ref-classes-retain` class can be used to create a tarball of the work
2825 The :ref:`ref-classes-rm-work` class supports deletion of temporary workspace, which
2835 progresses, you can enable :ref:`ref-classes-rm-work` by adding the following to
2841 recipe, enabling :ref:`ref-classes-rm-work` will potentially result in your
2843 directories deleted by :ref:`ref-classes-rm-work`, you can add the names of the
2854 The :ref:`ref-classes-rootfs*` classes support creating the root filesystem for an
2857 -  The :ref:`rootfs-postcommands <ref-classes-rootfs*>` class, which defines filesystem
2860 -  The :ref:`rootfs_deb <ref-classes-rootfs*>` class, which supports creation of root filesystems
2863 -  The :ref:`rootfs_rpm <ref-classes-rootfs*>` class, which supports creation of root filesystems
2866 -  The :ref:`rootfs_ipk <ref-classes-rootfs*>` class, which supports creation of root filesystems
2869 -  The :ref:`rootfsdebugfiles <ref-classes-rootfs*>` class, which installs additional files found
2873 :ref:`ref-classes-rootfs*` files as determined by the :term:`PACKAGE_CLASSES`
2877 ":ref:`overview-manual/concepts:image generation`"
2885 The :ref:`ref-classes-rust` class is an internal class which is just used
2894 The :ref:`ref-classes-rust-common` class is an internal class to the
2895 :ref:`ref-classes-cargo_common` and :ref:`ref-classes-rust` classes and is not
2903 The :ref:`ref-classes-sanity` class checks to see if prerequisite software is present
2915 The :ref:`ref-classes-scons` class supports recipes that need to build software
2925 The :ref:`ref-classes-sdl` class supports recipes that need to build software that uses
2933 The :ref:`ref-classes-python_setuptools_build_meta` class enables building
2942 Internally this uses the :ref:`ref-classes-python_pep517` class.
2949 The :ref:`ref-classes-setuptools3` class supports Python version 3.x extensions
2953 :ref:`ref-classes-setuptools3` class.
2957       The :ref:`ref-classes-setuptools3` class :ref:`ref-tasks-compile` task now calls
2968      The :ref:`ref-classes-setuptools3` class :ref:`ref-tasks-install` task now
2973      :ref:`ref-classes-setuptools3_legacy` should be used.
2980 The :ref:`ref-classes-setuptools3_legacy` class supports
2983 ``pyproject.toml`` format). Unlike :ref:`ref-classes-setuptools3`,
2994 The :ref:`ref-classes-setuptools3-base` class provides a reusable base for
2996 functionality that is not provided by the :ref:`ref-classes-setuptools3` class,
2998 in the :ref:`ref-classes-setuptools3` class and inherit this class instead.
3005 The :ref:`ref-classes-sign_rpm` class supports generating signed RPM packages.
3012 The :ref:`ref-classes-siteinfo` class provides information about the targets
3033 The :ref:`ref-classes-sstate` class provides support for Shared State (sstate).
3038 ":ref:`overview-manual/concepts:shared state cache`"
3046 The :ref:`ref-classes-staging` class installs files into individual recipe work
3049 -  The :ref:`ref-tasks-populate_sysroot` task,
3054    :ref:`ref-tasks-prepare_recipe_sysroot`
3059 The code in the :ref:`ref-classes-staging` class is complex and basically works
3065    the :ref:`ref-tasks-install` task into
3066    ``${``\ :term:`D`\ ``}``. The :ref:`ref-tasks-populate_sysroot` task
3082    :ref:`structure-build-tmp-sysroots-components`.
3095    :ref:`ref-tasks-prepare_recipe_sysroot`
3133    ``setscene_depvalid()`` function in the :ref:`ref-classes-sstate` class.
3145 The :ref:`ref-classes-syslinux` class provides syslinux-specific functions for
3188 The :ref:`ref-classes-systemd` class provides support for recipes that install
3195 calling during the :ref:`ref-tasks-install` task)
3214 For more information on :ref:`ref-classes-systemd`, see the
3215 ":ref:`dev-manual/init-manager:selecting an initialization manager`"
3223 The :ref:`ref-classes-systemd-boot` class provides functions specific to the
3229    The :ref:`ref-classes-systemd-boot` class is a result from merging the ``gummiboot`` class
3232 Set the :term:`EFI_PROVIDER` variable to ":ref:`ref-classes-systemd-boot`" to
3250 The :ref:`ref-classes-terminal` class provides support for starting a terminal
3254 Other classes use the :ref:`ref-classes-terminal` class anywhere a separate
3255 terminal session needs to be started. For example, the :ref:`ref-classes-patch`
3257 :ref:`ref-classes-cml1` class, and the :ref:`ref-classes-devshell` class all
3258 use the :ref:`ref-classes-terminal` class.
3265 The :ref:`ref-classes-testimage` class supports running automated tests against
3277 The :ref:`ref-classes-testimage` class runs tests on an image when called using the
3288 ":ref:`test-manual/runtime-testing:performing automated runtime testing`"
3297 kits (SDKs). The :ref:`ref-classes-testsdk` class runs tests on an SDK when called
3305    :term:`INHERIT` to inherit the :ref:`ref-classes-testsdk` class for automated SDK
3331 The :ref:`ref-classes-toaster` class collects information about packages and images and
3342 The :ref:`ref-classes-toolchain-scripts` class provides the scripts used for setting up
3350 The :ref:`ref-classes-typecheck` class provides support for validating the values of
3362 The :ref:`ref-classes-uboot-config` class provides support for U-Boot configuration for
3380 The :ref:`ref-classes-uboot-sign` class provides support for U-Boot verified boot.
3410 See also the description of :ref:`ref-classes-kernel-fitimage` class, which this class
3418 The :ref:`ref-classes-uki` class provides support for `Unified Kernel Image
3481 The :ref:`ref-classes-uninative` class is also used unconditionally by the extensible
3490 The :ref:`ref-classes-update-alternatives` class helps the alternatives system when
3495 :ref:`ref-classes-update-alternatives` class handles renaming the binaries so that
3528 The :ref:`ref-classes-update-rc.d` class uses ``update-rc.d`` to safely install an
3542 The :ref:`useradd* <ref-classes-useradd>` classes support the addition of users or groups for
3551 The :ref:`useradd_base <ref-classes-useradd>` class provides basic functionality for user or
3554 The :ref:`useradd* <ref-classes-useradd>` classes support the
3560 The :ref:`useradd-staticids <ref-classes-useradd>` class supports the addition of users or groups
3579 You can also see the :ref:`ref-classes-useradd` class for additional
3584 …You do not use the :ref:`useradd-staticids <ref-classes-useradd>` class directly. You either enable
3595 The :ref:`ref-classes-utility-tasks` class provides support for various
3597 :ref:`ref-tasks-clean` and :ref:`ref-tasks-listtasks`.
3600 :ref:`ref-classes-base` class.
3607 The :ref:`ref-classes-utils` class provides some useful Python functions that are
3612 :ref:`ref-classes-base` class.
3619 The :ref:`ref-classes-vala` class supports recipes that need to build software written
3627 The :ref:`ref-classes-vex` class is used to generate metadata needed by external
3629 replacement for :ref:`ref-classes-cve-check`.
3641 :ref:`ref-classes-cve-check` class.
3652 The :ref:`ref-classes-waf` class supports recipes that need to build software that uses
3664 The :ref:`ref-classes-yocto-check-layer` class is used by the
3668 :ref:`ref-classes-insane` class.
3676 Compatible layers, see the :ref:`dev-manual/layers:Making Sure Your Layer is