diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 534f578b89..44b046d965 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -8583,7 +8583,7 @@
Manually running tests:
To manually run the tests, first globally inherit the
- testimage
+ testimage
class by editing your local.conf
file:
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml
index 27f674ae2f..45dcd9b3cf 100644
--- a/documentation/ref-manual/closer-look.xml
+++ b/documentation/ref-manual/closer-look.xml
@@ -1059,7 +1059,7 @@
the root filesystem image that lists out, line-by-line, the
installed packages.
This manifest file is useful for the
- testimage
+ testimage
class, for example, to determine whether or not to run
specific tests.
See the
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index dc75eb827b..4d798bc283 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -980,7 +980,7 @@
A new automated image testing framework has been added
through the
- testimage*.bbclass
+ testimage.bbclass
class.
This framework replaces the older
imagetest-qemu framework.
@@ -1485,8 +1485,9 @@
Recipes building Autotools-based
software that fails to build with a separate build directory
should be changed to inherit from the
- autotools-brokensep
- class instead of the autotools class.
+ autotools-brokensep
+ class instead of the autotools or
+ autotools_stageclasses.
@@ -1794,8 +1795,9 @@
need to either patch the software so that it can build
separately, or you will need to change the recipe to
inherit the
- autotools-brokensep
- class instead of the autotools class.
+ autotools-brokensep
+ class instead of the autotools or
+ autotools_stage classes.
The --foreign option is
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,134 +101,44 @@
- autotools.bbclass
+ autotools*.bbclass
- 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.
-
-
-
-
-
-
- autotools_stage.bbclass
-
-
- 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.
-
-
-
-
-
-
- autotools-brokensep.bbclass
-
-
+ autotools-brokensep class.
The autotools-brokensep class behaves the same
- as the
- autotools
- class but builds with
+ 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
@@ -238,6 +148,34 @@
if at all possible.
+
+
+ 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.
+ 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.
+
+
+
@@ -791,10 +729,10 @@
- distutils-*.bbclass
+ distutils*.bbclass
- 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 @@
distutils3*.bbclass
- 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 @@
sign_rpm.bbclass
- The sign_rpm class
The sign_rpm class supports generating signed
RPM packages.
@@ -3413,31 +3353,6 @@
-
- testimage.bbclass
-
-
- 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.
-
-
-
testimage*.bbclass
@@ -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.
-
-
-
- useradd-staticids.bbclass
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,
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 538936b43e..82410941c2 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -12935,7 +12935,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
these tests, see the
"Performing Automated Runtime Testing"
section in the Yocto Project Development Manual and the
- "testimage.bbclass"
+ "testimage*.bbclass"
section.
@@ -14314,7 +14314,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
uid and gid
values causes the OpenEmbedded build system to employ
the
- useradd-staticids
+ useradd-staticids
class.