documentation/ref-manual/classes.rst

4 Classes  title
16 ``.bbclass`` and are usually placed in a ``classes/`` directory beneath
24 This chapter discusses only the most useful and important classes. Other
25 classes do exist within the ``meta/classes`` directory in the Source
29 .. _ref-classes-allarch:
55 By default, all recipes inherit the :ref:`base <ref-classes-base>` and
56 :ref:`package <ref-classes-package>` classes, which enable
62 .. _ref-classes-archiver:
76 .. _ref-classes-autotools:
81 The ``autotools*`` classes support Autotooled packages.
87 simply ``inherit autotools``. These classes can also work with software
92 By default, the ``autotools*`` classes use out-of-tree builds (i.e.
108 ``autotools*`` classes work and what they do behind the scenes.
124 .. _ref-classes-base:
133 and packaging (empty by default). These classes are often overridden or
134 extended by other classes such as the
135 :ref:`autotools <ref-classes-autotools>` class or the
136 :ref:`package <ref-classes-package>` class.
143 .. _ref-classes-bash-completion:
151 .. _ref-classes-bin-package:
178 .. _ref-classes-binconfig:
198 .. _ref-classes-binconfig-disabled:
203 An alternative version of the :ref:`binconfig <ref-classes-binconfig>`
210 .. _ref-classes-buildhistory:
222 .. _ref-classes-buildstats:
243 .. _ref-classes-buildstats-summary:
250 :ref:`buildstats <ref-classes-buildstats>` class be enabled.
252 .. _ref-classes-ccache:
261 Cache, and the :oe_git:`ccache.bbclass </openembedded-core/tree/meta/classes/ccache.bbclass>`
269 .. _ref-classes-chrpath:
279 .. _ref-classes-cmake:
296 .. _ref-classes-cml1:
304 .. _ref-classes-compress_doc:
314 .. _ref-classes-copyleft_compliance:
322 in favor of the :ref:`archiver <ref-classes-archiver>` class.
324 .. _ref-classes-copyleft_filter:
329 A class used by the :ref:`archiver <ref-classes-archiver>` and
330 :ref:`copyleft_compliance <ref-classes-copyleft_compliance>` classes
334 .. _ref-classes-core-image:
343 .. _ref-classes-cpan:
348 The ``cpan*`` classes support Perl modules.
364 .. _ref-classes-create-spdx:
369 The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for
390 .. _ref-classes-cross:
398 .. _ref-classes-cross-canadian:
409 .. _ref-classes-crosssdk:
420 .. _ref-classes-cve-check:
425 The :ref:`cve-check <ref-classes-cve-check>` class looks for known CVEs (Common Vulnerabilities
484 .. _ref-classes-debian:
499 .. _ref-classes-deploy:
515 .. _ref-classes-devshell:
525 .. _ref-classes-devupstream:
562 .. _ref-classes-externalsrc:
593 ``meta/classes/externalsrc.bbclass`` in the :term:`Source Directory`.
599 .. _ref-classes-extrausers:
613    :ref:`extrausers <ref-classes-extrausers>`
617    :ref:`useradd <ref-classes-useradd>`
661 .. _ref-classes-features_check:
687 .. _ref-classes-fontcache:
703 .. _ref-classes-fs-uuid:
713 .. _ref-classes-gconf:
725 .. _ref-classes-gettext:
735 .. _ref-classes-gnomebase:
746 .. _ref-classes-gobject-introspection:
764 .. _ref-classes-grub-efi:
796 .. _ref-classes-gsettings:
807 .. _ref-classes-gtk-doc:
815 .. _ref-classes-gtk-icon-cache:
828 .. _ref-classes-gtk-immodules-cache:
846 .. _ref-classes-gzipnative:
855 .. _ref-classes-icecc:
895 specific recipes or classes, you can ask them to be ignored by Icecream
896 by listing the recipes and classes using the
928 .. _ref-classes-image:
951 .. _ref-classes-image-buildinfo:
959 .. _ref-classes-image_types:
970 By default, the :ref:`image <ref-classes-image>` class automatically
991 .. _ref-classes-image-live:
1004 .. _ref-classes-insane:
1069    :ref:`update-rc.d <ref-classes-update-rc.d>` class automatically
1304 .. _ref-classes-insserv:
1314 .. _ref-classes-kernel:
1322 using the :ref:`module <ref-classes-module>` class.
1336 Various other classes are used by the ``kernel`` and ``module`` classes
1337 internally including the :ref:`kernel-arch <ref-classes-kernel-arch>`,
1338 :ref:`module-base <ref-classes-module-base>`, and
1339 :ref:`linux-kernel-base <ref-classes-linux-kernel-base>` classes.
1341 .. _ref-classes-kernel-arch:
1349 .. _ref-classes-kernel-devicetree:
1355 :ref:`kernel <ref-classes-kernel>` class, supports device tree
1358 .. _ref-classes-kernel-fitimage:
1429 .. _ref-classes-kernel-grub:
1438 .. _ref-classes-kernel-module-split:
1446 .. _ref-classes-kernel-uboot:
1454 .. _ref-classes-kernel-uimage:
1461 .. _ref-classes-kernel-yocto:
1469 .. _ref-classes-kernelsrc:
1476 .. _ref-classes-lib_package:
1487 .. _ref-classes-libc*:
1492 The ``libc*`` classes support recipes that build packages with ``libc``:
1500 .. _ref-classes-license:
1509 .. _ref-classes-linux-kernel-base:
1519 .. _ref-classes-linuxloader:
1526 number of other classes.
1528 .. _ref-classes-logging:
1540 .. _ref-classes-metadata_scm:
1548 The :ref:`base <ref-classes-base>` class uses this class to print the
1553 .. _ref-classes-migrate_localcount:
1561 .. _ref-classes-mime:
1571 .. _ref-classes-mirrors:
1582 :ref:`base <ref-classes-base>` class.
1584 .. _ref-classes-module:
1591 :ref:`module-base <ref-classes-module-base>` and
1592 :ref:`kernel-module-split <ref-classes-kernel-module-split>` classes,
1601 .. _ref-classes-module-base:
1610 :ref:`module <ref-classes-module>` class.
1612 .. _ref-classes-multilib*:
1617 The ``multilib*`` classes provide support for building libraries with
1625 .. _ref-classes-native:
1667 .. _ref-classes-nativesdk:
1708 .. _ref-classes-nopackages:
1713 Disables packaging tasks for those recipes and classes where packaging
1716 .. _ref-classes-npm:
1733 .. _ref-classes-oelint:
1739 ``meta/classes`` in the :term:`Source Directory`.
1741 There are some classes that could be generally useful in OE-Core but
1744 proliferation of different versions of similar classes across multiple
1747 .. _ref-classes-overlayfs:
1756 between updates. The :ref:`overlayfs <ref-classes-overlayfs>` class provides a way
1796 To achieve that :ref:`overlayfs <ref-classes-overlayfs>` provides a ``systemd``
1809    In order to get ``/etc`` in overlayfs, see :ref:`overlayfs-etc <ref-classes-overlayfs-etc>`.
1811 .. _ref-classes-overlayfs-etc:
1856 .. _ref-classes-own-mirrors:
1875 .. _ref-classes-package:
1883 package-specific classes:
1884 :ref:`package_deb <ref-classes-package_deb>`,
1885 :ref:`package_rpm <ref-classes-package_rpm>`,
1886 :ref:`package_ipk <ref-classes-package_ipk>`, and
1887 :ref:`package_tar <ref-classes-package_tar>`.
1942 .. _ref-classes-package_deb:
1952 This class inherits the :ref:`package <ref-classes-package>` class and
1956 .. _ref-classes-package_ipk:
1966 This class inherits the :ref:`package <ref-classes-package>` class and
1970 .. _ref-classes-package_rpm:
1980 This class inherits the :ref:`package <ref-classes-package>` class and
1984 .. _ref-classes-package_tar:
1993 This class inherits the :ref:`package <ref-classes-package>` class and
2003 .. _ref-classes-packagedata:
2014 :ref:`package <ref-classes-package>` class.
2016 .. _ref-classes-packagegroup:
2032 .. _ref-classes-patch:
2041 :ref:`base <ref-classes-base>` class.
2043 .. _ref-classes-perlnative:
2052 .. _ref-classes-pypi:
2057 The :ref:`pypi <ref-classes-pypi>` class sets variables appropriately for recipes that build
2064 Variables set by the :ref:`pypi <ref-classes-pypi>` class include :term:`SRC_URI`, :term:`SECTION`,
2068 .. _ref-classes-python_flit_core:
2081 Internally this uses the :ref:`python_pep517 <ref-classes-python_pep517>` class.
2083 .. _ref-classes-python_pep517:
2096 Examples of classes which do this are :ref:`python_flit_core
2097 <ref-classes-python_flit_core>`, :ref:`python_setuptools_build_meta
2098 <ref-classes-python_setuptools_build_meta>`, and :ref:`python_poetry_core
2099 <ref-classes-python_poetry_core>`.
2101 .. _ref-classes-python_poetry_core:
2109 Internally this uses the :ref:`python_pep517 <ref-classes-python_pep517>` class.
2111 .. _ref-classes-pixbufcache:
2129 .. _ref-classes-pkgconfig:
2143 .. _ref-classes-populate-sdk:
2155 .. _ref-classes-populate-sdk-*:
2160 The ``populate_sdk_*`` classes support SDK creation and consist of the
2161 following classes:
2198 ``populate_sdk_ipk`` classes each support the specific type of SDK.
2199 These classes are inherited by and used with the ``populate_sdk_base``
2212 .. _ref-classes-prexport:
2225 .. _ref-classes-primport:
2238 .. _ref-classes-prserv:
2249 :ref:`package <ref-classes-package>` class. However, the OpenEmbedded
2253 .. _ref-classes-ptest:
2268 .. _ref-classes-ptest-gnome:
2280 .. _ref-classes-python3-dir:
2288 .. _ref-classes-python3native:
2297 .. _ref-classes-python3targetconfig:
2309 .. _ref-classes-qemu:
2319 .. _ref-classes-recipe_sanity:
2328 .. _ref-classes-relocatable:
2336 This class makes use of the :ref:`chrpath <ref-classes-chrpath>` class
2337 and is used by both the :ref:`cross <ref-classes-cross>` and
2338 :ref:`native <ref-classes-native>` classes.
2340 .. _ref-classes-remove-libtool:
2359 .. _ref-classes-report-error:
2374 .. _ref-classes-rm-work:
2405 .. _ref-classes-rootfs*:
2410 The ``rootfs*`` classes support creating the root filesystem for an
2411 image and consist of the following classes:
2436 .. _ref-classes-sanity:
2448 .. _ref-classes-scons:
2458 .. _ref-classes-sdl:
2466 .. _ref-classes-python_setuptools_build_meta:
2480 Internally this uses the :ref:`python_pep517 <ref-classes-python_pep517>` class.
2482 .. _ref-classes-setuptools3:
2510      <ref-classes-setuptools3_legacy>` should be used.
2512 .. _ref-classes-setuptools3_legacy:
2525 .. _ref-classes-setuptools3-base:
2530 The ``setuptools3-base`` class provides a reusable base for other classes
2532 functionality that is not provided by the :ref:`setuptools3 <ref-classes-setuptools3>` class, you m…
2534 in the :ref:`setuptools3 <ref-classes-setuptools3>` class and inherit this class instead.
2536 .. _ref-classes-sign_rpm:
2543 .. _ref-classes-sip:
2551 .. _ref-classes-siteconfig:
2558 :ref:`autotools <ref-classes-autotools>` class to accelerate the
2561 .. _ref-classes-siteinfo:
2567 be needed by other classes or recipes.
2582 .. _ref-classes-sstate:
2595 .. _ref-classes-staging:
2688    :ref:`sstate <ref-classes-sstate>` class.
2695 .. _ref-classes-syslinux:
2738 .. _ref-classes-systemd:
2773 .. _ref-classes-systemd-boot:
2800 .. _ref-classes-terminal:
2809 Other classes use the ``terminal`` class anywhere a separate terminal
2811 :ref:`patch <ref-classes-patch>` class assuming
2813 :ref:`cml1 <ref-classes-cml1>` class, and the
2814 :ref:`devshell <ref-classes-devshell>` class all use the ``terminal``
2817 .. _ref-classes-testimage*:
2822 The ``testimage*`` classes support running automated tests against
2823 images using QEMU and on actual hardware. The classes handle loading the
2824 tests and starting the image. To use the classes, you need to perform
2849 .. _ref-classes-testsdk:
2866 .. _ref-classes-texinfo:
2884 .. _ref-classes-toaster:
2895 .. _ref-classes-toolchain-scripts:
2903 .. _ref-classes-typecheck:
2915 .. _ref-classes-uboot-config:
2933 .. _ref-classes-uninative:
2955 .. _ref-classes-update-alternatives:
2985 :yocto_git:`update-alternatives.bbclass </poky/tree/meta/classes/update-alternatives.bbclass>`
2993 .. _ref-classes-update-rc.d:
3007 .. _ref-classes-useradd:
3012 The ``useradd*`` classes support the addition of users or groups for
3015 group, you can use these classes to enable creation of the user or
3024 The ``useradd*`` classes support the
3051 You can also see the :ref:`useradd <ref-classes-useradd>` class for
3062 .. _ref-classes-utility-tasks:
3073 :ref:`base <ref-classes-base>` class.
3075 .. _ref-classes-utils:
3085 :ref:`base <ref-classes-base>` class.
3087 .. _ref-classes-vala:
3095 .. _ref-classes-waf: