ref-manual: Added a new entry for the testimage.bbclass.

(From yocto-docs rev: 05db9912f837d79c7da3411586248dcc78172985)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 5d1e3ed1b4c3a469e51cbbe6b79656032db09c5e..5870d0f44a361b40b35257694c2659f98137d8ef 100644 (file)
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -935,6 +935,33 @@
     </para>
 </section>
 
+<section id='ref-classes-testimage'>
+    <title><filename>testimage.bbclass</filename></title>
+
+    <para>
+        You can use this class to enable running a series of automated tests
+        for QEMU images.
+        The class handles loading the tests and starting the QEMU image.
+    </para>
+
+    <para>
+        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
+        <filename>ssh</filename>.
+        they are written in Python and make use of the
+        <filename>unittest modulebuild</filename> software.
+    </para>
+
+    <para>
+        For information on how to enable, run, and create new tests, see the
+        "<ulink url='running-and-writing-tests-for-a-qemu-image'>Running and Writing Tests for a QEMU Image</ulink>"
+        section and the
+        <ulink url='https://wiki.yoctoproject.org/wiki/Image_tests'>Image Tests</ulink>
+        Wiki page.
+    </para>
+</section>
+
 <section id='ref-classes-others'>
     <title>Other Classes</title>