summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2023-01-04 11:26:08 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2023-01-06 17:39:09 +0000
commitae280972ffba62d7ed839b692957f61b0955cbca (patch)
treea1c52c9ef7ce4e72b50c2e07b729559e55c2c5be /documentation
parent51addfc756b02cc2b3244dc4be18abc163bb019d (diff)
downloadpoky-ae280972ffba62d7ed839b692957f61b0955cbca.tar.gz
ref-manual/classes.rst: remove .bbclass from section titles
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>`. (From yocto-docs rev: 44fbdb909c47553fecb7f9eb37f065a8768bc922) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Suggested-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/classes.rst588
1 files changed, 294 insertions, 294 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 7f760c5ba4..fed3dcc066 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -34,8 +34,8 @@ information.
34 34
35.. _ref-classes-allarch: 35.. _ref-classes-allarch:
36 36
37``allarch.bbclass`` 37``allarch``
38=================== 38===========
39 39
40The :ref:`allarch <ref-classes-allarch>` class is inherited by recipes that do not produce 40The :ref:`allarch <ref-classes-allarch>` class is inherited by recipes that do not produce
41architecture-specific output. The class disables functionality that is 41architecture-specific output. The class disables functionality that is
@@ -67,8 +67,8 @@ inherit the :ref:`allarch <ref-classes-allarch>` class.
67 67
68.. _ref-classes-archiver: 68.. _ref-classes-archiver:
69 69
70``archiver.bbclass`` 70``archiver``
71==================== 71============
72 72
73The :ref:`archiver <ref-classes-archiver>` class supports releasing source code and other 73The :ref:`archiver <ref-classes-archiver>` class supports releasing source code and other
74materials with the binaries. 74materials with the binaries.
@@ -81,8 +81,8 @@ about the variable flags (varflags) that help control archive creation.
81 81
82.. _ref-classes-autotools: 82.. _ref-classes-autotools:
83 83
84``autotools*.bbclass`` 84``autotools*``
85====================== 85==============
86 86
87The :ref:`autotools* <ref-classes-autotools>` classes support packages built with the 87The :ref:`autotools* <ref-classes-autotools>` classes support packages built with the
88:wikipedia:`GNU Autotools <GNU_Autotools>`. 88:wikipedia:`GNU Autotools <GNU_Autotools>`.
@@ -130,8 +130,8 @@ It's useful to have some idea of how the tasks defined by the
130 130
131.. _ref-classes-base: 131.. _ref-classes-base:
132 132
133``base.bbclass`` 133``base``
134================ 134========
135 135
136The :ref:`base <ref-classes-base>` class is special in that every ``.bb`` file implicitly 136The :ref:`base <ref-classes-base>` class is special in that every ``.bb`` file implicitly
137inherits the class. This class contains definitions for standard basic 137inherits the class. This class contains definitions for standard basic
@@ -149,16 +149,16 @@ arguments passed directly to ``oe_runmake``.
149 149
150.. _ref-classes-bash-completion: 150.. _ref-classes-bash-completion:
151 151
152``bash-completion.bbclass`` 152``bash-completion``
153=========================== 153===================
154 154
155Sets up packaging and dependencies appropriate for recipes that build 155Sets up packaging and dependencies appropriate for recipes that build
156software that includes bash-completion data. 156software that includes bash-completion data.
157 157
158.. _ref-classes-bin-package: 158.. _ref-classes-bin-package:
159 159
160``bin_package.bbclass`` 160``bin_package``
161======================= 161===============
162 162
163The :ref:`bin_package <ref-classes-bin-package>` class is a helper class for recipes that extract the 163The :ref:`bin_package <ref-classes-bin-package>` class is a helper class for recipes that extract the
164contents of a binary package (e.g. an RPM) and install those contents 164contents of a binary package (e.g. an RPM) and install those contents
@@ -184,8 +184,8 @@ example use for this class.
184 184
185.. _ref-classes-binconfig: 185.. _ref-classes-binconfig:
186 186
187``binconfig.bbclass`` 187``binconfig``
188===================== 188=============
189 189
190The :ref:`binconfig <ref-classes-binconfig>` class helps to correct paths in shell scripts. 190The :ref:`binconfig <ref-classes-binconfig>` class helps to correct paths in shell scripts.
191 191
@@ -204,8 +204,8 @@ information.
204 204
205.. _ref-classes-binconfig-disabled: 205.. _ref-classes-binconfig-disabled:
206 206
207``binconfig-disabled.bbclass`` 207``binconfig-disabled``
208============================== 208======================
209 209
210An alternative version of the :ref:`binconfig <ref-classes-binconfig>` 210An alternative version of the :ref:`binconfig <ref-classes-binconfig>`
211class, which disables binary configuration scripts by making them return 211class, which disables binary configuration scripts by making them return
@@ -215,8 +215,8 @@ variable within the recipe inheriting the class.
215 215
216.. _ref-classes-buildhistory: 216.. _ref-classes-buildhistory:
217 217
218``buildhistory.bbclass`` 218``buildhistory``
219======================== 219================
220 220
221The :ref:`buildhistory <ref-classes-buildhistory>` class records a history of build output metadata, 221The :ref:`buildhistory <ref-classes-buildhistory>` class records a history of build output metadata,
222which can be used to detect possible regressions as well as used for 222which can be used to detect possible regressions as well as used for
@@ -227,8 +227,8 @@ section in the Yocto Project Development Tasks Manual.
227 227
228.. _ref-classes-buildstats: 228.. _ref-classes-buildstats:
229 229
230``buildstats.bbclass`` 230``buildstats``
231====================== 231==============
232 232
233The :ref:`buildstats <ref-classes-buildstats>` class records performance statistics about each task 233The :ref:`buildstats <ref-classes-buildstats>` class records performance statistics about each task
234executed during the build (e.g. elapsed time, CPU usage, and I/O usage). 234executed 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
248 248
249.. _ref-classes-buildstats-summary: 249.. _ref-classes-buildstats-summary:
250 250
251``buildstats-summary.bbclass`` 251``buildstats-summary``
252============================== 252======================
253 253
254When inherited globally, prints statistics at the end of the build on 254When inherited globally, prints statistics at the end of the build on
255sstate re-use. In order to function, this class requires the 255sstate 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
257 257
258.. _ref-classes-ccache: 258.. _ref-classes-ccache:
259 259
260``ccache.bbclass`` 260``ccache``
261================== 261==========
262 262
263The :ref:`ccache <ref-classes-ccache>` class enables the C/C++ Compiler Cache for the build. 263The :ref:`ccache <ref-classes-ccache>` class enables the C/C++ Compiler Cache for the build.
264This class is used to give a minor performance boost during the build. 264This class is used to give a minor performance boost during the build.
@@ -274,8 +274,8 @@ this class is not recommended.
274 274
275.. _ref-classes-chrpath: 275.. _ref-classes-chrpath:
276 276
277``chrpath.bbclass`` 277``chrpath``
278=================== 278===========
279 279
280The :ref:`chrpath <ref-classes-chrpath>` class is a wrapper around the "chrpath" utility, which 280The :ref:`chrpath <ref-classes-chrpath>` class is a wrapper around the "chrpath" utility, which
281is used during the build process for :ref:`nativesdk <ref-classes-nativesdk>`, :ref:`cross <ref-classes-cross>`, and 281is 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.
284 284
285.. _ref-classes-cmake: 285.. _ref-classes-cmake:
286 286
287``cmake.bbclass`` 287``cmake``
288================= 288=========
289 289
290The ref:`cmake <ref-classes-cmake>` class allows for recipes that need to build software using 290The ref:`cmake <ref-classes-cmake>` class allows for recipes that need to build software using
291the `CMake <https://cmake.org/overview/>`__ build system. You can use 291the `CMake <https://cmake.org/overview/>`__ build system. You can use
@@ -301,16 +301,16 @@ Modules during
301 301
302.. _ref-classes-cml1: 302.. _ref-classes-cml1:
303 303
304``cml1.bbclass`` 304``cml1``
305================ 305========
306 306
307The :ref:`cml1 <ref-classes-cml1>` class provides basic support for the Linux kernel style 307The :ref:`cml1 <ref-classes-cml1>` class provides basic support for the Linux kernel style
308build configuration system. 308build configuration system.
309 309
310.. _ref-classes-compress_doc: 310.. _ref-classes-compress_doc:
311 311
312``compress_doc.bbclass`` 312``compress_doc``
313======================== 313================
314 314
315Enables compression for man pages and info pages. This class is intended 315Enables compression for man pages and info pages. This class is intended
316to be inherited globally. The default compression mechanism is gz (gzip) 316to be inherited globally. The default compression mechanism is gz (gzip)
@@ -319,8 +319,8 @@ but you can select an alternative mechanism by setting the
319 319
320.. _ref-classes-copyleft_compliance: 320.. _ref-classes-copyleft_compliance:
321 321
322``copyleft_compliance.bbclass`` 322``copyleft_compliance``
323=============================== 323=======================
324 324
325The :ref:`copyleft_compliance <ref-classes-copyleft_compliance>` class preserves source code for the purposes 325The :ref:`copyleft_compliance <ref-classes-copyleft_compliance>` class preserves source code for the purposes
326of license compliance. This class is an alternative to the :ref:`archiver <ref-classes-archiver>` 326of 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.
329 329
330.. _ref-classes-copyleft_filter: 330.. _ref-classes-copyleft_filter:
331 331
332``copyleft_filter.bbclass`` 332``copyleft_filter``
333=========================== 333===================
334 334
335A class used by the :ref:`archiver <ref-classes-archiver>` and 335A class used by the :ref:`archiver <ref-classes-archiver>` and
336:ref:`copyleft_compliance <ref-classes-copyleft_compliance>` classes 336:ref:`copyleft_compliance <ref-classes-copyleft_compliance>` classes
@@ -339,8 +339,8 @@ class and is not intended to be used directly.
339 339
340.. _ref-classes-core-image: 340.. _ref-classes-core-image:
341 341
342``core-image.bbclass`` 342``core-image``
343====================== 343==============
344 344
345The :ref:`core-image <ref-classes-core-image>` class provides common definitions for the 345The :ref:`core-image <ref-classes-core-image>` class provides common definitions for the
346``core-image-*`` image recipes, such as support for additional 346``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
348 348
349.. _ref-classes-cpan: 349.. _ref-classes-cpan:
350 350
351``cpan*.bbclass`` 351``cpan*``
352================= 352=========
353 353
354The :ref:`cpan* <ref-classes-cpan>` classes support Perl modules. 354The :ref:`cpan* <ref-classes-cpan>` classes support Perl modules.
355 355
@@ -369,8 +369,8 @@ support.
369 369
370.. _ref-classes-create-spdx: 370.. _ref-classes-create-spdx:
371 371
372``create-spdx.bbclass`` 372``create-spdx``
373======================= 373===============
374 374
375The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for 375The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for
376automatically creating :term:`SPDX` :term:`SBOM` documents based upon image 376automatically creating :term:`SPDX` :term:`SBOM` documents based upon image
@@ -395,16 +395,16 @@ section in the Yocto Project Development Manual for more details.
395 395
396.. _ref-classes-cross: 396.. _ref-classes-cross:
397 397
398``cross.bbclass`` 398``cross``
399================= 399=========
400 400
401The :ref:`cross <ref-classes-cross>` class provides support for the recipes that build the 401The :ref:`cross <ref-classes-cross>` class provides support for the recipes that build the
402cross-compilation tools. 402cross-compilation tools.
403 403
404.. _ref-classes-cross-canadian: 404.. _ref-classes-cross-canadian:
405 405
406``cross-canadian.bbclass`` 406``cross-canadian``
407========================== 407==================
408 408
409The :ref:`cross-canadian <ref-classes-cross-canadian>` class provides support for the recipes that build 409The :ref:`cross-canadian <ref-classes-cross-canadian>` class provides support for the recipes that build
410the Canadian Cross-compilation tools for SDKs. See the 410the Canadian Cross-compilation tools for SDKs. See the
@@ -414,8 +414,8 @@ discussion on these cross-compilation tools.
414 414
415.. _ref-classes-crosssdk: 415.. _ref-classes-crosssdk:
416 416
417``crosssdk.bbclass`` 417``crosssdk``
418==================== 418============
419 419
420The :ref:`crosssdk <ref-classes-crosssdk>` class provides support for the recipes that build the 420The :ref:`crosssdk <ref-classes-crosssdk>` class provides support for the recipes that build the
421cross-compilation tools used for building SDKs. See the 421cross-compilation tools used for building SDKs. See the
@@ -425,8 +425,8 @@ discussion on these cross-compilation tools.
425 425
426.. _ref-classes-cve-check: 426.. _ref-classes-cve-check:
427 427
428``cve-check.bbclass`` 428``cve-check``
429===================== 429=============
430 430
431The :ref:`cve-check <ref-classes-cve-check>` class looks for known CVEs (Common Vulnerabilities 431The :ref:`cve-check <ref-classes-cve-check>` class looks for known CVEs (Common Vulnerabilities
432and Exposures) while building with BitBake. This class is meant to be 432and Exposures) while building with BitBake. This class is meant to be
@@ -489,8 +489,8 @@ section in the Development Tasks Manual.
489 489
490.. _ref-classes-debian: 490.. _ref-classes-debian:
491 491
492``debian.bbclass`` 492``debian``
493================== 493==========
494 494
495The :ref:`debian <ref-classes-debian>` class renames output packages so that they follow the 495The :ref:`debian <ref-classes-debian>` class renames output packages so that they follow the
496Debian naming policy (i.e. ``glibc`` becomes ``libc6`` and 496Debian naming policy (i.e. ``glibc`` becomes ``libc6`` and
@@ -504,8 +504,8 @@ naming scheme.
504 504
505.. _ref-classes-deploy: 505.. _ref-classes-deploy:
506 506
507``deploy.bbclass`` 507``deploy``
508================== 508==========
509 509
510The :ref:`deploy <ref-classes-deploy>` class handles deploying files to the 510The :ref:`deploy <ref-classes-deploy>` class handles deploying files to the
511:term:`DEPLOY_DIR_IMAGE` directory. The main 511:term:`DEPLOY_DIR_IMAGE` directory. The main
@@ -520,8 +520,8 @@ staging the files from :term:`DEPLOYDIR` to :term:`DEPLOY_DIR_IMAGE`.
520 520
521.. _ref-classes-devshell: 521.. _ref-classes-devshell:
522 522
523``devshell.bbclass`` 523``devshell``
524==================== 524============
525 525
526The :ref:`devshell <ref-classes-devshell>` class adds the :ref:`ref-tasks-devshell` task. Distribution 526The :ref:`devshell <ref-classes-devshell>` class adds the :ref:`ref-tasks-devshell` task. Distribution
527policy dictates whether to include this class. See the ":ref:`dev-manual/development-shell:using a development shell`" 527policy 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>`.
530 530
531.. _ref-classes-devupstream: 531.. _ref-classes-devupstream:
532 532
533``devupstream.bbclass`` 533``devupstream``
534======================= 534===============
535 535
536The :ref:`devupstream <ref-classes-devupstream>` class uses 536The :ref:`devupstream <ref-classes-devupstream>` class uses
537:term:`BBCLASSEXTEND` to add a variant of the 537:term:`BBCLASSEXTEND` to add a variant of the
@@ -567,8 +567,8 @@ due to BitBake's automatic fetch dependencies (e.g.
567 567
568.. _ref-classes-externalsrc: 568.. _ref-classes-externalsrc:
569 569
570``externalsrc.bbclass`` 570``externalsrc``
571======================= 571===============
572 572
573The :ref:`externalsrc <ref-classes-externalsrc>` class supports building software from source code 573The :ref:`externalsrc <ref-classes-externalsrc>` class supports building software from source code
574that is external to the OpenEmbedded build system. Building software 574that is external to the OpenEmbedded build system. Building software
@@ -603,8 +603,8 @@ section in the Yocto Project Development Tasks Manual.
603 603
604.. _ref-classes-extrausers: 604.. _ref-classes-extrausers:
605 605
606``extrausers.bbclass`` 606``extrausers``
607====================== 607==============
608 608
609The :ref:`extrausers <ref-classes-extrausers>` class allows additional user and group configuration 609The :ref:`extrausers <ref-classes-extrausers>` class allows additional user and group configuration
610to be applied at the image level. Inheriting this class either globally 610to 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::
665 665
666.. _ref-classes-features_check: 666.. _ref-classes-features_check:
667 667
668``features_check.bbclass`` 668``features_check``
669================================= 669==================
670 670
671The :ref:`features_check <ref-classes-features_check>` class allows individual recipes to check 671The :ref:`features_check <ref-classes-features_check>` class allows individual recipes to check
672for required and conflicting 672for required and conflicting
@@ -691,8 +691,8 @@ triggered.
691 691
692.. _ref-classes-fontcache: 692.. _ref-classes-fontcache:
693 693
694``fontcache.bbclass`` 694``fontcache``
695===================== 695=============
696 696
697The :ref:`fontcache <ref-classes-fontcache>` class generates the proper post-install and 697The :ref:`fontcache <ref-classes-fontcache>` class generates the proper post-install and
698post-remove (postinst and postrm) scriptlets for font packages. These 698post-remove (postinst and postrm) scriptlets for font packages. These
@@ -707,8 +707,8 @@ packages containing the fonts.
707 707
708.. _ref-classes-fs-uuid: 708.. _ref-classes-fs-uuid:
709 709
710``fs-uuid.bbclass`` 710``fs-uuid``
711=================== 711===========
712 712
713The :ref:`fs-uuid <ref-classes-fs-uuid>` class extracts UUID from 713The :ref:`fs-uuid <ref-classes-fs-uuid>` class extracts UUID from
714``${``\ :term:`ROOTFS`\ ``}``, which must have been built 714``${``\ :term:`ROOTFS`\ ``}``, which must have been built
@@ -717,8 +717,8 @@ works on ``ext`` file systems and depends on ``tune2fs``.
717 717
718.. _ref-classes-gconf: 718.. _ref-classes-gconf:
719 719
720``gconf.bbclass`` 720``gconf``
721================= 721=========
722 722
723The :ref:`gconf <ref-classes-gconf>` class provides common functionality for recipes that need 723The :ref:`gconf <ref-classes-gconf>` class provides common functionality for recipes that need
724to install GConf schemas. The schemas will be put into a separate 724to install GConf schemas. The schemas will be put into a separate
@@ -729,8 +729,8 @@ register and unregister the schemas in the target image.
729 729
730.. _ref-classes-gettext: 730.. _ref-classes-gettext:
731 731
732``gettext.bbclass`` 732``gettext``
733=================== 733===========
734 734
735The :ref:`gettext <ref-classes-gettext>` class provides support for building 735The :ref:`gettext <ref-classes-gettext>` class provides support for building
736software that uses the GNU ``gettext`` internationalization and localization 736software that uses the GNU ``gettext`` internationalization and localization
@@ -739,8 +739,8 @@ class.
739 739
740.. _ref-classes-github-releases: 740.. _ref-classes-github-releases:
741 741
742``github-releases.bbclass`` 742``github-releases``
743=========================== 743===================
744 744
745For recipes that fetch release tarballs from github, the :ref:`github-releases <ref-classes-github-releases>` 745For recipes that fetch release tarballs from github, the :ref:`github-releases <ref-classes-github-releases>`
746class sets up a standard way for checking available upstream versions 746class 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.
753 753
754.. _ref-classes-gnomebase: 754.. _ref-classes-gnomebase:
755 755
756``gnomebase.bbclass`` 756``gnomebase``
757===================== 757=============
758 758
759The :ref:`gnomebase <ref-classes-gnomebase>` class is the base class for recipes that build 759The :ref:`gnomebase <ref-classes-gnomebase>` class is the base class for recipes that build
760software from the GNOME stack. This class sets 760software from the GNOME stack. This class sets
@@ -764,8 +764,8 @@ GNOME installation paths.
764 764
765.. _ref-classes-gobject-introspection: 765.. _ref-classes-gobject-introspection:
766 766
767``gobject-introspection.bbclass`` 767``gobject-introspection``
768================================= 768=========================
769 769
770Provides support for recipes building software that supports GObject 770Provides support for recipes building software that supports GObject
771introspection. This functionality is only enabled if the 771introspection. This functionality is only enabled if the
@@ -782,8 +782,8 @@ introspection. This functionality is only enabled if the
782 782
783.. _ref-classes-grub-efi: 783.. _ref-classes-grub-efi:
784 784
785``grub-efi.bbclass`` 785``grub-efi``
786==================== 786============
787 787
788The :ref:`grub-efi <ref-classes-grub-efi>` class provides ``grub-efi``-specific functions for 788The :ref:`grub-efi <ref-classes-grub-efi>` class provides ``grub-efi``-specific functions for
789building bootable images. 789building bootable images.
@@ -814,8 +814,8 @@ This class supports several variables:
814 814
815.. _ref-classes-gsettings: 815.. _ref-classes-gsettings:
816 816
817``gsettings.bbclass`` 817``gsettings``
818===================== 818=============
819 819
820The :ref:`gsettings <ref-classes-gsettings>` class provides common functionality for recipes that 820The :ref:`gsettings <ref-classes-gsettings>` class provides common functionality for recipes that
821need to install GSettings (glib) schemas. The schemas are assumed to be 821need to install GSettings (glib) schemas. The schemas are assumed to be
@@ -825,16 +825,16 @@ schemas in the target image.
825 825
826.. _ref-classes-gtk-doc: 826.. _ref-classes-gtk-doc:
827 827
828``gtk-doc.bbclass`` 828``gtk-doc``
829=================== 829===========
830 830
831The :ref:`gtk-doc <ref-classes-gtk-doc>` class is a helper class to pull in the appropriate 831The :ref:`gtk-doc <ref-classes-gtk-doc>` class is a helper class to pull in the appropriate
832``gtk-doc`` dependencies and disable ``gtk-doc``. 832``gtk-doc`` dependencies and disable ``gtk-doc``.
833 833
834.. _ref-classes-gtk-icon-cache: 834.. _ref-classes-gtk-icon-cache:
835 835
836``gtk-icon-cache.bbclass`` 836``gtk-icon-cache``
837========================== 837==================
838 838
839The :ref:`gtk-icon-cache <ref-classes-gtk-icon-cache>` class generates the proper post-install and 839The :ref:`gtk-icon-cache <ref-classes-gtk-icon-cache>` class generates the proper post-install and
840post-remove (postinst/postrm) scriptlets for packages that use GTK+ and 840post-remove (postinst/postrm) scriptlets for packages that use GTK+ and
@@ -846,8 +846,8 @@ creation.
846 846
847.. _ref-classes-gtk-immodules-cache: 847.. _ref-classes-gtk-immodules-cache:
848 848
849``gtk-immodules-cache.bbclass`` 849``gtk-immodules-cache``
850=============================== 850=======================
851 851
852The :ref:`gtk-immodules-cache <ref-classes-gtk-immodules-cache>` class generates the proper post-install and 852The :ref:`gtk-immodules-cache <ref-classes-gtk-immodules-cache>` class generates the proper post-install and
853post-remove (postinst/postrm) scriptlets for packages that install GTK+ 853post-remove (postinst/postrm) scriptlets for packages that install GTK+
@@ -864,8 +864,8 @@ the packages containing the modules.
864 864
865.. _ref-classes-gzipnative: 865.. _ref-classes-gzipnative:
866 866
867``gzipnative.bbclass`` 867``gzipnative``
868====================== 868==============
869 869
870The :ref:`gzipnative <ref-classes-gzipnative>` class enables the use of different native versions of 870The :ref:`gzipnative <ref-classes-gzipnative>` class enables the use of different native versions of
871``gzip`` and ``pigz`` rather than the versions of these tools from the 871``gzip`` and ``pigz`` rather than the versions of these tools from the
@@ -873,8 +873,8 @@ build host.
873 873
874.. _ref-classes-icecc: 874.. _ref-classes-icecc:
875 875
876``icecc.bbclass`` 876``icecc``
877================= 877=========
878 878
879The :ref:`icecc <ref-classes-icecc>` class supports 879The :ref:`icecc <ref-classes-icecc>` class supports
880`Icecream <https://github.com/icecc/icecream>`__, which facilitates 880`Icecream <https://github.com/icecc/icecream>`__, which facilitates
@@ -947,8 +947,8 @@ individually as follows in your ``local.conf`` file::
947 947
948.. _ref-classes-image: 948.. _ref-classes-image:
949 949
950``image.bbclass`` 950``image``
951================= 951=========
952 952
953The :ref:`image <ref-classes-image>` class helps support creating images in different formats. 953The :ref:`image <ref-classes-image>` class helps support creating images in different formats.
954First, the root filesystem is created from packages using one of the 954First, the root filesystem is created from packages using one of the
@@ -970,8 +970,8 @@ Yocto Project Overview and Concepts Manual.
970 970
971.. _ref-classes-image-buildinfo: 971.. _ref-classes-image-buildinfo:
972 972
973``image-buildinfo.bbclass`` 973``image-buildinfo``
974=========================== 974===================
975 975
976The :ref:`image-buildinfo <ref-classes-image-buildinfo>` class writes a plain text file containing 976The :ref:`image-buildinfo <ref-classes-image-buildinfo>` class writes a plain text file containing
977build information to the target filesystem at ``${sysconfdir}/buildinfo`` 977build information to the target filesystem at ``${sysconfdir}/buildinfo``
@@ -992,8 +992,8 @@ to ``/buildinfo`` by default (as specified by
992 992
993.. _ref-classes-image_types: 993.. _ref-classes-image_types:
994 994
995``image_types.bbclass`` 995``image_types``
996======================= 996===============
997 997
998The :ref:`image_types <ref-classes-image_types>` class defines all of the standard image output types 998The :ref:`image_types <ref-classes-image_types>` class defines all of the standard image output types
999that you can enable through the 999that you can enable through the
@@ -1024,8 +1024,8 @@ The :ref:`image_types <ref-classes-image_types>` class also handles conversion a
1024 1024
1025.. _ref-classes-image-live: 1025.. _ref-classes-image-live:
1026 1026
1027``image-live.bbclass`` 1027``image-live``
1028====================== 1028==============
1029 1029
1030This class controls building "live" (i.e. HDDIMG and ISO) images. Live 1030This class controls building "live" (i.e. HDDIMG and ISO) images. Live
1031images contain syslinux for legacy booting, as well as the bootloader 1031images 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
1037 1037
1038.. _ref-classes-insane: 1038.. _ref-classes-insane:
1039 1039
1040``insane.bbclass`` 1040``insane``
1041================== 1041==========
1042 1042
1043The :ref:`insane <ref-classes-insane>` class adds a step to the package generation process so 1043The :ref:`insane <ref-classes-insane>` class adds a step to the package generation process so
1044that output quality assurance checks are generated by the OpenEmbedded 1044that 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
1337 1337
1338.. _ref-classes-insserv: 1338.. _ref-classes-insserv:
1339 1339
1340``insserv.bbclass`` 1340``insserv``
1341=================== 1341===========
1342 1342
1343The :ref:`insserv <ref-classes-insserv>` class uses the ``insserv`` utility to update the order 1343The :ref:`insserv <ref-classes-insserv>` class uses the ``insserv`` utility to update the order
1344of symbolic links in ``/etc/rc?.d/`` within an image based on 1344of symbolic links in ``/etc/rc?.d/`` within an image based on
@@ -1347,8 +1347,8 @@ themselves.
1347 1347
1348.. _ref-classes-kernel: 1348.. _ref-classes-kernel:
1349 1349
1350``kernel.bbclass`` 1350``kernel``
1351================== 1351==========
1352 1352
1353The :ref:`kernel <ref-classes-kernel>` class handles building Linux kernels. The class contains 1353The :ref:`kernel <ref-classes-kernel>` class handles building Linux kernels. The class contains
1354code to build all kernel trees. All needed headers are staged into the 1354code 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>`,
1374 1374
1375.. _ref-classes-kernel-arch: 1375.. _ref-classes-kernel-arch:
1376 1376
1377``kernel-arch.bbclass`` 1377``kernel-arch``
1378======================= 1378===============
1379 1379
1380The :ref:`kernel-arch <ref-classes-kernel-arch>` class sets the ``ARCH`` environment variable for 1380The :ref:`kernel-arch <ref-classes-kernel-arch>` class sets the ``ARCH`` environment variable for
1381Linux kernel compilation (including modules). 1381Linux kernel compilation (including modules).
1382 1382
1383.. _ref-classes-kernel-devicetree: 1383.. _ref-classes-kernel-devicetree:
1384 1384
1385``kernel-devicetree.bbclass`` 1385``kernel-devicetree``
1386============================= 1386=====================
1387 1387
1388The :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class, which is inherited by the 1388The :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class, which is inherited by the
1389:ref:`kernel <ref-classes-kernel>` class, supports device tree 1389:ref:`kernel <ref-classes-kernel>` class, supports device tree
@@ -1391,8 +1391,8 @@ generation.
1391 1391
1392.. _ref-classes-kernel-fitimage: 1392.. _ref-classes-kernel-fitimage:
1393 1393
1394``kernel-fitimage.bbclass`` 1394``kernel-fitimage``
1395=========================== 1395===================
1396 1396
1397The :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class provides support to pack a kernel image, 1397The :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class provides support to pack a kernel image,
1398device trees, a U-boot script, a :term:`Initramfs` bundle and a RAM disk 1398device 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:`
1462 1462
1463.. _ref-classes-kernel-grub: 1463.. _ref-classes-kernel-grub:
1464 1464
1465``kernel-grub.bbclass`` 1465``kernel-grub``
1466======================= 1466===============
1467 1467
1468The :ref:`kernel-grub <ref-classes-kernel-grub>` class updates the boot area and the boot menu with 1468The :ref:`kernel-grub <ref-classes-kernel-grub>` class updates the boot area and the boot menu with
1469the kernel as the priority boot mechanism while installing a RPM to 1469the kernel as the priority boot mechanism while installing a RPM to
@@ -1471,46 +1471,46 @@ update the kernel on a deployed target.
1471 1471
1472.. _ref-classes-kernel-module-split: 1472.. _ref-classes-kernel-module-split:
1473 1473
1474``kernel-module-split.bbclass`` 1474``kernel-module-split``
1475=============================== 1475=======================
1476 1476
1477The :ref:`kernel-module-split <ref-classes-kernel-module-split>` class provides common functionality for 1477The :ref:`kernel-module-split <ref-classes-kernel-module-split>` class provides common functionality for
1478splitting Linux kernel modules into separate packages. 1478splitting Linux kernel modules into separate packages.
1479 1479
1480.. _ref-classes-kernel-uboot: 1480.. _ref-classes-kernel-uboot:
1481 1481
1482``kernel-uboot.bbclass`` 1482``kernel-uboot``
1483======================== 1483================
1484 1484
1485The :ref:`kernel-uboot <ref-classes-kernel-uboot>` class provides support for building from 1485The :ref:`kernel-uboot <ref-classes-kernel-uboot>` class provides support for building from
1486vmlinux-style kernel sources. 1486vmlinux-style kernel sources.
1487 1487
1488.. _ref-classes-kernel-uimage: 1488.. _ref-classes-kernel-uimage:
1489 1489
1490``kernel-uimage.bbclass`` 1490``kernel-uimage``
1491========================= 1491=================
1492 1492
1493The :ref:`kernel-uimage <ref-classes-kernel-uimage>` class provides support to pack uImage. 1493The :ref:`kernel-uimage <ref-classes-kernel-uimage>` class provides support to pack uImage.
1494 1494
1495.. _ref-classes-kernel-yocto: 1495.. _ref-classes-kernel-yocto:
1496 1496
1497``kernel-yocto.bbclass`` 1497``kernel-yocto``
1498======================== 1498================
1499 1499
1500The :ref:`kernel-yocto <ref-classes-kernel-yocto>` class provides common functionality for building 1500The :ref:`kernel-yocto <ref-classes-kernel-yocto>` class provides common functionality for building
1501from linux-yocto style kernel source repositories. 1501from linux-yocto style kernel source repositories.
1502 1502
1503.. _ref-classes-kernelsrc: 1503.. _ref-classes-kernelsrc:
1504 1504
1505``kernelsrc.bbclass`` 1505``kernelsrc``
1506===================== 1506=============
1507 1507
1508The :ref:`kernelsrc <ref-classes-kernelsrc>` class sets the Linux kernel source and version. 1508The :ref:`kernelsrc <ref-classes-kernelsrc>` class sets the Linux kernel source and version.
1509 1509
1510.. _ref-classes-lib_package: 1510.. _ref-classes-lib_package:
1511 1511
1512``lib_package.bbclass`` 1512``lib_package``
1513======================= 1513===============
1514 1514
1515The :ref:`lib_package <ref-classes-lib_package>` class supports recipes that build libraries and 1515The :ref:`lib_package <ref-classes-lib_package>` class supports recipes that build libraries and
1516produce executable binaries, where those binaries should not be 1516produce executable binaries, where those binaries should not be
@@ -1520,8 +1520,8 @@ make their installation optional.
1520 1520
1521.. _ref-classes-libc*: 1521.. _ref-classes-libc*:
1522 1522
1523``libc*.bbclass`` 1523``libc*``
1524================= 1524=========
1525 1525
1526The :ref:`libc* <ref-classes-libc*>` classes support recipes that build packages with ``libc``: 1526The :ref:`libc* <ref-classes-libc*>` classes support recipes that build packages with ``libc``:
1527 1527
@@ -1533,8 +1533,8 @@ The :ref:`libc* <ref-classes-libc*>` classes support recipes that build packages
1533 1533
1534.. _ref-classes-license: 1534.. _ref-classes-license:
1535 1535
1536``license.bbclass`` 1536``license``
1537=================== 1537===========
1538 1538
1539The :ref:`license <ref-classes-license>` class provides license manifest creation and license 1539The :ref:`license <ref-classes-license>` class provides license manifest creation and license
1540exclusion. This class is enabled by default using the default value for 1540exclusion. This class is enabled by default using the default value for
@@ -1542,8 +1542,8 @@ the :term:`INHERIT_DISTRO` variable.
1542 1542
1543.. _ref-classes-linux-kernel-base: 1543.. _ref-classes-linux-kernel-base:
1544 1544
1545``linux-kernel-base.bbclass`` 1545``linux-kernel-base``
1546============================= 1546=====================
1547 1547
1548The :ref:`linux-kernel-base <ref-classes-linux-kernel-base>` class provides common functionality for 1548The :ref:`linux-kernel-base <ref-classes-linux-kernel-base>` class provides common functionality for
1549recipes that build out of the Linux kernel source tree. These builds 1549recipes that build out of the Linux kernel source tree. These builds
@@ -1552,8 +1552,8 @@ inherits this class.
1552 1552
1553.. _ref-classes-linuxloader: 1553.. _ref-classes-linuxloader:
1554 1554
1555``linuxloader.bbclass`` 1555``linuxloader``
1556======================= 1556===============
1557 1557
1558Provides the function ``linuxloader()``, which gives the value of the 1558Provides the function ``linuxloader()``, which gives the value of the
1559dynamic loader/linker provided on the platform. This value is used by a 1559dynamic loader/linker provided on the platform. This value is used by a
@@ -1561,8 +1561,8 @@ number of other classes.
1561 1561
1562.. _ref-classes-logging: 1562.. _ref-classes-logging:
1563 1563
1564``logging.bbclass`` 1564``logging``
1565=================== 1565===========
1566 1566
1567The :ref:`logging <ref-classes-logging>` class provides the standard shell functions used to log 1567The :ref:`logging <ref-classes-logging>` class provides the standard shell functions used to log
1568messages for various BitBake severity levels (i.e. ``bbplain``, 1568messages for various BitBake severity levels (i.e. ``bbplain``,
@@ -1573,8 +1573,8 @@ class.
1573 1573
1574.. _ref-classes-metadata_scm: 1574.. _ref-classes-metadata_scm:
1575 1575
1576``metadata_scm.bbclass`` 1576``metadata_scm``
1577======================== 1577================
1578 1578
1579The :ref:`metadata_scm <ref-classes-metadata_scm>` class provides functionality for querying the 1579The :ref:`metadata_scm <ref-classes-metadata_scm>` class provides functionality for querying the
1580branch and revision of a Source Code Manager (SCM) repository. 1580branch and revision of a Source Code Manager (SCM) repository.
@@ -1586,16 +1586,16 @@ the :ref:`base <ref-classes-base>` class.
1586 1586
1587.. _ref-classes-migrate_localcount: 1587.. _ref-classes-migrate_localcount:
1588 1588
1589``migrate_localcount.bbclass`` 1589``migrate_localcount``
1590============================== 1590======================
1591 1591
1592The :ref:`migrate_localcount <ref-classes-migrate_localcount>` class verifies a recipe's localcount data and 1592The :ref:`migrate_localcount <ref-classes-migrate_localcount>` class verifies a recipe's localcount data and
1593increments it appropriately. 1593increments it appropriately.
1594 1594
1595.. _ref-classes-mime: 1595.. _ref-classes-mime:
1596 1596
1597``mime.bbclass`` 1597``mime``
1598================ 1598========
1599 1599
1600The :ref:`mime <ref-classes-mime>` class generates the proper post-install and post-remove 1600The :ref:`mime <ref-classes-mime>` class generates the proper post-install and post-remove
1601(postinst/postrm) scriptlets for packages that install MIME type files. 1601(postinst/postrm) scriptlets for packages that install MIME type files.
@@ -1604,8 +1604,8 @@ the shared database.
1604 1604
1605.. _ref-classes-mime-xdg: 1605.. _ref-classes-mime-xdg:
1606 1606
1607``mime-xdg.bbclass`` 1607``mime-xdg``
1608==================== 1608============
1609 1609
1610The :ref:`mime-xdg <ref-classes-mime-xdg>` class generates the proper 1610The :ref:`mime-xdg <ref-classes-mime-xdg>` class generates the proper
1611post-install and post-remove (postinst/postrm) scriptlets for packages 1611post-install and post-remove (postinst/postrm) scriptlets for packages
@@ -1625,8 +1625,8 @@ package names to the :term:`MIME_XDG_PACKAGES` variable.
1625 1625
1626.. _ref-classes-mirrors: 1626.. _ref-classes-mirrors:
1627 1627
1628``mirrors.bbclass`` 1628``mirrors``
1629=================== 1629===========
1630 1630
1631The :ref:`mirrors <ref-classes-mirrors>` class sets up some standard 1631The :ref:`mirrors <ref-classes-mirrors>` class sets up some standard
1632:term:`MIRRORS` entries for source code mirrors. These 1632:term:`MIRRORS` entries for source code mirrors. These
@@ -1638,8 +1638,8 @@ This class is enabled by default since it is inherited by the
1638 1638
1639.. _ref-classes-module: 1639.. _ref-classes-module:
1640 1640
1641``module.bbclass`` 1641``module``
1642================== 1642==========
1643 1643
1644The :ref:`module <ref-classes-module>` class provides support for building out-of-tree Linux 1644The :ref:`module <ref-classes-module>` class provides support for building out-of-tree Linux
1645kernel modules. The class inherits the 1645kernel modules. The class inherits the
@@ -1655,8 +1655,8 @@ section in the Yocto Project Linux Kernel Development Manual.
1655 1655
1656.. _ref-classes-module-base: 1656.. _ref-classes-module-base:
1657 1657
1658``module-base.bbclass`` 1658``module-base``
1659======================= 1659===============
1660 1660
1661The :ref:`module-base <ref-classes-module-base>` class provides the base functionality for building 1661The :ref:`module-base <ref-classes-module-base>` class provides the base functionality for building
1662Linux kernel modules. Typically, a recipe that builds software that 1662Linux kernel modules. Typically, a recipe that builds software that
@@ -1666,8 +1666,8 @@ the module inherits this class as opposed to inheriting the
1666 1666
1667.. _ref-classes-multilib*: 1667.. _ref-classes-multilib*:
1668 1668
1669``multilib*.bbclass`` 1669``multilib*``
1670===================== 1670=============
1671 1671
1672The :ref:`multilib* <ref-classes-multilib*>` classes provide support for building libraries with 1672The :ref:`multilib* <ref-classes-multilib*>` classes provide support for building libraries with
1673different target optimizations or target architectures and installing 1673different target optimizations or target architectures and installing
@@ -1679,8 +1679,8 @@ section in the Yocto Project Development Tasks Manual.
1679 1679
1680.. _ref-classes-native: 1680.. _ref-classes-native:
1681 1681
1682``native.bbclass`` 1682``native``
1683================== 1683==========
1684 1684
1685The :ref:`native <ref-classes-native>` class provides common functionality for recipes that 1685The :ref:`native <ref-classes-native>` class provides common functionality for recipes that
1686build tools to run on the :term:`Build Host` (i.e. tools that use the compiler 1686build 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.
1721 1721
1722.. _ref-classes-nativesdk: 1722.. _ref-classes-nativesdk:
1723 1723
1724``nativesdk.bbclass`` 1724``nativesdk``
1725===================== 1725=============
1726 1726
1727The :ref:`nativesdk <ref-classes-nativesdk>` class provides common functionality for recipes that 1727The :ref:`nativesdk <ref-classes-nativesdk>` class provides common functionality for recipes that
1728wish to build tools to run as part of an SDK (i.e. tools that run on 1728wish 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.
1762 1762
1763.. _ref-classes-nopackages: 1763.. _ref-classes-nopackages:
1764 1764
1765``nopackages.bbclass`` 1765``nopackages``
1766====================== 1766==============
1767 1767
1768Disables packaging tasks for those recipes and classes where packaging 1768Disables packaging tasks for those recipes and classes where packaging
1769is not needed. 1769is not needed.
1770 1770
1771.. _ref-classes-npm: 1771.. _ref-classes-npm:
1772 1772
1773``npm.bbclass`` 1773``npm``
1774=============== 1774=======
1775 1775
1776Provides support for building Node.js software fetched using the 1776Provides support for building Node.js software fetched using the
1777:wikipedia:`node package manager (NPM) <Npm_(software)>`. 1777:wikipedia:`node package manager (NPM) <Npm_(software)>`.
@@ -1787,8 +1787,8 @@ section in the Yocto Project Development Tasks Manual.
1787 1787
1788.. _ref-classes-oelint: 1788.. _ref-classes-oelint:
1789 1789
1790``oelint.bbclass`` 1790``oelint``
1791================== 1791==========
1792 1792
1793The :ref:`oelint <ref-classes-oelint>` class is an obsolete lint checking tool available in 1793The :ref:`oelint <ref-classes-oelint>` class is an obsolete lint checking tool available in
1794``meta/classes`` in the :term:`Source Directory`. 1794``meta/classes`` in the :term:`Source Directory`.
@@ -1801,8 +1801,8 @@ layers.
1801 1801
1802.. _ref-classes-overlayfs: 1802.. _ref-classes-overlayfs:
1803 1803
1804``overlayfs.bbclass`` 1804``overlayfs``
1805======================= 1805=============
1806 1806
1807It's often desired in Embedded System design to have a read-only root filesystem. 1807It's often desired in Embedded System design to have a read-only root filesystem.
1808But a lot of different applications might want to have read-write access to 1808But a lot of different applications might want to have read-write access to
@@ -1865,8 +1865,8 @@ to the unit the following::
1865 1865
1866.. _ref-classes-overlayfs-etc: 1866.. _ref-classes-overlayfs-etc:
1867 1867
1868``overlayfs-etc.bbclass`` 1868``overlayfs-etc``
1869========================= 1869=================
1870 1870
1871In order to have the ``/etc`` directory in overlayfs a special handling at early 1871In order to have the ``/etc`` directory in overlayfs a special handling at early
1872boot stage is required. The idea is to supply a custom init script that mounts 1872boot 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:
1910 1910
1911.. _ref-classes-own-mirrors: 1911.. _ref-classes-own-mirrors:
1912 1912
1913``own-mirrors.bbclass`` 1913``own-mirrors``
1914======================= 1914===============
1915 1915
1916The :ref:`own-mirrors <ref-classes-own-mirrors>` class makes it easier to set up your own 1916The :ref:`own-mirrors <ref-classes-own-mirrors>` class makes it easier to set up your own
1917:term:`PREMIRRORS` from which to first fetch source 1917:term:`PREMIRRORS` from which to first fetch source
@@ -1929,8 +1929,8 @@ in :term:`SOURCE_MIRROR_URL`.
1929 1929
1930.. _ref-classes-package: 1930.. _ref-classes-package:
1931 1931
1932``package.bbclass`` 1932``package``
1933=================== 1933===========
1934 1934
1935The :ref:`package <ref-classes-package>` class supports generating packages from a build's 1935The :ref:`package <ref-classes-package>` class supports generating packages from a build's
1936output. The core generic functionality is in ``package.bbclass``. The 1936output. The core generic functionality is in ``package.bbclass``. The
@@ -1994,8 +1994,8 @@ at these two Yocto Project mailing list links:
1994 1994
1995.. _ref-classes-package_deb: 1995.. _ref-classes-package_deb:
1996 1996
1997``package_deb.bbclass`` 1997``package_deb``
1998======================= 1998===============
1999 1999
2000The :ref:`package_deb <ref-classes-package_deb>` class provides support for creating packages that 2000The :ref:`package_deb <ref-classes-package_deb>` class provides support for creating packages that
2001use the Debian (i.e. ``.deb``) file format. The class ensures the 2001use the Debian (i.e. ``.deb``) file format. The class ensures the
@@ -2008,8 +2008,8 @@ variable in the ``local.conf`` file.
2008 2008
2009.. _ref-classes-package_ipk: 2009.. _ref-classes-package_ipk:
2010 2010
2011``package_ipk.bbclass`` 2011``package_ipk``
2012======================= 2012===============
2013 2013
2014The :ref:`package_ipk <ref-classes-package_ipk>` class provides support for creating packages that 2014The :ref:`package_ipk <ref-classes-package_ipk>` class provides support for creating packages that
2015use the IPK (i.e. ``.ipk``) file format. The class ensures the packages 2015use the IPK (i.e. ``.ipk``) file format. The class ensures the packages
@@ -2022,8 +2022,8 @@ variable in the ``local.conf`` file.
2022 2022
2023.. _ref-classes-package_rpm: 2023.. _ref-classes-package_rpm:
2024 2024
2025``package_rpm.bbclass`` 2025``package_rpm``
2026======================= 2026===============
2027 2027
2028The :ref:`package_rpm <ref-classes-package_rpm>` class provides support for creating packages that 2028The :ref:`package_rpm <ref-classes-package_rpm>` class provides support for creating packages that
2029use the RPM (i.e. ``.rpm``) file format. The class ensures the packages 2029use the RPM (i.e. ``.rpm``) file format. The class ensures the packages
@@ -2036,8 +2036,8 @@ variable in the ``local.conf`` file.
2036 2036
2037.. _ref-classes-package_tar: 2037.. _ref-classes-package_tar:
2038 2038
2039``package_tar.bbclass`` 2039``package_tar``
2040======================= 2040===============
2041 2041
2042The :ref:`package_tar <ref-classes-package_tar>` class provides support for creating tarballs. The 2042The :ref:`package_tar <ref-classes-package_tar>` class provides support for creating tarballs. The
2043class ensures the packages are written out in a tarball format to the 2043class ensures the packages are written out in a tarball format to the
@@ -2055,8 +2055,8 @@ variable in the ``local.conf`` file.
2055 2055
2056.. _ref-classes-packagedata: 2056.. _ref-classes-packagedata:
2057 2057
2058``packagedata.bbclass`` 2058``packagedata``
2059======================= 2059===============
2060 2060
2061The :ref:`packagedata <ref-classes-packagedata>` class provides common functionality for reading 2061The :ref:`packagedata <ref-classes-packagedata>` class provides common functionality for reading
2062``pkgdata`` files found in :term:`PKGDATA_DIR`. These 2062``pkgdata`` files found in :term:`PKGDATA_DIR`. These
@@ -2068,8 +2068,8 @@ This class is enabled by default because it is inherited by the
2068 2068
2069.. _ref-classes-packagegroup: 2069.. _ref-classes-packagegroup:
2070 2070
2071``packagegroup.bbclass`` 2071``packagegroup``
2072======================== 2072================
2073 2073
2074The :ref:`packagegroup <ref-classes-packagegroup>` class sets default values appropriate for package 2074The :ref:`packagegroup <ref-classes-packagegroup>` class sets default values appropriate for package
2075group recipes (e.g. :term:`PACKAGES`, :term:`PACKAGE_ARCH`, :term:`ALLOW_EMPTY`, and 2075group recipes (e.g. :term:`PACKAGES`, :term:`PACKAGE_ARCH`, :term:`ALLOW_EMPTY`, and
@@ -2084,8 +2084,8 @@ Previously, this class was called the ``task`` class.
2084 2084
2085.. _ref-classes-patch: 2085.. _ref-classes-patch:
2086 2086
2087``patch.bbclass`` 2087``patch``
2088================= 2088=========
2089 2089
2090The :ref:`patch <ref-classes-patch>` class provides all functionality for applying patches 2090The :ref:`patch <ref-classes-patch>` class provides all functionality for applying patches
2091during the :ref:`ref-tasks-patch` task. 2091during the :ref:`ref-tasks-patch` task.
@@ -2095,8 +2095,8 @@ This class is enabled by default because it is inherited by the
2095 2095
2096.. _ref-classes-perlnative: 2096.. _ref-classes-perlnative:
2097 2097
2098``perlnative.bbclass`` 2098``perlnative``
2099====================== 2099==============
2100 2100
2101When inherited by a recipe, the :ref:`perlnative <ref-classes-perlnative>` class supports using the 2101When inherited by a recipe, the :ref:`perlnative <ref-classes-perlnative>` class supports using the
2102native version of Perl built by the build system rather than using the 2102native version of Perl built by the build system rather than using the
@@ -2104,8 +2104,8 @@ version provided by the build host.
2104 2104
2105.. _ref-classes-pypi: 2105.. _ref-classes-pypi:
2106 2106
2107``pypi.bbclass`` 2107``pypi``
2108================ 2108========
2109 2109
2110The :ref:`pypi <ref-classes-pypi>` class sets variables appropriately for recipes that build 2110The :ref:`pypi <ref-classes-pypi>` class sets variables appropriately for recipes that build
2111Python modules from `PyPI <https://pypi.org/>`__, the Python Package Index. 2111Python modules from `PyPI <https://pypi.org/>`__, the Python Package Index.
@@ -2120,8 +2120,8 @@ and :term:`CVE_PRODUCT`.
2120 2120
2121.. _ref-classes-python_flit_core: 2121.. _ref-classes-python_flit_core:
2122 2122
2123``python_flit_core.bbclass`` 2123``python_flit_core``
2124============================ 2124====================
2125 2125
2126The :ref:`python_flit_core <ref-classes-python_flit_core>` class enables building Python modules which declare 2126The :ref:`python_flit_core <ref-classes-python_flit_core>` class enables building Python modules which declare
2127the `PEP-517 <https://www.python.org/dev/peps/pep-0517/>`__ compliant 2127the `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.
2135 2135
2136.. _ref-classes-python_pep517: 2136.. _ref-classes-python_pep517:
2137 2137
2138``python_pep517.bbclass`` 2138``python_pep517``
2139========================= 2139=================
2140 2140
2141The :ref:`python_pep517 <ref-classes-python_pep517>` class builds and installs a Python ``wheel`` binary 2141The :ref:`python_pep517 <ref-classes-python_pep517>` class builds and installs a Python ``wheel`` binary
2142archive (see `PEP-517 <https://peps.python.org/pep-0517/>`__). 2142archive (see `PEP-517 <https://peps.python.org/pep-0517/>`__).
@@ -2151,8 +2151,8 @@ Examples of classes which do this are :ref:`python_flit_core
2151 2151
2152.. _ref-classes-python_poetry_core: 2152.. _ref-classes-python_poetry_core:
2153 2153
2154``python_poetry_core.bbclass`` 2154``python_poetry_core``
2155============================== 2155======================
2156 2156
2157The :ref:`python_poetry_core <ref-classes-python_poetry_core>` class enables building Python modules which use the 2157The :ref:`python_poetry_core <ref-classes-python_poetry_core>` class enables building Python modules which use the
2158`Poetry Core <https://python-poetry.org>`__ build system. 2158`Poetry Core <https://python-poetry.org>`__ build system.
@@ -2161,8 +2161,8 @@ Internally this uses the :ref:`python_pep517 <ref-classes-python_pep517>` class.
2161 2161
2162.. _ref-classes-pixbufcache: 2162.. _ref-classes-pixbufcache:
2163 2163
2164``pixbufcache.bbclass`` 2164``pixbufcache``
2165======================= 2165===============
2166 2166
2167The :ref:`pixbufcache <ref-classes-pixbufcache>` class generates the proper post-install and 2167The :ref:`pixbufcache <ref-classes-pixbufcache>` class generates the proper post-install and
2168post-remove (postinst/postrm) scriptlets for packages that install 2168post-remove (postinst/postrm) scriptlets for packages that install
@@ -2179,8 +2179,8 @@ containing the loaders.
2179 2179
2180.. _ref-classes-pkgconfig: 2180.. _ref-classes-pkgconfig:
2181 2181
2182``pkgconfig.bbclass`` 2182``pkgconfig``
2183===================== 2183=============
2184 2184
2185The :ref:`pkgconfig <ref-classes-pkgconfig>` class provides a standard way to get header and 2185The :ref:`pkgconfig <ref-classes-pkgconfig>` class provides a standard way to get header and
2186library information by using ``pkg-config``. This class aims to smooth 2186library information by using ``pkg-config``. This class aims to smooth
@@ -2193,8 +2193,8 @@ files.
2193 2193
2194.. _ref-classes-populate-sdk: 2194.. _ref-classes-populate-sdk:
2195 2195
2196``populate_sdk.bbclass`` 2196``populate_sdk``
2197======================== 2197================
2198 2198
2199The :ref:`populate_sdk <ref-classes-populate-sdk>` class provides support for SDK-only recipes. For 2199The :ref:`populate_sdk <ref-classes-populate-sdk>` class provides support for SDK-only recipes. For
2200information on advantages gained when building a cross-development 2200information on advantages gained when building a cross-development
@@ -2205,8 +2205,8 @@ Software Development Kit (eSDK) manual.
2205 2205
2206.. _ref-classes-populate-sdk-*: 2206.. _ref-classes-populate-sdk-*:
2207 2207
2208``populate_sdk_*.bbclass`` 2208``populate_sdk_*``
2209========================== 2209==================
2210 2210
2211The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` classes support SDK creation and consist of the 2211The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` classes support SDK creation and consist of the
2212following classes: 2212following classes:
@@ -2262,8 +2262,8 @@ Software Development Kit (eSDK) manual.
2262 2262
2263.. _ref-classes-prexport: 2263.. _ref-classes-prexport:
2264 2264
2265``prexport.bbclass`` 2265``prexport``
2266==================== 2266============
2267 2267
2268The :ref:`prexport <ref-classes-prexport>` class provides functionality for exporting 2268The :ref:`prexport <ref-classes-prexport>` class provides functionality for exporting
2269:term:`PR` values. 2269:term:`PR` values.
@@ -2275,8 +2275,8 @@ The :ref:`prexport <ref-classes-prexport>` class provides functionality for expo
2275 2275
2276.. _ref-classes-primport: 2276.. _ref-classes-primport:
2277 2277
2278``primport.bbclass`` 2278``primport``
2279==================== 2279============
2280 2280
2281The :ref:`primport <ref-classes-primport>` class provides functionality for importing 2281The :ref:`primport <ref-classes-primport>` class provides functionality for importing
2282:term:`PR` values. 2282:term:`PR` values.
@@ -2288,8 +2288,8 @@ The :ref:`primport <ref-classes-primport>` class provides functionality for impo
2288 2288
2289.. _ref-classes-prserv: 2289.. _ref-classes-prserv:
2290 2290
2291``prserv.bbclass`` 2291``prserv``
2292================== 2292==========
2293 2293
2294The :ref:`prserv <ref-classes-prserv>` class provides functionality for using a :ref:`PR 2294The :ref:`prserv <ref-classes-prserv>` class provides functionality for using a :ref:`PR
2295service <dev-manual/packages:working with a pr service>` in order to 2295service <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
2303 2303
2304.. _ref-classes-ptest: 2304.. _ref-classes-ptest:
2305 2305
2306``ptest.bbclass`` 2306``ptest``
2307================= 2307=========
2308 2308
2309The :ref:`ptest <ref-classes-ptest>` class provides functionality for packaging and installing 2309The :ref:`ptest <ref-classes-ptest>` class provides functionality for packaging and installing
2310runtime tests for recipes that build software that provides these tests. 2310runtime tests for recipes that build software that provides these tests.
@@ -2318,8 +2318,8 @@ on ptest.
2318 2318
2319.. _ref-classes-ptest-gnome: 2319.. _ref-classes-ptest-gnome:
2320 2320
2321``ptest-gnome.bbclass`` 2321``ptest-gnome``
2322======================= 2322===============
2323 2323
2324Enables package tests (ptests) specifically for GNOME packages, which 2324Enables package tests (ptests) specifically for GNOME packages, which
2325have tests intended to be executed with ``gnome-desktop-testing``. 2325have tests intended to be executed with ``gnome-desktop-testing``.
@@ -2330,16 +2330,16 @@ section in the Yocto Project Development Tasks Manual.
2330 2330
2331.. _ref-classes-python3-dir: 2331.. _ref-classes-python3-dir:
2332 2332
2333``python3-dir.bbclass`` 2333``python3-dir``
2334======================= 2334===============
2335 2335
2336The :ref:`python3-dir <ref-classes-python3-dir>` class provides the base version, location, and site 2336The :ref:`python3-dir <ref-classes-python3-dir>` class provides the base version, location, and site
2337package location for Python 3. 2337package location for Python 3.
2338 2338
2339.. _ref-classes-python3native: 2339.. _ref-classes-python3native:
2340 2340
2341``python3native.bbclass`` 2341``python3native``
2342========================= 2342=================
2343 2343
2344The :ref:`python3native <ref-classes-python3native>` class supports using the native version of Python 2344The :ref:`python3native <ref-classes-python3native>` class supports using the native version of Python
23453 built by the build system rather than support of the version provided 23453 built by the build system rather than support of the version provided
@@ -2347,8 +2347,8 @@ by the build host.
2347 2347
2348.. _ref-classes-python3targetconfig: 2348.. _ref-classes-python3targetconfig:
2349 2349
2350``python3targetconfig.bbclass`` 2350``python3targetconfig``
2351=============================== 2351=======================
2352 2352
2353The :ref:`python3targetconfig <ref-classes-python3targetconfig>` class supports using the native version of Python 2353The :ref:`python3targetconfig <ref-classes-python3targetconfig>` class supports using the native version of Python
23543 built by the build system rather than support of the version provided 23543 built by the build system rather than support of the version provided
@@ -2359,8 +2359,8 @@ in order to avoid unnecessarily lengthening builds.
2359 2359
2360.. _ref-classes-qemu: 2360.. _ref-classes-qemu:
2361 2361
2362``qemu.bbclass`` 2362``qemu``
2363================ 2363========
2364 2364
2365The :ref:`qemu <ref-classes-qemu>` class provides functionality for recipes that either need 2365The :ref:`qemu <ref-classes-qemu>` class provides functionality for recipes that either need
2366QEMU or test for the existence of QEMU. Typically, this class is used to 2366QEMU or test for the existence of QEMU. Typically, this class is used to
@@ -2369,8 +2369,8 @@ application emulation mode.
2369 2369
2370.. _ref-classes-recipe_sanity: 2370.. _ref-classes-recipe_sanity:
2371 2371
2372``recipe_sanity.bbclass`` 2372``recipe_sanity``
2373========================= 2373=================
2374 2374
2375The :ref:`recipe_sanity <ref-classes-recipe_sanity>` class checks for the presence of any host system 2375The :ref:`recipe_sanity <ref-classes-recipe_sanity>` class checks for the presence of any host system
2376recipe prerequisites that might affect the build (e.g. variables that 2376recipe prerequisites that might affect the build (e.g. variables that
@@ -2378,8 +2378,8 @@ are set or software that is present).
2378 2378
2379.. _ref-classes-relocatable: 2379.. _ref-classes-relocatable:
2380 2380
2381``relocatable.bbclass`` 2381``relocatable``
2382======================= 2382===============
2383 2383
2384The :ref:`relocatable <ref-classes-relocatable>` class enables relocation of binaries when they are 2384The :ref:`relocatable <ref-classes-relocatable>` class enables relocation of binaries when they are
2385installed into the sysroot. 2385installed into the sysroot.
@@ -2390,8 +2390,8 @@ and is used by both the :ref:`cross <ref-classes-cross>` and
2390 2390
2391.. _ref-classes-remove-libtool: 2391.. _ref-classes-remove-libtool:
2392 2392
2393``remove-libtool.bbclass`` 2393``remove-libtool``
2394========================== 2394==================
2395 2395
2396The :ref:`remove-libtool <ref-classes-remove-libtool>` class adds a post function to the 2396The :ref:`remove-libtool <ref-classes-remove-libtool>` class adds a post function to the
2397:ref:`ref-tasks-install` task to remove all ``.la`` files 2397: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::
2409 2409
2410.. _ref-classes-report-error: 2410.. _ref-classes-report-error:
2411 2411
2412``report-error.bbclass`` 2412``report-error``
2413======================== 2413================
2414 2414
2415The :ref:`report-error <ref-classes-report-error>` class supports enabling the :ref:`error reporting 2415The :ref:`report-error <ref-classes-report-error>` class supports enabling the :ref:`error reporting
2416tool <dev-manual/error-reporting-tool:using the error reporting tool>`", 2416tool <dev-manual/error-reporting-tool:using the error reporting tool>`",
@@ -2424,8 +2424,8 @@ are created and stored in
2424 2424
2425.. _ref-classes-rm-work: 2425.. _ref-classes-rm-work:
2426 2426
2427``rm_work.bbclass`` 2427``rm_work``
2428=================== 2428===========
2429 2429
2430The :ref:`rm_work <ref-classes-rm-work>` class supports deletion of temporary workspace, which 2430The :ref:`rm_work <ref-classes-rm-work>` class supports deletion of temporary workspace, which
2431can ease your hard drive demands during builds. 2431can ease your hard drive demands during builds.
@@ -2454,8 +2454,8 @@ can also be set in your ``local.conf`` file. Here is an example::
2454 2454
2455.. _ref-classes-rootfs*: 2455.. _ref-classes-rootfs*:
2456 2456
2457``rootfs*.bbclass`` 2457``rootfs*``
2458=================== 2458===========
2459 2459
2460The :ref:`rootfs* <ref-classes-rootfs*>` classes support creating the root filesystem for an 2460The :ref:`rootfs* <ref-classes-rootfs*>` classes support creating the root filesystem for an
2461image and consist of the following classes: 2461image and consist of the following classes:
@@ -2485,8 +2485,8 @@ section in the Yocto Project Overview and Concepts Manual.
2485 2485
2486.. _ref-classes-sanity: 2486.. _ref-classes-sanity:
2487 2487
2488``sanity.bbclass`` 2488``sanity``
2489================== 2489==========
2490 2490
2491The :ref:`sanity <ref-classes-sanity>` class checks to see if prerequisite software is present 2491The :ref:`sanity <ref-classes-sanity>` class checks to see if prerequisite software is present
2492on the host system so that users can be notified of potential problems 2492on the host system so that users can be notified of potential problems
@@ -2497,8 +2497,8 @@ usually determines whether to include this class.
2497 2497
2498.. _ref-classes-scons: 2498.. _ref-classes-scons:
2499 2499
2500``scons.bbclass`` 2500``scons``
2501================= 2501=========
2502 2502
2503The :ref:`scons <ref-classes-scons>` class supports recipes that need to build software that 2503The :ref:`scons <ref-classes-scons>` class supports recipes that need to build software that
2504uses the SCons build system. You can use the 2504uses the SCons build system. You can use the
@@ -2507,16 +2507,16 @@ additional configuration options you want to pass SCons command line.
2507 2507
2508.. _ref-classes-sdl: 2508.. _ref-classes-sdl:
2509 2509
2510``sdl.bbclass`` 2510``sdl``
2511=============== 2511=======
2512 2512
2513The :ref:`sdl <ref-classes-sdl>` class supports recipes that need to build software that uses 2513The :ref:`sdl <ref-classes-sdl>` class supports recipes that need to build software that uses
2514the Simple DirectMedia Layer (SDL) library. 2514the Simple DirectMedia Layer (SDL) library.
2515 2515
2516.. _ref-classes-python_setuptools_build_meta: 2516.. _ref-classes-python_setuptools_build_meta:
2517 2517
2518``python_setuptools_build_meta.bbclass`` 2518``python_setuptools_build_meta``
2519======================================== 2519================================
2520 2520
2521The :ref:`python_setuptools_build_meta <ref-classes-python_setuptools_build_meta>` class enables building Python modules which 2521The :ref:`python_setuptools_build_meta <ref-classes-python_setuptools_build_meta>` class enables building Python modules which
2522declare the 2522declare the
@@ -2531,8 +2531,8 @@ Internally this uses the :ref:`python_pep517 <ref-classes-python_pep517>` class.
2531 2531
2532.. _ref-classes-setuptools3: 2532.. _ref-classes-setuptools3:
2533 2533
2534``setuptools3.bbclass`` 2534``setuptools3``
2535======================= 2535===============
2536 2536
2537The :ref:`setuptools3 <ref-classes-setuptools3>` class supports Python version 3.x extensions that 2537The :ref:`setuptools3 <ref-classes-setuptools3>` class supports Python version 3.x extensions that
2538use build systems based on ``setuptools`` (e.g. only have a ``setup.py`` and 2538use 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
2561 2561
2562.. _ref-classes-setuptools3_legacy: 2562.. _ref-classes-setuptools3_legacy:
2563 2563
2564``setuptools3_legacy.bbclass`` 2564``setuptools3_legacy``
2565============================== 2565======================
2566 2566
2567The :ref:`setuptools3_legacy <ref-classes-setuptools3_legacy>` class supports 2567The :ref:`setuptools3_legacy <ref-classes-setuptools3_legacy>` class supports
2568Python version 3.x extensions that use build systems based on ``setuptools`` 2568Python version 3.x extensions that use build systems based on ``setuptools``
@@ -2575,8 +2575,8 @@ but still relatively common.
2575 2575
2576.. _ref-classes-setuptools3-base: 2576.. _ref-classes-setuptools3-base:
2577 2577
2578``setuptools3-base.bbclass`` 2578``setuptools3-base``
2579============================ 2579====================
2580 2580
2581The :ref:`setuptools3-base <ref-classes-setuptools3-base>` class provides a reusable base for other classes 2581The :ref:`setuptools3-base <ref-classes-setuptools3-base>` class provides a reusable base for other classes
2582that support building Python version 3.x extensions. If you need 2582that 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
2586 2586
2587.. _ref-classes-sign_rpm: 2587.. _ref-classes-sign_rpm:
2588 2588
2589``sign_rpm.bbclass`` 2589``sign_rpm``
2590==================== 2590============
2591 2591
2592The :ref:`sign_rpm <ref-classes-sign_rpm>` class supports generating signed RPM packages. 2592The :ref:`sign_rpm <ref-classes-sign_rpm>` class supports generating signed RPM packages.
2593 2593
2594.. _ref-classes-siteconfig: 2594.. _ref-classes-siteconfig:
2595 2595
2596``siteconfig.bbclass`` 2596``siteconfig``
2597====================== 2597==============
2598 2598
2599The :ref:`siteconfig <ref-classes-siteconfig>` class provides functionality for handling site 2599The :ref:`siteconfig <ref-classes-siteconfig>` class provides functionality for handling site
2600configuration. The class is used by the 2600configuration. The class is used by the
@@ -2603,8 +2603,8 @@ configuration. The class is used by the
2603 2603
2604.. _ref-classes-siteinfo: 2604.. _ref-classes-siteinfo:
2605 2605
2606``siteinfo.bbclass`` 2606``siteinfo``
2607==================== 2607============
2608 2608
2609The :ref:`siteinfo <ref-classes-siteinfo>` class provides information about the targets that might 2609The :ref:`siteinfo <ref-classes-siteinfo>` class provides information about the targets that might
2610be needed by other classes or recipes. 2610be needed by other classes or recipes.
@@ -2624,8 +2624,8 @@ The class also provides variables like :term:`SITEINFO_ENDIANNESS` and
2624 2624
2625.. _ref-classes-sstate: 2625.. _ref-classes-sstate:
2626 2626
2627``sstate.bbclass`` 2627``sstate``
2628================== 2628==========
2629 2629
2630The :ref:`sstate <ref-classes-sstate>` class provides support for Shared State (sstate). By 2630The :ref:`sstate <ref-classes-sstate>` class provides support for Shared State (sstate). By
2631default, the class is enabled through the 2631default, the class is enabled through the
@@ -2637,8 +2637,8 @@ section in the Yocto Project Overview and Concepts Manual.
2637 2637
2638.. _ref-classes-staging: 2638.. _ref-classes-staging:
2639 2639
2640``staging.bbclass`` 2640``staging``
2641=================== 2641===========
2642 2642
2643The :ref:`staging <ref-classes-staging>` class installs files into individual recipe work 2643The :ref:`staging <ref-classes-staging>` class installs files into individual recipe work
2644directories for sysroots. The class contains the following key tasks: 2644directories for sysroots. The class contains the following key tasks:
@@ -2737,8 +2737,8 @@ stages:
2737 2737
2738.. _ref-classes-syslinux: 2738.. _ref-classes-syslinux:
2739 2739
2740``syslinux.bbclass`` 2740``syslinux``
2741==================== 2741============
2742 2742
2743The :ref:`syslinux <ref-classes-syslinux>` class provides syslinux-specific functions for building 2743The :ref:`syslinux <ref-classes-syslinux>` class provides syslinux-specific functions for building
2744bootable images. 2744bootable images.
@@ -2780,8 +2780,8 @@ The class supports the following variables:
2780 2780
2781.. _ref-classes-systemd: 2781.. _ref-classes-systemd:
2782 2782
2783``systemd.bbclass`` 2783``systemd``
2784=================== 2784===========
2785 2785
2786The :ref:`systemd <ref-classes-systemd>` class provides support for recipes that install systemd 2786The :ref:`systemd <ref-classes-systemd>` class provides support for recipes that install systemd
2787unit files. 2787unit files.
@@ -2815,8 +2815,8 @@ section in the Yocto Project Development Tasks Manual.
2815 2815
2816.. _ref-classes-systemd-boot: 2816.. _ref-classes-systemd-boot:
2817 2817
2818``systemd-boot.bbclass`` 2818``systemd-boot``
2819======================== 2819================
2820 2820
2821The :ref:`systemd-boot <ref-classes-systemd-boot>` class provides functions specific to the 2821The :ref:`systemd-boot <ref-classes-systemd-boot>` class provides functions specific to the
2822systemd-boot bootloader for building bootable images. This is an 2822systemd-boot bootloader for building bootable images. This is an
@@ -2842,8 +2842,8 @@ for more information.
2842 2842
2843.. _ref-classes-terminal: 2843.. _ref-classes-terminal:
2844 2844
2845``terminal.bbclass`` 2845``terminal``
2846==================== 2846============
2847 2847
2848The :ref:`terminal <ref-classes-terminal>` class provides support for starting a terminal session. 2848The :ref:`terminal <ref-classes-terminal>` class provides support for starting a terminal session.
2849The :term:`OE_TERMINAL` variable controls which 2849The :term:`OE_TERMINAL` variable controls which
@@ -2859,8 +2859,8 @@ class.
2859 2859
2860.. _ref-classes-testimage: 2860.. _ref-classes-testimage:
2861 2861
2862``testimage.bbclass`` 2862``testimage``
2863===================== 2863=============
2864 2864
2865The :ref:`testimage <ref-classes-testimage>` class supports running automated tests against 2865The :ref:`testimage <ref-classes-testimage>` class supports running automated tests against
2866images using QEMU and on actual hardware. The classes handle loading the 2866images using QEMU and on actual hardware. The classes handle loading the
@@ -2890,8 +2890,8 @@ section in the Yocto Project Development Tasks Manual.
2890 2890
2891.. _ref-classes-testsdk: 2891.. _ref-classes-testsdk:
2892 2892
2893``testsdk.bbclass`` 2893``testsdk``
2894=================== 2894===========
2895 2895
2896This class supports running automated tests against software development 2896This class supports running automated tests against software development
2897kits (SDKs). The :ref:`testsdk <ref-classes-testsdk>` class runs tests on an SDK when called 2897kits (SDKs). The :ref:`testsdk <ref-classes-testsdk>` class runs tests on an SDK when called
@@ -2907,8 +2907,8 @@ using the following::
2907 2907
2908.. _ref-classes-texinfo: 2908.. _ref-classes-texinfo:
2909 2909
2910``texinfo.bbclass`` 2910``texinfo``
2911=================== 2911===========
2912 2912
2913This class should be inherited by recipes whose upstream packages invoke 2913This class should be inherited by recipes whose upstream packages invoke
2914the ``texinfo`` utilities at build-time. Native and cross recipes are 2914the ``texinfo`` utilities at build-time. Native and cross recipes are
@@ -2925,8 +2925,8 @@ host system.
2925 2925
2926.. _ref-classes-toaster: 2926.. _ref-classes-toaster:
2927 2927
2928``toaster.bbclass`` 2928``toaster``
2929=================== 2929===========
2930 2930
2931The :ref:`toaster <ref-classes-toaster>` class collects information about packages and images and 2931The :ref:`toaster <ref-classes-toaster>` class collects information about packages and images and
2932sends them as events that the BitBake user interface can receive. The 2932sends them as events that the BitBake user interface can receive. The
@@ -2936,16 +2936,16 @@ This class is not intended to be used directly.
2936 2936
2937.. _ref-classes-toolchain-scripts: 2937.. _ref-classes-toolchain-scripts:
2938 2938
2939``toolchain-scripts.bbclass`` 2939``toolchain-scripts``
2940============================= 2940=====================
2941 2941
2942The :ref:`toolchain-scripts <ref-classes-toolchain-scripts>` class provides the scripts used for setting up 2942The :ref:`toolchain-scripts <ref-classes-toolchain-scripts>` class provides the scripts used for setting up
2943the environment for installed SDKs. 2943the environment for installed SDKs.
2944 2944
2945.. _ref-classes-typecheck: 2945.. _ref-classes-typecheck:
2946 2946
2947``typecheck.bbclass`` 2947``typecheck``
2948===================== 2948=============
2949 2949
2950The :ref:`typecheck <ref-classes-typecheck>` class provides support for validating the values of 2950The :ref:`typecheck <ref-classes-typecheck>` class provides support for validating the values of
2951variables set at the configuration level against their defined types. 2951variables set at the configuration level against their defined types.
@@ -2956,8 +2956,8 @@ variable using the "type" varflag. Here is an example::
2956 2956
2957.. _ref-classes-uboot-config: 2957.. _ref-classes-uboot-config:
2958 2958
2959``uboot-config.bbclass`` 2959``uboot-config``
2960======================== 2960================
2961 2961
2962The :ref:`uboot-config <ref-classes-uboot-config>` class provides support for U-Boot configuration for 2962The :ref:`uboot-config <ref-classes-uboot-config>` class provides support for U-Boot configuration for
2963a machine. Specify the machine in your recipe as follows:: 2963a machine. Specify the machine in your recipe as follows::
@@ -2974,8 +2974,8 @@ information.
2974 2974
2975.. _ref-classes-uninative: 2975.. _ref-classes-uninative:
2976 2976
2977``uninative.bbclass`` 2977``uninative``
2978===================== 2978=============
2979 2979
2980Attempts to isolate the build system from the host distribution's C 2980Attempts to isolate the build system from the host distribution's C
2981library in order to make re-use of native shared state artifacts across 2981library 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.
2996 2996
2997.. _ref-classes-update-alternatives: 2997.. _ref-classes-update-alternatives:
2998 2998
2999``update-alternatives.bbclass`` 2999``update-alternatives``
3000=============================== 3000=======================
3001 3001
3002The :ref:`update-alternatives <ref-classes-update-alternatives>` class helps the alternatives system when 3002The :ref:`update-alternatives <ref-classes-update-alternatives>` class helps the alternatives system when
3003multiple sources provide the same command. This situation occurs when 3003multiple sources provide the same command. This situation occurs when
@@ -3034,8 +3034,8 @@ file.
3034 3034
3035.. _ref-classes-update-rc.d: 3035.. _ref-classes-update-rc.d:
3036 3036
3037``update-rc.d.bbclass`` 3037``update-rc.d``
3038======================= 3038===============
3039 3039
3040The :ref:`update-rc.d <ref-classes-update-rc.d>` class uses ``update-rc.d`` to safely install an 3040The :ref:`update-rc.d <ref-classes-update-rc.d>` class uses ``update-rc.d`` to safely install an
3041initialization script on behalf of the package. The OpenEmbedded build 3041initialization script on behalf of the package. The OpenEmbedded build
@@ -3048,8 +3048,8 @@ for details.
3048 3048
3049.. _ref-classes-useradd: 3049.. _ref-classes-useradd:
3050 3050
3051``useradd*.bbclass`` 3051``useradd*``
3052==================== 3052============
3053 3053
3054The :ref:`useradd* <ref-classes-useradd>` classes support the addition of users or groups for 3054The :ref:`useradd* <ref-classes-useradd>` classes support the addition of users or groups for
3055usage by the package on the target. For example, if you have packages 3055usage by the package on the target. For example, if you have packages
@@ -3103,8 +3103,8 @@ additional information.
3103 3103
3104.. _ref-classes-utility-tasks: 3104.. _ref-classes-utility-tasks:
3105 3105
3106``utility-tasks.bbclass`` 3106``utility-tasks``
3107========================= 3107=================
3108 3108
3109The :ref:`utility-tasks <ref-classes-utility-tasks>` class provides support for various "utility" type 3109The :ref:`utility-tasks <ref-classes-utility-tasks>` class provides support for various "utility" type
3110tasks that are applicable to all recipes, such as 3110tasks that are applicable to all recipes, such as
@@ -3116,8 +3116,8 @@ This class is enabled by default because it is inherited by the
3116 3116
3117.. _ref-classes-utils: 3117.. _ref-classes-utils:
3118 3118
3119``utils.bbclass`` 3119``utils``
3120================= 3120=========
3121 3121
3122The :ref:`utils <ref-classes-utils>` class provides some useful Python functions that are 3122The :ref:`utils <ref-classes-utils>` class provides some useful Python functions that are
3123typically used in inline Python expressions (e.g. ``${@...}``). One 3123typically used in inline Python expressions (e.g. ``${@...}``). One
@@ -3128,16 +3128,16 @@ This class is enabled by default because it is inherited by the
3128 3128
3129.. _ref-classes-vala: 3129.. _ref-classes-vala:
3130 3130
3131``vala.bbclass`` 3131``vala``
3132================ 3132========
3133 3133
3134The :ref:`vala <ref-classes-vala>` class supports recipes that need to build software written 3134The :ref:`vala <ref-classes-vala>` class supports recipes that need to build software written
3135using the Vala programming language. 3135using the Vala programming language.
3136 3136
3137.. _ref-classes-waf: 3137.. _ref-classes-waf:
3138 3138
3139``waf.bbclass`` 3139``waf``
3140=============== 3140=======
3141 3141
3142The :ref:`waf <ref-classes-waf>` class supports recipes that need to build software that uses 3142The :ref:`waf <ref-classes-waf>` class supports recipes that need to build software that uses
3143the Waf build system. You can use the 3143the Waf build system. You can use the