From 2fe38094657df6564e4f548d376d86678e57b768 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 13 Oct 2015 10:00:54 -0700 Subject: ref-manual, dev-manual: Applied feedback to edit several classes Fixes [YOCTO #8298] Updated several classes with feedback from Jose Lamego of Intel. The feedback fixed some class groupings so that previously isolated classes could be bundled under common classes (e.g. autotools*.bbclass). I scrubbed the cross-references for cases where a particular class became "undocumented." The cross-references now point to the bundled class entry in the ref-manual. (From yocto-docs rev: 07a533cb41ad26d202f4e303f2dbc7d7bf26e076) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-classes.xml | 183 +++++++++---------------------- 1 file changed, 49 insertions(+), 134 deletions(-) (limited to 'documentation/ref-manual/ref-classes.xml') diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 647c67f2ba..1b7ab94801 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -101,116 +101,73 @@
- <filename>autotools.bbclass</filename> + <filename>autotools*.bbclass</filename> - The autotools class supports Autotooled + The autotools* classes support Autotooled packages. The autoconf, automake, - and libtool bring standardization. + and libtool packages bring standardization. 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. - This class can also work with software that emulates Autotools. + These classes 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 class - uses out-of-tree builds + By default, the autotools* classes + use out-of-tree builds (i.e. + autotools.bbclass and + autotools_stage.bbclass). (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'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 - 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_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. + autotools-brokensep class. + The autotools-brokensep class behaves the same + as the autotools and + autotools_stage classes but builds with + B == + S. + This method is useful when out-of-tree build support is either not + present or is broken. + + It is recommended that out-of-tree support be fixed and used + if at all possible. + - It is 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 + the autotools* classes 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. + 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. + 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 @@ -221,25 +178,6 @@
-
- <filename>autotools-brokensep.bbclass</filename> - - - The autotools-brokensep class behaves the same - as the - autotools - class but builds with - B == - S. - This method is useful when out-of-tree build support is either not - present or is broken. - - It is recommended that out-of-tree support be fixed and used - if at all possible. - - -
-
<filename>base.bbclass</filename> @@ -791,10 +729,10 @@
- <filename>distutils-*.bbclass</filename> + <filename>distutils*.bbclass</filename> - The distutils-* classes support 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. @@ -807,7 +745,7 @@ Extensions that use build systems based on distutils require - the distutils-* classes in their recipes. + the distutils class in their recipes. Extensions that use build systems based on setuptools require the @@ -816,8 +754,11 @@ The distutils-common-base class is required by - some of the distutils-* classes to provide common + some of the distutils* classes to provide common Python2 support. + + + The distutils-tools class supports recipes for additional "distutils" tools. @@ -827,7 +768,7 @@ <filename>distutils3*.bbclass</filename> - The distutils3 class supports recipes for Python + The distutils3* classes support 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. @@ -3174,7 +3115,6 @@ <filename>sign_rpm.bbclass</filename> - The sign_rpm class The sign_rpm class supports generating signed RPM packages. @@ -3413,31 +3353,6 @@
-
- <filename>testimage.bbclass</filename> - - - The testimage class supports running automated - tests against images using QEMU and on actual hardware. - The class handles loading the tests and starting the image. - - - - To use the class, you need to perform steps to set up the - environment. - The tests are commands that run on the target system over - ssh. - they are written in Python and make use of the - unittest module. - - - - For information on how to enable, run, and create new tests, see the - "Performing Automated Runtime Testing" - section. - -
-
<filename>testimage*.bbclass</filename> @@ -3462,10 +3377,13 @@ $ bitbake -c testimage image - Tests run automatically on an image after the image is constructed - (i.e. + The testimage-auto class runs tests 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. @@ -3657,14 +3575,14 @@ 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 - enable creation of the user or group. + should be run under their own user or group, you can use these classes + to enable creation of the user or group. The meta-skeleton/recipes-skeleton/useradd/useradd-example.bb recipe in the Source Directory provides a simple example that shows how to add three users and groups to two packages. See the useradd-example.bb recipe for more - information on how to use this class. + information on how to use these classes. @@ -3681,10 +3599,6 @@ GROUPMEMS_PARAM variables. -
- -
- <filename>useradd-staticids.bbclass</filename> The useradd-staticids class supports the addition @@ -3728,7 +3642,8 @@ Notes - You do not use this class directly. + You do not use the useradd-staticids + class directly. You either enable or disable the class by setting the USERADDEXTENSION variable. If you enable or disable the class in a configured system, -- cgit v1.2.3-54-g00ecf