diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 30d0e5de06..daedf8becc 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -111,7 +111,9 @@ The autoconf, automake, and libtool bring standardization. - This class defines a set of tasks (configure, compile etc.) that + This class defines a set of tasks (e.g. + configure, compile and + so forth) that work for all Autotooled packages. It should usually be enough to define a few standard variables and then simply inherit autotools. @@ -133,8 +135,8 @@ - It's useful to have some idea of how the tasks defined by this class work - and what they do behind the scenes. + It's useful to have some idea of how the tasks defined by this class + work and what they do behind the scenes. do_configure - Regenerates the @@ -157,6 +159,68 @@ +
+ <filename>autotools_stage.bbclass</filename> + + + The autotools_stage class supports Autotooled + packages. + + + + The autoconf, + automake, and libtool + bring standardization. + This class defines a set of tasks + (e.g. configure, compile + and so forth) that work for all Autotooled packages. + It is usually enough to define a few standard variables and then + simply inherit autotools. + This class can also work with software that emulates Autotools. + For more information, see the + "Autotooled Package" + section in the Yocto Project Development Manual. + + + + By default, the autotools-stage class uses + out-of-tree builds + (B != + S). + If the software being built by a recipe does not support + using out-of-tree builds, you should have the recipe inherit the + autotools-brokensep + class. + + + + It is useful to have some idea of how the tasks defined by this + class work and what they do behind the scenes. + + do_configure - + Regenerates the configure script (using + autoreconf) and then launches it + with a standard set of arguments used during cross-compilation. + You can pass additional parameters to + configure through the + EXTRA_OECONF variable. + + do_compile - + Runs make with arguments that specify + the compiler and linker. + You can pass additional arguments through the + EXTRA_OEMAKE + variable. + + do_install - + Runs make install and passes in + ${D} + as DESTDIR. + + + +
+
<filename>autotools-brokensep.bbclass</filename> @@ -560,10 +624,10 @@
- <filename>cpan.bbclass</filename> + <filename>cpan*.bbclass</filename> - The cpan class supports Perl modules. + The cpan* classes support Perl modules. @@ -582,6 +646,8 @@ using cpan_build.bbclass in their recipes. + Both build methods inherit the cpan-base class + for basic Perl support.
@@ -725,10 +791,10 @@
- <filename>distutils.bbclass</filename> + <filename>distutils-*.bbclass</filename> - The distutils class supports recipes for Python + The distutils-* classes support recipes for Python version 2.x extensions, which are simple. These recipes usually only need to point to the source's archive and then inherit the proper class. @@ -736,12 +802,12 @@ module authors used. Extensions that use an Autotools-based build system - require Autotools and - distutils-based classes in their recipes. + require Autotools and the classes based on + distutils in their recipes. Extensions that use build systems based on distutils require - the distutils class in their recipes. + the distutils-* classes in their recipes. Extensions that use build systems based on setuptools require the @@ -749,18 +815,23 @@ class in their recipes. + The distutils-common-base class is required by + some of the distutils-* classes to provide common + Python2 support. + The distutils-tools class supports recipes for + additional "distutils" tools.
- <filename>distutils3.bbclass</filename> + <filename>distutils3*.bbclass</filename> The distutils3 class supports recipes for Python version 3.x extensions, which are simple. These recipes usually only need to point to the source's archive and then inherit the proper class. - Building is split into two methods depending on which method the + Building is split into three methods depending on which method the module authors used. Extensions that use an Autotools-based build system @@ -777,6 +848,14 @@ class in their recipes. + The distutils3* classes either inherit their + corresponding distutils* class or replicate them + using a Python3 version instead (e.g. + distutils3-base inherits + distutils-common-base, which is the same as + distutils-base but inherits + python3native instead of + pythonnative).
@@ -908,6 +987,19 @@
+
+ <filename>fs-uuid.bbclass</filename> + + + The fs-uuid class extracts UUID from + ${ROOTFS}, + which must have been built by the time that this function gets called. + The fs-uuid class only works on + ext file systems and depends on + tune2fs. + +
+
<filename>gconf.bbclass</filename> @@ -1258,6 +1350,15 @@
+
+ <filename>image-buildinfo.bbclass</filename> + + + The image-buildinfo class writes information + to the target filesystem on /etc/build. + +
+
<filename>image_types.bbclass</filename> @@ -1371,6 +1472,15 @@
+
+ <filename>image-vm.bbclass</filename> + + + The image-vm class supports building VM + images. + +
+
<filename>image-vmdk.bbclass</filename> @@ -1871,6 +1981,25 @@
+
+ <filename>kernel-fitimage.bbclass</filename> + + + The kernel-fitimage class provides support to + pack zImages. + +
+ +
+ <filename>kernel-grub.bbclass</filename> + + + The kernel-grub class updates the boot area and + the boot menu with the kernel as the priority boot mechanism while + installing a RPM to update the kernel on a deployed target. + +
+
<filename>kernel-module-split.bbclass</filename> @@ -1881,6 +2010,24 @@
+
+ <filename>kernel-uboot.bbclass</filename> + + + The kernel-uboot class provides support for + building from vmlinux-style kernel sources. + +
+ +
+ <filename>kernel-uimage.bbclass</filename> + + + The kernel-uimage class provides support to + pack uImage. + +
+
<filename>kernel-yocto.bbclass</filename> @@ -1891,6 +2038,15 @@
+
+ <filename>kernelsrc.bbclass</filename> + + + The kernelsrc class sets the Linux kernel + source and version. + +
+
<filename>lib_package.bbclass</filename> @@ -1905,6 +2061,25 @@
+
+ <filename>libc*.bbclass</filename> + + + The libc* classes support recipes that build + packages with libc: + + The libc-common class + provides common support for building with + libc. + + The libc-package class + supports packaging up glibc and + eglibc. + + + +
+
<filename>license.bbclass</filename> @@ -1984,6 +2159,15 @@
+
+ <filename>migrate_localcount.bbclass</filename> + + + The migrate_localcount class verifies a recipe's + localcount data and increments it appropriately. + +
+
<filename>mime.bbclass</filename> @@ -2549,6 +2733,9 @@ Supports creation of the SDK given the opkg (IPK format) package manager. + populate_sdk_ext: + Supports extensible SDK creation under all package managers. + @@ -2705,6 +2892,16 @@
+
+ <filename>python3native.bbclass</filename> + + + The python3native class supports using the + native version of Python 3 built by the build system rather than + support of the version provided by the build host. + +
+
<filename>pythonnative.bbclass</filename> @@ -2786,6 +2983,16 @@
+
+ <filename>recipe_sanity.bbclass</filename> + + + The recipe_sanity class checks for the presence + of any host system recipe prerequisites that might affect the + build (e.g. variables that are set or software that is present). + +
+
<filename>relocatable.bbclass</filename> @@ -2961,6 +3168,16 @@
+
+ <filename>sign_rpm.bbclass</filename> + + + The sign_rpm class + The sign_rpm class supports generating signed + RPM packages. + +
+
<filename>sip.bbclass</filename> @@ -3219,6 +3436,40 @@
+
+ <filename>testimage*.bbclass</filename> + + + The testimage* classes support running + automated tests against images using QEMU and on actual hardware. + The classes handle loading the tests and starting the image. + To use the classes, you need to perform steps to set up the + environment. + + + + The tests are commands that run on the target system over + ssh. + Each test is written in Python and makes use of the + unittest module. + + + + The testimage.bbclass runs tests on an image + when called using the following: + + $ bitbake -c testimage image + + Tests run automatically on an image after the image is constructed + (i.e. + TEST_IMAGE + must be set to "1"). + For information on how to enable, run, and create new tests, see the + "Performing Automated Runtime Testing" + section in the Yocto Project Development Manual. + +
+
<filename>texinfo.bbclass</filename> @@ -3398,10 +3649,10 @@
- <filename>useradd.bbclass</filename> + <filename>useradd*.bbclass</filename> - The useradd class supports the addition of users + The useradd* classes support the addition of users or groups for usage by the package on the target. For example, if you have packages that contain system services that should be run under their own user or group, you can use this class to @@ -3415,7 +3666,12 @@ - The useradd class supports the + The useradd_base class provides basic + functionality for user or groups settings. + + + + The useradd* classes support the USERADD_PACKAGES, USERADD_PARAM, GROUPADD_PARAM,