diff options
-rw-r--r-- | documentation/ref-manual/classes.rst | 588 |
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 | ||
40 | The :ref:`allarch <ref-classes-allarch>` class is inherited by recipes that do not produce | 40 | The :ref:`allarch <ref-classes-allarch>` class is inherited by recipes that do not produce |
41 | architecture-specific output. The class disables functionality that is | 41 | architecture-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 | ||
73 | The :ref:`archiver <ref-classes-archiver>` class supports releasing source code and other | 73 | The :ref:`archiver <ref-classes-archiver>` class supports releasing source code and other |
74 | materials with the binaries. | 74 | materials 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 | ||
87 | The :ref:`autotools* <ref-classes-autotools>` classes support packages built with the | 87 | The :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 | ||
136 | The :ref:`base <ref-classes-base>` class is special in that every ``.bb`` file implicitly | 136 | The :ref:`base <ref-classes-base>` class is special in that every ``.bb`` file implicitly |
137 | inherits the class. This class contains definitions for standard basic | 137 | inherits 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 | ||
155 | Sets up packaging and dependencies appropriate for recipes that build | 155 | Sets up packaging and dependencies appropriate for recipes that build |
156 | software that includes bash-completion data. | 156 | software 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 | ||
163 | The :ref:`bin_package <ref-classes-bin-package>` class is a helper class for recipes that extract the | 163 | The :ref:`bin_package <ref-classes-bin-package>` class is a helper class for recipes that extract the |
164 | contents of a binary package (e.g. an RPM) and install those contents | 164 | contents 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 | ||
190 | The :ref:`binconfig <ref-classes-binconfig>` class helps to correct paths in shell scripts. | 190 | The :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 | ||
210 | An alternative version of the :ref:`binconfig <ref-classes-binconfig>` | 210 | An alternative version of the :ref:`binconfig <ref-classes-binconfig>` |
211 | class, which disables binary configuration scripts by making them return | 211 | class, 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 | ||
221 | The :ref:`buildhistory <ref-classes-buildhistory>` class records a history of build output metadata, | 221 | The :ref:`buildhistory <ref-classes-buildhistory>` class records a history of build output metadata, |
222 | which can be used to detect possible regressions as well as used for | 222 | which can be used to detect possible regressions as well as used for |
@@ -227,8 +227,8 @@ section in the Yocto Project Development Tasks Manual. | |||
227 | 227 | ||
228 | .. _ref-classes-buildstats: | 228 | .. _ref-classes-buildstats: |
229 | 229 | ||
230 | ``buildstats.bbclass`` | 230 | ``buildstats`` |
231 | ====================== | 231 | ============== |
232 | 232 | ||
233 | The :ref:`buildstats <ref-classes-buildstats>` class records performance statistics about each task | 233 | The :ref:`buildstats <ref-classes-buildstats>` class records performance statistics about each task |
234 | executed during the build (e.g. elapsed time, CPU usage, and I/O usage). | 234 | executed during the build (e.g. elapsed time, CPU usage, and I/O usage). |
@@ -248,8 +248,8 @@ remove ":ref:`buildstats <ref-classes-buildstats>`" from the :term:`USER_CLASSES | |||
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 | ||
254 | When inherited globally, prints statistics at the end of the build on | 254 | When inherited globally, prints statistics at the end of the build on |
255 | sstate re-use. In order to function, this class requires the | 255 | sstate re-use. In order to function, this class requires the |
@@ -257,8 +257,8 @@ sstate re-use. In order to function, this class requires the | |||
257 | 257 | ||
258 | .. _ref-classes-ccache: | 258 | .. _ref-classes-ccache: |
259 | 259 | ||
260 | ``ccache.bbclass`` | 260 | ``ccache`` |
261 | ================== | 261 | ========== |
262 | 262 | ||
263 | The :ref:`ccache <ref-classes-ccache>` class enables the C/C++ Compiler Cache for the build. | 263 | The :ref:`ccache <ref-classes-ccache>` class enables the C/C++ Compiler Cache for the build. |
264 | This class is used to give a minor performance boost during the build. | 264 | This 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 | ||
280 | The :ref:`chrpath <ref-classes-chrpath>` class is a wrapper around the "chrpath" utility, which | 280 | The :ref:`chrpath <ref-classes-chrpath>` class is a wrapper around the "chrpath" utility, which |
281 | is used during the build process for :ref:`nativesdk <ref-classes-nativesdk>`, :ref:`cross <ref-classes-cross>`, and | 281 | is used during the build process for :ref:`nativesdk <ref-classes-nativesdk>`, :ref:`cross <ref-classes-cross>`, and |
@@ -284,8 +284,8 @@ in order to make them relocatable. | |||
284 | 284 | ||
285 | .. _ref-classes-cmake: | 285 | .. _ref-classes-cmake: |
286 | 286 | ||
287 | ``cmake.bbclass`` | 287 | ``cmake`` |
288 | ================= | 288 | ========= |
289 | 289 | ||
290 | The ref:`cmake <ref-classes-cmake>` class allows for recipes that need to build software using | 290 | The ref:`cmake <ref-classes-cmake>` class allows for recipes that need to build software using |
291 | the `CMake <https://cmake.org/overview/>`__ build system. You can use | 291 | the `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 | ||
307 | The :ref:`cml1 <ref-classes-cml1>` class provides basic support for the Linux kernel style | 307 | The :ref:`cml1 <ref-classes-cml1>` class provides basic support for the Linux kernel style |
308 | build configuration system. | 308 | build 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 | ||
315 | Enables compression for man pages and info pages. This class is intended | 315 | Enables compression for man pages and info pages. This class is intended |
316 | to be inherited globally. The default compression mechanism is gz (gzip) | 316 | to be inherited globally. The default compression mechanism is gz (gzip) |
@@ -319,8 +319,8 @@ but you can select an alternative mechanism by setting the | |||
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 | ||
325 | The :ref:`copyleft_compliance <ref-classes-copyleft_compliance>` class preserves source code for the purposes | 325 | The :ref:`copyleft_compliance <ref-classes-copyleft_compliance>` class preserves source code for the purposes |
326 | of license compliance. This class is an alternative to the :ref:`archiver <ref-classes-archiver>` | 326 | of license compliance. This class is an alternative to the :ref:`archiver <ref-classes-archiver>` |
@@ -329,8 +329,8 @@ in favor of the :ref:`archiver <ref-classes-archiver>` class. | |||
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 | ||
335 | A class used by the :ref:`archiver <ref-classes-archiver>` and | 335 | A 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 | ||
345 | The :ref:`core-image <ref-classes-core-image>` class provides common definitions for the | 345 | The :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 | ||
354 | The :ref:`cpan* <ref-classes-cpan>` classes support Perl modules. | 354 | The :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 | ||
375 | The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for | 375 | The :ref:`create-spdx <ref-classes-create-spdx>` class provides support for |
376 | automatically creating :term:`SPDX` :term:`SBOM` documents based upon image | 376 | automatically 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 | ||
401 | The :ref:`cross <ref-classes-cross>` class provides support for the recipes that build the | 401 | The :ref:`cross <ref-classes-cross>` class provides support for the recipes that build the |
402 | cross-compilation tools. | 402 | cross-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 | ||
409 | The :ref:`cross-canadian <ref-classes-cross-canadian>` class provides support for the recipes that build | 409 | The :ref:`cross-canadian <ref-classes-cross-canadian>` class provides support for the recipes that build |
410 | the Canadian Cross-compilation tools for SDKs. See the | 410 | the 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 | ||
420 | The :ref:`crosssdk <ref-classes-crosssdk>` class provides support for the recipes that build the | 420 | The :ref:`crosssdk <ref-classes-crosssdk>` class provides support for the recipes that build the |
421 | cross-compilation tools used for building SDKs. See the | 421 | cross-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 | ||
431 | The :ref:`cve-check <ref-classes-cve-check>` class looks for known CVEs (Common Vulnerabilities | 431 | The :ref:`cve-check <ref-classes-cve-check>` class looks for known CVEs (Common Vulnerabilities |
432 | and Exposures) while building with BitBake. This class is meant to be | 432 | and 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 | ||
495 | The :ref:`debian <ref-classes-debian>` class renames output packages so that they follow the | 495 | The :ref:`debian <ref-classes-debian>` class renames output packages so that they follow the |
496 | Debian naming policy (i.e. ``glibc`` becomes ``libc6`` and | 496 | Debian 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 | ||
510 | The :ref:`deploy <ref-classes-deploy>` class handles deploying files to the | 510 | The :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 | ||
526 | The :ref:`devshell <ref-classes-devshell>` class adds the :ref:`ref-tasks-devshell` task. Distribution | 526 | The :ref:`devshell <ref-classes-devshell>` class adds the :ref:`ref-tasks-devshell` task. Distribution |
527 | policy dictates whether to include this class. See the ":ref:`dev-manual/development-shell:using a development shell`" | 527 | policy dictates whether to include this class. See the ":ref:`dev-manual/development-shell:using a development shell`" |
@@ -530,8 +530,8 @@ information about using :ref:`devshell <ref-classes-devshell>`. | |||
530 | 530 | ||
531 | .. _ref-classes-devupstream: | 531 | .. _ref-classes-devupstream: |
532 | 532 | ||
533 | ``devupstream.bbclass`` | 533 | ``devupstream`` |
534 | ======================= | 534 | =============== |
535 | 535 | ||
536 | The :ref:`devupstream <ref-classes-devupstream>` class uses | 536 | The :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 | ||
573 | The :ref:`externalsrc <ref-classes-externalsrc>` class supports building software from source code | 573 | The :ref:`externalsrc <ref-classes-externalsrc>` class supports building software from source code |
574 | that is external to the OpenEmbedded build system. Building software | 574 | that 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 | ||
609 | The :ref:`extrausers <ref-classes-extrausers>` class allows additional user and group configuration | 609 | The :ref:`extrausers <ref-classes-extrausers>` class allows additional user and group configuration |
610 | to be applied at the image level. Inheriting this class either globally | 610 | to be applied at the image level. Inheriting this class either globally |
@@ -665,8 +665,8 @@ Finally, here is an example that sets the root password:: | |||
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 | ||
671 | The :ref:`features_check <ref-classes-features_check>` class allows individual recipes to check | 671 | The :ref:`features_check <ref-classes-features_check>` class allows individual recipes to check |
672 | for required and conflicting | 672 | for 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 | ||
697 | The :ref:`fontcache <ref-classes-fontcache>` class generates the proper post-install and | 697 | The :ref:`fontcache <ref-classes-fontcache>` class generates the proper post-install and |
698 | post-remove (postinst and postrm) scriptlets for font packages. These | 698 | post-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 | ||
713 | The :ref:`fs-uuid <ref-classes-fs-uuid>` class extracts UUID from | 713 | The :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 | ||
723 | The :ref:`gconf <ref-classes-gconf>` class provides common functionality for recipes that need | 723 | The :ref:`gconf <ref-classes-gconf>` class provides common functionality for recipes that need |
724 | to install GConf schemas. The schemas will be put into a separate | 724 | to install GConf schemas. The schemas will be put into a separate |
@@ -729,8 +729,8 @@ register and unregister the schemas in the target image. | |||
729 | 729 | ||
730 | .. _ref-classes-gettext: | 730 | .. _ref-classes-gettext: |
731 | 731 | ||
732 | ``gettext.bbclass`` | 732 | ``gettext`` |
733 | =================== | 733 | =========== |
734 | 734 | ||
735 | The :ref:`gettext <ref-classes-gettext>` class provides support for building | 735 | The :ref:`gettext <ref-classes-gettext>` class provides support for building |
736 | software that uses the GNU ``gettext`` internationalization and localization | 736 | software 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 | ||
745 | For recipes that fetch release tarballs from github, the :ref:`github-releases <ref-classes-github-releases>` | 745 | For recipes that fetch release tarballs from github, the :ref:`github-releases <ref-classes-github-releases>` |
746 | class sets up a standard way for checking available upstream versions | 746 | class sets up a standard way for checking available upstream versions |
@@ -753,8 +753,8 @@ in the value you set for :term:`SRC_URI` within the recipe. | |||
753 | 753 | ||
754 | .. _ref-classes-gnomebase: | 754 | .. _ref-classes-gnomebase: |
755 | 755 | ||
756 | ``gnomebase.bbclass`` | 756 | ``gnomebase`` |
757 | ===================== | 757 | ============= |
758 | 758 | ||
759 | The :ref:`gnomebase <ref-classes-gnomebase>` class is the base class for recipes that build | 759 | The :ref:`gnomebase <ref-classes-gnomebase>` class is the base class for recipes that build |
760 | software from the GNOME stack. This class sets | 760 | software 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 | ||
770 | Provides support for recipes building software that supports GObject | 770 | Provides support for recipes building software that supports GObject |
771 | introspection. This functionality is only enabled if the | 771 | introspection. 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 | ||
788 | The :ref:`grub-efi <ref-classes-grub-efi>` class provides ``grub-efi``-specific functions for | 788 | The :ref:`grub-efi <ref-classes-grub-efi>` class provides ``grub-efi``-specific functions for |
789 | building bootable images. | 789 | building 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 | ||
820 | The :ref:`gsettings <ref-classes-gsettings>` class provides common functionality for recipes that | 820 | The :ref:`gsettings <ref-classes-gsettings>` class provides common functionality for recipes that |
821 | need to install GSettings (glib) schemas. The schemas are assumed to be | 821 | need 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 | ||
831 | The :ref:`gtk-doc <ref-classes-gtk-doc>` class is a helper class to pull in the appropriate | 831 | The :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 | ||
839 | The :ref:`gtk-icon-cache <ref-classes-gtk-icon-cache>` class generates the proper post-install and | 839 | The :ref:`gtk-icon-cache <ref-classes-gtk-icon-cache>` class generates the proper post-install and |
840 | post-remove (postinst/postrm) scriptlets for packages that use GTK+ and | 840 | post-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 | ||
852 | The :ref:`gtk-immodules-cache <ref-classes-gtk-immodules-cache>` class generates the proper post-install and | 852 | The :ref:`gtk-immodules-cache <ref-classes-gtk-immodules-cache>` class generates the proper post-install and |
853 | post-remove (postinst/postrm) scriptlets for packages that install GTK+ | 853 | post-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 | ||
870 | The :ref:`gzipnative <ref-classes-gzipnative>` class enables the use of different native versions of | 870 | The :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 | ||
879 | The :ref:`icecc <ref-classes-icecc>` class supports | 879 | The :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 | ||
953 | The :ref:`image <ref-classes-image>` class helps support creating images in different formats. | 953 | The :ref:`image <ref-classes-image>` class helps support creating images in different formats. |
954 | First, the root filesystem is created from packages using one of the | 954 | First, 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 | ||
976 | The :ref:`image-buildinfo <ref-classes-image-buildinfo>` class writes a plain text file containing | 976 | The :ref:`image-buildinfo <ref-classes-image-buildinfo>` class writes a plain text file containing |
977 | build information to the target filesystem at ``${sysconfdir}/buildinfo`` | 977 | build 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 | ||
998 | The :ref:`image_types <ref-classes-image_types>` class defines all of the standard image output types | 998 | The :ref:`image_types <ref-classes-image_types>` class defines all of the standard image output types |
999 | that you can enable through the | 999 | that 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 | ||
1030 | This class controls building "live" (i.e. HDDIMG and ISO) images. Live | 1030 | This class controls building "live" (i.e. HDDIMG and ISO) images. Live |
1031 | images contain syslinux for legacy booting, as well as the bootloader | 1031 | images contain syslinux for legacy booting, as well as the bootloader |
@@ -1037,8 +1037,8 @@ Normally, you do not use this class directly. Instead, you add "live" to | |||
1037 | 1037 | ||
1038 | .. _ref-classes-insane: | 1038 | .. _ref-classes-insane: |
1039 | 1039 | ||
1040 | ``insane.bbclass`` | 1040 | ``insane`` |
1041 | ================== | 1041 | ========== |
1042 | 1042 | ||
1043 | The :ref:`insane <ref-classes-insane>` class adds a step to the package generation process so | 1043 | The :ref:`insane <ref-classes-insane>` class adds a step to the package generation process so |
1044 | that output quality assurance checks are generated by the OpenEmbedded | 1044 | that output quality assurance checks are generated by the OpenEmbedded |
@@ -1337,8 +1337,8 @@ Here are the tests you can list with the :term:`WARN_QA` and | |||
1337 | 1337 | ||
1338 | .. _ref-classes-insserv: | 1338 | .. _ref-classes-insserv: |
1339 | 1339 | ||
1340 | ``insserv.bbclass`` | 1340 | ``insserv`` |
1341 | =================== | 1341 | =========== |
1342 | 1342 | ||
1343 | The :ref:`insserv <ref-classes-insserv>` class uses the ``insserv`` utility to update the order | 1343 | The :ref:`insserv <ref-classes-insserv>` class uses the ``insserv`` utility to update the order |
1344 | of symbolic links in ``/etc/rc?.d/`` within an image based on | 1344 | of 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 | ||
1353 | The :ref:`kernel <ref-classes-kernel>` class handles building Linux kernels. The class contains | 1353 | The :ref:`kernel <ref-classes-kernel>` class handles building Linux kernels. The class contains |
1354 | code to build all kernel trees. All needed headers are staged into the | 1354 | code to build all kernel trees. All needed headers are staged into the |
@@ -1374,16 +1374,16 @@ internally including the :ref:`kernel-arch <ref-classes-kernel-arch>`, | |||
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 | ||
1380 | The :ref:`kernel-arch <ref-classes-kernel-arch>` class sets the ``ARCH`` environment variable for | 1380 | The :ref:`kernel-arch <ref-classes-kernel-arch>` class sets the ``ARCH`` environment variable for |
1381 | Linux kernel compilation (including modules). | 1381 | Linux 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 | ||
1388 | The :ref:`kernel-devicetree <ref-classes-kernel-devicetree>` class, which is inherited by the | 1388 | The :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 | ||
1397 | The :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class provides support to pack a kernel image, | 1397 | The :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class provides support to pack a kernel image, |
1398 | device trees, a U-boot script, a :term:`Initramfs` bundle and a RAM disk | 1398 | device trees, a U-boot script, a :term:`Initramfs` bundle and a RAM disk |
@@ -1462,8 +1462,8 @@ the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class when both :term:` | |||
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 | ||
1468 | The :ref:`kernel-grub <ref-classes-kernel-grub>` class updates the boot area and the boot menu with | 1468 | The :ref:`kernel-grub <ref-classes-kernel-grub>` class updates the boot area and the boot menu with |
1469 | the kernel as the priority boot mechanism while installing a RPM to | 1469 | the 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 | ||
1477 | The :ref:`kernel-module-split <ref-classes-kernel-module-split>` class provides common functionality for | 1477 | The :ref:`kernel-module-split <ref-classes-kernel-module-split>` class provides common functionality for |
1478 | splitting Linux kernel modules into separate packages. | 1478 | splitting 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 | ||
1485 | The :ref:`kernel-uboot <ref-classes-kernel-uboot>` class provides support for building from | 1485 | The :ref:`kernel-uboot <ref-classes-kernel-uboot>` class provides support for building from |
1486 | vmlinux-style kernel sources. | 1486 | vmlinux-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 | ||
1493 | The :ref:`kernel-uimage <ref-classes-kernel-uimage>` class provides support to pack uImage. | 1493 | The :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 | ||
1500 | The :ref:`kernel-yocto <ref-classes-kernel-yocto>` class provides common functionality for building | 1500 | The :ref:`kernel-yocto <ref-classes-kernel-yocto>` class provides common functionality for building |
1501 | from linux-yocto style kernel source repositories. | 1501 | from 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 | ||
1508 | The :ref:`kernelsrc <ref-classes-kernelsrc>` class sets the Linux kernel source and version. | 1508 | The :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 | ||
1515 | The :ref:`lib_package <ref-classes-lib_package>` class supports recipes that build libraries and | 1515 | The :ref:`lib_package <ref-classes-lib_package>` class supports recipes that build libraries and |
1516 | produce executable binaries, where those binaries should not be | 1516 | produce 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 | ||
1526 | The :ref:`libc* <ref-classes-libc*>` classes support recipes that build packages with ``libc``: | 1526 | The :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 | ||
1539 | The :ref:`license <ref-classes-license>` class provides license manifest creation and license | 1539 | The :ref:`license <ref-classes-license>` class provides license manifest creation and license |
1540 | exclusion. This class is enabled by default using the default value for | 1540 | exclusion. 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 | ||
1548 | The :ref:`linux-kernel-base <ref-classes-linux-kernel-base>` class provides common functionality for | 1548 | The :ref:`linux-kernel-base <ref-classes-linux-kernel-base>` class provides common functionality for |
1549 | recipes that build out of the Linux kernel source tree. These builds | 1549 | recipes 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 | ||
1558 | Provides the function ``linuxloader()``, which gives the value of the | 1558 | Provides the function ``linuxloader()``, which gives the value of the |
1559 | dynamic loader/linker provided on the platform. This value is used by a | 1559 | dynamic 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 | ||
1567 | The :ref:`logging <ref-classes-logging>` class provides the standard shell functions used to log | 1567 | The :ref:`logging <ref-classes-logging>` class provides the standard shell functions used to log |
1568 | messages for various BitBake severity levels (i.e. ``bbplain``, | 1568 | messages 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 | ||
1579 | The :ref:`metadata_scm <ref-classes-metadata_scm>` class provides functionality for querying the | 1579 | The :ref:`metadata_scm <ref-classes-metadata_scm>` class provides functionality for querying the |
1580 | branch and revision of a Source Code Manager (SCM) repository. | 1580 | branch 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 | ||
1592 | The :ref:`migrate_localcount <ref-classes-migrate_localcount>` class verifies a recipe's localcount data and | 1592 | The :ref:`migrate_localcount <ref-classes-migrate_localcount>` class verifies a recipe's localcount data and |
1593 | increments it appropriately. | 1593 | increments it appropriately. |
1594 | 1594 | ||
1595 | .. _ref-classes-mime: | 1595 | .. _ref-classes-mime: |
1596 | 1596 | ||
1597 | ``mime.bbclass`` | 1597 | ``mime`` |
1598 | ================ | 1598 | ======== |
1599 | 1599 | ||
1600 | The :ref:`mime <ref-classes-mime>` class generates the proper post-install and post-remove | 1600 | The :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 | ||
1610 | The :ref:`mime-xdg <ref-classes-mime-xdg>` class generates the proper | 1610 | The :ref:`mime-xdg <ref-classes-mime-xdg>` class generates the proper |
1611 | post-install and post-remove (postinst/postrm) scriptlets for packages | 1611 | post-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 | ||
1631 | The :ref:`mirrors <ref-classes-mirrors>` class sets up some standard | 1631 | The :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 | ||
1644 | The :ref:`module <ref-classes-module>` class provides support for building out-of-tree Linux | 1644 | The :ref:`module <ref-classes-module>` class provides support for building out-of-tree Linux |
1645 | kernel modules. The class inherits the | 1645 | kernel 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 | ||
1661 | The :ref:`module-base <ref-classes-module-base>` class provides the base functionality for building | 1661 | The :ref:`module-base <ref-classes-module-base>` class provides the base functionality for building |
1662 | Linux kernel modules. Typically, a recipe that builds software that | 1662 | Linux 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 | ||
1672 | The :ref:`multilib* <ref-classes-multilib*>` classes provide support for building libraries with | 1672 | The :ref:`multilib* <ref-classes-multilib*>` classes provide support for building libraries with |
1673 | different target optimizations or target architectures and installing | 1673 | different 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 | ||
1685 | The :ref:`native <ref-classes-native>` class provides common functionality for recipes that | 1685 | The :ref:`native <ref-classes-native>` class provides common functionality for recipes that |
1686 | build tools to run on the :term:`Build Host` (i.e. tools that use the compiler | 1686 | build tools to run on the :term:`Build Host` (i.e. tools that use the compiler |
@@ -1721,8 +1721,8 @@ target. All common parts of the recipe are automatically shared. | |||
1721 | 1721 | ||
1722 | .. _ref-classes-nativesdk: | 1722 | .. _ref-classes-nativesdk: |
1723 | 1723 | ||
1724 | ``nativesdk.bbclass`` | 1724 | ``nativesdk`` |
1725 | ===================== | 1725 | ============= |
1726 | 1726 | ||
1727 | The :ref:`nativesdk <ref-classes-nativesdk>` class provides common functionality for recipes that | 1727 | The :ref:`nativesdk <ref-classes-nativesdk>` class provides common functionality for recipes that |
1728 | wish to build tools to run as part of an SDK (i.e. tools that run on | 1728 | wish to build tools to run as part of an SDK (i.e. tools that run on |
@@ -1762,16 +1762,16 @@ and the target. All common parts of the recipe are automatically shared. | |||
1762 | 1762 | ||
1763 | .. _ref-classes-nopackages: | 1763 | .. _ref-classes-nopackages: |
1764 | 1764 | ||
1765 | ``nopackages.bbclass`` | 1765 | ``nopackages`` |
1766 | ====================== | 1766 | ============== |
1767 | 1767 | ||
1768 | Disables packaging tasks for those recipes and classes where packaging | 1768 | Disables packaging tasks for those recipes and classes where packaging |
1769 | is not needed. | 1769 | is not needed. |
1770 | 1770 | ||
1771 | .. _ref-classes-npm: | 1771 | .. _ref-classes-npm: |
1772 | 1772 | ||
1773 | ``npm.bbclass`` | 1773 | ``npm`` |
1774 | =============== | 1774 | ======= |
1775 | 1775 | ||
1776 | Provides support for building Node.js software fetched using the | 1776 | Provides 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 | ||
1793 | The :ref:`oelint <ref-classes-oelint>` class is an obsolete lint checking tool available in | 1793 | The :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 | ||
1807 | It's often desired in Embedded System design to have a read-only root filesystem. | 1807 | It's often desired in Embedded System design to have a read-only root filesystem. |
1808 | But a lot of different applications might want to have read-write access to | 1808 | But 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 | ||
1871 | In order to have the ``/etc`` directory in overlayfs a special handling at early | 1871 | In order to have the ``/etc`` directory in overlayfs a special handling at early |
1872 | boot stage is required. The idea is to supply a custom init script that mounts | 1872 | boot stage is required. The idea is to supply a custom init script that mounts |
@@ -1910,8 +1910,8 @@ The class provides two options for ``/sbin/init`` generation: | |||
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 | ||
1916 | The :ref:`own-mirrors <ref-classes-own-mirrors>` class makes it easier to set up your own | 1916 | The :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 | ||
1935 | The :ref:`package <ref-classes-package>` class supports generating packages from a build's | 1935 | The :ref:`package <ref-classes-package>` class supports generating packages from a build's |
1936 | output. The core generic functionality is in ``package.bbclass``. The | 1936 | output. 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 | ||
2000 | The :ref:`package_deb <ref-classes-package_deb>` class provides support for creating packages that | 2000 | The :ref:`package_deb <ref-classes-package_deb>` class provides support for creating packages that |
2001 | use the Debian (i.e. ``.deb``) file format. The class ensures the | 2001 | use 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 | ||
2014 | The :ref:`package_ipk <ref-classes-package_ipk>` class provides support for creating packages that | 2014 | The :ref:`package_ipk <ref-classes-package_ipk>` class provides support for creating packages that |
2015 | use the IPK (i.e. ``.ipk``) file format. The class ensures the packages | 2015 | use 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 | ||
2028 | The :ref:`package_rpm <ref-classes-package_rpm>` class provides support for creating packages that | 2028 | The :ref:`package_rpm <ref-classes-package_rpm>` class provides support for creating packages that |
2029 | use the RPM (i.e. ``.rpm``) file format. The class ensures the packages | 2029 | use 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 | ||
2042 | The :ref:`package_tar <ref-classes-package_tar>` class provides support for creating tarballs. The | 2042 | The :ref:`package_tar <ref-classes-package_tar>` class provides support for creating tarballs. The |
2043 | class ensures the packages are written out in a tarball format to the | 2043 | class 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 | ||
2061 | The :ref:`packagedata <ref-classes-packagedata>` class provides common functionality for reading | 2061 | The :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 | ||
2074 | The :ref:`packagegroup <ref-classes-packagegroup>` class sets default values appropriate for package | 2074 | The :ref:`packagegroup <ref-classes-packagegroup>` class sets default values appropriate for package |
2075 | group recipes (e.g. :term:`PACKAGES`, :term:`PACKAGE_ARCH`, :term:`ALLOW_EMPTY`, and | 2075 | group recipes (e.g. :term:`PACKAGES`, :term:`PACKAGE_ARCH`, :term:`ALLOW_EMPTY`, and |
@@ -2084,8 +2084,8 @@ Previously, this class was called the ``task`` class. | |||
2084 | 2084 | ||
2085 | .. _ref-classes-patch: | 2085 | .. _ref-classes-patch: |
2086 | 2086 | ||
2087 | ``patch.bbclass`` | 2087 | ``patch`` |
2088 | ================= | 2088 | ========= |
2089 | 2089 | ||
2090 | The :ref:`patch <ref-classes-patch>` class provides all functionality for applying patches | 2090 | The :ref:`patch <ref-classes-patch>` class provides all functionality for applying patches |
2091 | during the :ref:`ref-tasks-patch` task. | 2091 | during 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 | ||
2101 | When inherited by a recipe, the :ref:`perlnative <ref-classes-perlnative>` class supports using the | 2101 | When inherited by a recipe, the :ref:`perlnative <ref-classes-perlnative>` class supports using the |
2102 | native version of Perl built by the build system rather than using the | 2102 | native 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 | ||
2110 | The :ref:`pypi <ref-classes-pypi>` class sets variables appropriately for recipes that build | 2110 | The :ref:`pypi <ref-classes-pypi>` class sets variables appropriately for recipes that build |
2111 | Python modules from `PyPI <https://pypi.org/>`__, the Python Package Index. | 2111 | Python 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 | ||
2126 | The :ref:`python_flit_core <ref-classes-python_flit_core>` class enables building Python modules which declare | 2126 | The :ref:`python_flit_core <ref-classes-python_flit_core>` class enables building Python modules which declare |
2127 | the `PEP-517 <https://www.python.org/dev/peps/pep-0517/>`__ compliant | 2127 | the `PEP-517 <https://www.python.org/dev/peps/pep-0517/>`__ compliant |
@@ -2135,8 +2135,8 @@ Internally this uses the :ref:`python_pep517 <ref-classes-python_pep517>` class. | |||
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 | ||
2141 | The :ref:`python_pep517 <ref-classes-python_pep517>` class builds and installs a Python ``wheel`` binary | 2141 | The :ref:`python_pep517 <ref-classes-python_pep517>` class builds and installs a Python ``wheel`` binary |
2142 | archive (see `PEP-517 <https://peps.python.org/pep-0517/>`__). | 2142 | archive (see `PEP-517 <https://peps.python.org/pep-0517/>`__). |
@@ -2151,8 +2151,8 @@ Examples of classes which do this are :ref:`python_flit_core | |||
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 | ||
2157 | The :ref:`python_poetry_core <ref-classes-python_poetry_core>` class enables building Python modules which use the | 2157 | The :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 | ||
2167 | The :ref:`pixbufcache <ref-classes-pixbufcache>` class generates the proper post-install and | 2167 | The :ref:`pixbufcache <ref-classes-pixbufcache>` class generates the proper post-install and |
2168 | post-remove (postinst/postrm) scriptlets for packages that install | 2168 | post-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 | ||
2185 | The :ref:`pkgconfig <ref-classes-pkgconfig>` class provides a standard way to get header and | 2185 | The :ref:`pkgconfig <ref-classes-pkgconfig>` class provides a standard way to get header and |
2186 | library information by using ``pkg-config``. This class aims to smooth | 2186 | library 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 | ||
2199 | The :ref:`populate_sdk <ref-classes-populate-sdk>` class provides support for SDK-only recipes. For | 2199 | The :ref:`populate_sdk <ref-classes-populate-sdk>` class provides support for SDK-only recipes. For |
2200 | information on advantages gained when building a cross-development | 2200 | information 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 | ||
2211 | The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` classes support SDK creation and consist of the | 2211 | The :ref:`populate_sdk_* <ref-classes-populate-sdk-*>` classes support SDK creation and consist of the |
2212 | following classes: | 2212 | following 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 | ||
2268 | The :ref:`prexport <ref-classes-prexport>` class provides functionality for exporting | 2268 | The :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 | ||
2281 | The :ref:`primport <ref-classes-primport>` class provides functionality for importing | 2281 | The :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 | ||
2294 | The :ref:`prserv <ref-classes-prserv>` class provides functionality for using a :ref:`PR | 2294 | The :ref:`prserv <ref-classes-prserv>` class provides functionality for using a :ref:`PR |
2295 | service <dev-manual/packages:working with a pr service>` in order to | 2295 | service <dev-manual/packages:working with a pr service>` in order to |
@@ -2303,8 +2303,8 @@ build system will not enable the functionality of this class unless | |||
2303 | 2303 | ||
2304 | .. _ref-classes-ptest: | 2304 | .. _ref-classes-ptest: |
2305 | 2305 | ||
2306 | ``ptest.bbclass`` | 2306 | ``ptest`` |
2307 | ================= | 2307 | ========= |
2308 | 2308 | ||
2309 | The :ref:`ptest <ref-classes-ptest>` class provides functionality for packaging and installing | 2309 | The :ref:`ptest <ref-classes-ptest>` class provides functionality for packaging and installing |
2310 | runtime tests for recipes that build software that provides these tests. | 2310 | runtime 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 | ||
2324 | Enables package tests (ptests) specifically for GNOME packages, which | 2324 | Enables package tests (ptests) specifically for GNOME packages, which |
2325 | have tests intended to be executed with ``gnome-desktop-testing``. | 2325 | have 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 | ||
2336 | The :ref:`python3-dir <ref-classes-python3-dir>` class provides the base version, location, and site | 2336 | The :ref:`python3-dir <ref-classes-python3-dir>` class provides the base version, location, and site |
2337 | package location for Python 3. | 2337 | package 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 | ||
2344 | The :ref:`python3native <ref-classes-python3native>` class supports using the native version of Python | 2344 | The :ref:`python3native <ref-classes-python3native>` class supports using the native version of Python |
2345 | 3 built by the build system rather than support of the version provided | 2345 | 3 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 | ||
2353 | The :ref:`python3targetconfig <ref-classes-python3targetconfig>` class supports using the native version of Python | 2353 | The :ref:`python3targetconfig <ref-classes-python3targetconfig>` class supports using the native version of Python |
2354 | 3 built by the build system rather than support of the version provided | 2354 | 3 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 | ||
2365 | The :ref:`qemu <ref-classes-qemu>` class provides functionality for recipes that either need | 2365 | The :ref:`qemu <ref-classes-qemu>` class provides functionality for recipes that either need |
2366 | QEMU or test for the existence of QEMU. Typically, this class is used to | 2366 | QEMU 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 | ||
2375 | The :ref:`recipe_sanity <ref-classes-recipe_sanity>` class checks for the presence of any host system | 2375 | The :ref:`recipe_sanity <ref-classes-recipe_sanity>` class checks for the presence of any host system |
2376 | recipe prerequisites that might affect the build (e.g. variables that | 2376 | recipe 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 | ||
2384 | The :ref:`relocatable <ref-classes-relocatable>` class enables relocation of binaries when they are | 2384 | The :ref:`relocatable <ref-classes-relocatable>` class enables relocation of binaries when they are |
2385 | installed into the sysroot. | 2385 | installed 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 | ||
2396 | The :ref:`remove-libtool <ref-classes-remove-libtool>` class adds a post function to the | 2396 | The :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 | ||
2415 | The :ref:`report-error <ref-classes-report-error>` class supports enabling the :ref:`error reporting | 2415 | The :ref:`report-error <ref-classes-report-error>` class supports enabling the :ref:`error reporting |
2416 | tool <dev-manual/error-reporting-tool:using the error reporting tool>`", | 2416 | tool <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 | ||
2430 | The :ref:`rm_work <ref-classes-rm-work>` class supports deletion of temporary workspace, which | 2430 | The :ref:`rm_work <ref-classes-rm-work>` class supports deletion of temporary workspace, which |
2431 | can ease your hard drive demands during builds. | 2431 | can ease your hard drive demands during builds. |
@@ -2454,8 +2454,8 @@ can also be set in your ``local.conf`` file. Here is an example:: | |||
2454 | 2454 | ||
2455 | .. _ref-classes-rootfs*: | 2455 | .. _ref-classes-rootfs*: |
2456 | 2456 | ||
2457 | ``rootfs*.bbclass`` | 2457 | ``rootfs*`` |
2458 | =================== | 2458 | =========== |
2459 | 2459 | ||
2460 | The :ref:`rootfs* <ref-classes-rootfs*>` classes support creating the root filesystem for an | 2460 | The :ref:`rootfs* <ref-classes-rootfs*>` classes support creating the root filesystem for an |
2461 | image and consist of the following classes: | 2461 | image 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 | ||
2491 | The :ref:`sanity <ref-classes-sanity>` class checks to see if prerequisite software is present | 2491 | The :ref:`sanity <ref-classes-sanity>` class checks to see if prerequisite software is present |
2492 | on the host system so that users can be notified of potential problems | 2492 | on 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 | ||
2503 | The :ref:`scons <ref-classes-scons>` class supports recipes that need to build software that | 2503 | The :ref:`scons <ref-classes-scons>` class supports recipes that need to build software that |
2504 | uses the SCons build system. You can use the | 2504 | uses 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 | ||
2513 | The :ref:`sdl <ref-classes-sdl>` class supports recipes that need to build software that uses | 2513 | The :ref:`sdl <ref-classes-sdl>` class supports recipes that need to build software that uses |
2514 | the Simple DirectMedia Layer (SDL) library. | 2514 | the 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 | ||
2521 | The :ref:`python_setuptools_build_meta <ref-classes-python_setuptools_build_meta>` class enables building Python modules which | 2521 | The :ref:`python_setuptools_build_meta <ref-classes-python_setuptools_build_meta>` class enables building Python modules which |
2522 | declare the | 2522 | declare 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 | ||
2537 | The :ref:`setuptools3 <ref-classes-setuptools3>` class supports Python version 3.x extensions that | 2537 | The :ref:`setuptools3 <ref-classes-setuptools3>` class supports Python version 3.x extensions that |
2538 | use build systems based on ``setuptools`` (e.g. only have a ``setup.py`` and | 2538 | use build systems based on ``setuptools`` (e.g. only have a ``setup.py`` and |
@@ -2561,8 +2561,8 @@ uses these build systems, the recipe needs to inherit the :ref:`setuptools3 <ref | |||
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 | ||
2567 | The :ref:`setuptools3_legacy <ref-classes-setuptools3_legacy>` class supports | 2567 | The :ref:`setuptools3_legacy <ref-classes-setuptools3_legacy>` class supports |
2568 | Python version 3.x extensions that use build systems based on ``setuptools`` | 2568 | Python 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 | ||
2581 | The :ref:`setuptools3-base <ref-classes-setuptools3-base>` class provides a reusable base for other classes | 2581 | The :ref:`setuptools3-base <ref-classes-setuptools3-base>` class provides a reusable base for other classes |
2582 | that support building Python version 3.x extensions. If you need | 2582 | that support building Python version 3.x extensions. If you need |
@@ -2586,15 +2586,15 @@ in the :ref:`setuptools3 <ref-classes-setuptools3>` class and inherit this class | |||
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 | ||
2592 | The :ref:`sign_rpm <ref-classes-sign_rpm>` class supports generating signed RPM packages. | 2592 | The :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 | ||
2599 | The :ref:`siteconfig <ref-classes-siteconfig>` class provides functionality for handling site | 2599 | The :ref:`siteconfig <ref-classes-siteconfig>` class provides functionality for handling site |
2600 | configuration. The class is used by the | 2600 | configuration. 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 | ||
2609 | The :ref:`siteinfo <ref-classes-siteinfo>` class provides information about the targets that might | 2609 | The :ref:`siteinfo <ref-classes-siteinfo>` class provides information about the targets that might |
2610 | be needed by other classes or recipes. | 2610 | be 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 | ||
2630 | The :ref:`sstate <ref-classes-sstate>` class provides support for Shared State (sstate). By | 2630 | The :ref:`sstate <ref-classes-sstate>` class provides support for Shared State (sstate). By |
2631 | default, the class is enabled through the | 2631 | default, 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 | ||
2643 | The :ref:`staging <ref-classes-staging>` class installs files into individual recipe work | 2643 | The :ref:`staging <ref-classes-staging>` class installs files into individual recipe work |
2644 | directories for sysroots. The class contains the following key tasks: | 2644 | directories 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 | ||
2743 | The :ref:`syslinux <ref-classes-syslinux>` class provides syslinux-specific functions for building | 2743 | The :ref:`syslinux <ref-classes-syslinux>` class provides syslinux-specific functions for building |
2744 | bootable images. | 2744 | bootable 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 | ||
2786 | The :ref:`systemd <ref-classes-systemd>` class provides support for recipes that install systemd | 2786 | The :ref:`systemd <ref-classes-systemd>` class provides support for recipes that install systemd |
2787 | unit files. | 2787 | unit 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 | ||
2821 | The :ref:`systemd-boot <ref-classes-systemd-boot>` class provides functions specific to the | 2821 | The :ref:`systemd-boot <ref-classes-systemd-boot>` class provides functions specific to the |
2822 | systemd-boot bootloader for building bootable images. This is an | 2822 | systemd-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 | ||
2848 | The :ref:`terminal <ref-classes-terminal>` class provides support for starting a terminal session. | 2848 | The :ref:`terminal <ref-classes-terminal>` class provides support for starting a terminal session. |
2849 | The :term:`OE_TERMINAL` variable controls which | 2849 | The :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 | ||
2865 | The :ref:`testimage <ref-classes-testimage>` class supports running automated tests against | 2865 | The :ref:`testimage <ref-classes-testimage>` class supports running automated tests against |
2866 | images using QEMU and on actual hardware. The classes handle loading the | 2866 | images 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 | ||
2896 | This class supports running automated tests against software development | 2896 | This class supports running automated tests against software development |
2897 | kits (SDKs). The :ref:`testsdk <ref-classes-testsdk>` class runs tests on an SDK when called | 2897 | kits (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 | ||
2913 | This class should be inherited by recipes whose upstream packages invoke | 2913 | This class should be inherited by recipes whose upstream packages invoke |
2914 | the ``texinfo`` utilities at build-time. Native and cross recipes are | 2914 | the ``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 | ||
2931 | The :ref:`toaster <ref-classes-toaster>` class collects information about packages and images and | 2931 | The :ref:`toaster <ref-classes-toaster>` class collects information about packages and images and |
2932 | sends them as events that the BitBake user interface can receive. The | 2932 | sends them as events that the BitBake user interface can receive. The |
@@ -2936,16 +2936,16 @@ This class is not intended to be used directly. | |||
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 | ||
2942 | The :ref:`toolchain-scripts <ref-classes-toolchain-scripts>` class provides the scripts used for setting up | 2942 | The :ref:`toolchain-scripts <ref-classes-toolchain-scripts>` class provides the scripts used for setting up |
2943 | the environment for installed SDKs. | 2943 | the 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 | ||
2950 | The :ref:`typecheck <ref-classes-typecheck>` class provides support for validating the values of | 2950 | The :ref:`typecheck <ref-classes-typecheck>` class provides support for validating the values of |
2951 | variables set at the configuration level against their defined types. | 2951 | variables 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 | ||
2962 | The :ref:`uboot-config <ref-classes-uboot-config>` class provides support for U-Boot configuration for | 2962 | The :ref:`uboot-config <ref-classes-uboot-config>` class provides support for U-Boot configuration for |
2963 | a machine. Specify the machine in your recipe as follows:: | 2963 | a 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 | ||
2980 | Attempts to isolate the build system from the host distribution's C | 2980 | Attempts to isolate the build system from the host distribution's C |
2981 | library in order to make re-use of native shared state artifacts across | 2981 | library in order to make re-use of native shared state artifacts across |
@@ -2996,8 +2996,8 @@ and the resulting tarball is included within the SDK. | |||
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 | ||
3002 | The :ref:`update-alternatives <ref-classes-update-alternatives>` class helps the alternatives system when | 3002 | The :ref:`update-alternatives <ref-classes-update-alternatives>` class helps the alternatives system when |
3003 | multiple sources provide the same command. This situation occurs when | 3003 | multiple 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 | ||
3040 | The :ref:`update-rc.d <ref-classes-update-rc.d>` class uses ``update-rc.d`` to safely install an | 3040 | The :ref:`update-rc.d <ref-classes-update-rc.d>` class uses ``update-rc.d`` to safely install an |
3041 | initialization script on behalf of the package. The OpenEmbedded build | 3041 | initialization 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 | ||
3054 | The :ref:`useradd* <ref-classes-useradd>` classes support the addition of users or groups for | 3054 | The :ref:`useradd* <ref-classes-useradd>` classes support the addition of users or groups for |
3055 | usage by the package on the target. For example, if you have packages | 3055 | usage 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 | ||
3109 | The :ref:`utility-tasks <ref-classes-utility-tasks>` class provides support for various "utility" type | 3109 | The :ref:`utility-tasks <ref-classes-utility-tasks>` class provides support for various "utility" type |
3110 | tasks that are applicable to all recipes, such as | 3110 | tasks that are applicable to all recipes, such as |
@@ -3116,8 +3116,8 @@ This class is enabled by default because it is inherited by the | |||
3116 | 3116 | ||
3117 | .. _ref-classes-utils: | 3117 | .. _ref-classes-utils: |
3118 | 3118 | ||
3119 | ``utils.bbclass`` | 3119 | ``utils`` |
3120 | ================= | 3120 | ========= |
3121 | 3121 | ||
3122 | The :ref:`utils <ref-classes-utils>` class provides some useful Python functions that are | 3122 | The :ref:`utils <ref-classes-utils>` class provides some useful Python functions that are |
3123 | typically used in inline Python expressions (e.g. ``${@...}``). One | 3123 | typically used in inline Python expressions (e.g. ``${@...}``). One |
@@ -3128,16 +3128,16 @@ This class is enabled by default because it is inherited by the | |||
3128 | 3128 | ||
3129 | .. _ref-classes-vala: | 3129 | .. _ref-classes-vala: |
3130 | 3130 | ||
3131 | ``vala.bbclass`` | 3131 | ``vala`` |
3132 | ================ | 3132 | ======== |
3133 | 3133 | ||
3134 | The :ref:`vala <ref-classes-vala>` class supports recipes that need to build software written | 3134 | The :ref:`vala <ref-classes-vala>` class supports recipes that need to build software written |
3135 | using the Vala programming language. | 3135 | using 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 | ||
3142 | The :ref:`waf <ref-classes-waf>` class supports recipes that need to build software that uses | 3142 | The :ref:`waf <ref-classes-waf>` class supports recipes that need to build software that uses |
3143 | the Waf build system. You can use the | 3143 | the Waf build system. You can use the |