summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/classes.rst17
-rw-r--r--documentation/ref-manual/release-process.rst2
-rw-r--r--documentation/ref-manual/variables.rst2
3 files changed, 11 insertions, 10 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 6462a86dad..f24c579f16 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2768,12 +2768,12 @@ session needs to be started. For example, the
2768:ref:`devshell <ref-classes-devshell>` class all use the ``terminal`` 2768:ref:`devshell <ref-classes-devshell>` class all use the ``terminal``
2769class. 2769class.
2770 2770
2771.. _ref-classes-testimage*: 2771.. _ref-classes-testimage:
2772 2772
2773``testimage*.bbclass`` 2773``testimage.bbclass``
2774====================== 2774=====================
2775 2775
2776The ``testimage*`` classes support running automated tests against 2776The ``testimage`` class supports running automated tests against
2777images using QEMU and on actual hardware. The classes handle loading the 2777images using QEMU and on actual hardware. The classes handle loading the
2778tests and starting the image. To use the classes, you need to perform 2778tests and starting the image. To use the classes, you need to perform
2779steps to set up the environment. 2779steps to set up the environment.
@@ -2787,14 +2787,15 @@ steps to set up the environment.
2787The tests are commands that run on the target system over ``ssh``. Each 2787The tests are commands that run on the target system over ``ssh``. Each
2788test is written in Python and makes use of the ``unittest`` module. 2788test is written in Python and makes use of the ``unittest`` module.
2789 2789
2790The ``testimage.bbclass`` runs tests on an image when called using the 2790The ``testimage`` class runs tests on an image when called using the
2791following:: 2791following::
2792 2792
2793 $ bitbake -c testimage image 2793 $ bitbake -c testimage image
2794 2794
2795The ``testimage-auto`` class 2795Alternatively, if you wish to have tests automatically run for each image
2796runs tests on an image after the image is constructed (i.e. 2796after it is built, you can set :term:`TESTIMAGE_AUTO`::
2797:term:`TESTIMAGE_AUTO` must be set to "1"). 2797
2798 TESTIMAGE_AUTO = "1"
2798 2799
2799For information on how to enable, run, and create new tests, see the 2800For information on how to enable, run, and create new tests, see the
2800":ref:`dev-manual/common-tasks:performing automated runtime testing`" 2801":ref:`dev-manual/common-tasks:performing automated runtime testing`"
diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst
index 8acb4b8e09..c36fa557d8 100644
--- a/documentation/ref-manual/release-process.rst
+++ b/documentation/ref-manual/release-process.rst
@@ -127,7 +127,7 @@ consists of the following pieces:
127 an ARM target, did the build produce ARM binaries. If, for example, 127 an ARM target, did the build produce ARM binaries. If, for example,
128 the build produced PPC binaries then there is a problem. 128 the build produced PPC binaries then there is a problem.
129 129
130- :ref:`ref-classes-testimage*`: This class 130- :ref:`ref-classes-testimage`: This class
131 performs runtime testing of images after they are built. The tests 131 performs runtime testing of images after they are built. The tests
132 are usually used with :doc:`QEMU </dev-manual/qemu>` 132 are usually used with :doc:`QEMU </dev-manual/qemu>`
133 to boot the images and check the combined runtime result boot 133 to boot the images and check the combined runtime result boot
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index f77b8ac1e9..5c75dac0fe 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -8300,7 +8300,7 @@ system and gives an overview of their function and contents.
8300 on enabling, running, and writing these tests, see the 8300 on enabling, running, and writing these tests, see the
8301 ":ref:`dev-manual/common-tasks:performing automated runtime testing`" 8301 ":ref:`dev-manual/common-tasks:performing automated runtime testing`"
8302 section in the Yocto Project Development Tasks Manual and the 8302 section in the Yocto Project Development Tasks Manual and the
8303 ":ref:`ref-classes-testimage*`" section. 8303 ":ref:`ref-classes-testimage`" section.
8304 8304
8305 :term:`THISDIR` 8305 :term:`THISDIR`
8306 The directory in which the file BitBake is currently parsing is 8306 The directory in which the file BitBake is currently parsing is