summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2018-10-30 12:14:55 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2018-11-22 12:20:51 +0000
commit53fa948ae3793e7030eec61ca3d95ed0858466b0 (patch)
treefdfed186044413f2324a6568e3162fb84f99cec9 /documentation/ref-manual
parent01c64b6aa1883419cf0987771136c03fc0e35957 (diff)
downloadopenembedded-core-contrib-53fa948ae3793e7030eec61ca3d95ed0858466b0.tar.gz
ref-manual: Updated testimage and testsdk class descriptions.
I added notes indicating that the best practice for automated testing is to inherit these classes by using the IMAGE_CLASSES variable instead of the INHERIT variable. (From yocto-docs rev: 8f4765db897c20f0011ea65f62d6b45495d313d2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-classes.xml16
1 files changed, 16 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index d2f5c3ebc1..4cbb9c30c0 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -3502,6 +3502,14 @@ This check was removed for YP 2.3 release
The classes handle loading the tests and starting the image.
To use the classes, you need to perform steps to set up the
environment.
+ <note><title>Tip</title>
+ Best practices include using
+ <link linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link>
+ rather than
+ <link linkend='var-INHERIT'><filename>INHERIT</filename></link> to
+ inherit the <filename>testimage</filename> class for automated
+ image testing.
+ </note>
</para>
<para>
@@ -3541,6 +3549,14 @@ This check was removed for YP 2.3 release
<literallayout class='monospaced'>
$ bitbake -c testsdk image
</literallayout>
+ <note><title>Tip</title>
+ Best practices include using
+ <link linkend='var-IMAGE_CLASSES'><filename>IMAGE_CLASSES</filename></link>
+ rather than
+ <link linkend='var-INHERIT'><filename>INHERIT</filename></link> to
+ inherit the <filename>testsdk</filename> class for automated
+ SDK testing.
+ </note>
</para>
</section>