summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r--documentation/ref-manual/ref-variables.xml76
1 files changed, 41 insertions, 35 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 595f2db8b0..c3e36c90cf 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -15195,41 +15195,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
15195 </glossdef> 15195 </glossdef>
15196 </glossentry> 15196 </glossentry>
15197 15197
15198 <glossentry id='var-TEST_IMAGE'><glossterm>TEST_IMAGE</glossterm>
15199 <info>
15200 TEST_IMAGE[doc] = "Enables test booting of virtual machine images under the QEMU emulator after any root filesystems are created and runs tests against those images."
15201 </info>
15202 <glossdef>
15203 <para role="glossdeffirst">
15204<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
15205 Automatically runs the series of automated tests for
15206 images when an image is successfully built.
15207 </para>
15208
15209 <para>
15210 These tests are written in Python making use of the
15211 <filename>unittest</filename> module, and the majority of
15212 them run commands on the target system over
15213 <filename>ssh</filename>.
15214 You can set this variable to "1" in your
15215 <filename>local.conf</filename> file in the
15216 <link linkend='build-directory'>Build Directory</link>
15217 to have the OpenEmbedded build system automatically run
15218 these tests after an image successfully builds:
15219 <literallayout class='monospaced'>
15220 TEST_IMAGE = "1"
15221 </literallayout>
15222 For more information on enabling, running, and writing
15223 these tests, see the
15224 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
15225 section in the Yocto Project Development Tasks Manual and
15226 the
15227 "<link linkend='ref-classes-testimage*'><filename>testimage*.bbclass</filename></link>"
15228 section.
15229 </para>
15230 </glossdef>
15231 </glossentry>
15232
15233 <glossentry id='var-TEST_LOG_DIR'><glossterm>TEST_LOG_DIR</glossterm> 15198 <glossentry id='var-TEST_LOG_DIR'><glossterm>TEST_LOG_DIR</glossterm>
15234 <info> 15199 <info>
15235 TEST_LOG_DIR[doc] = "Holds the SSH log and the boot log for QEMU machines. The TEST_LOG_DIR variable defaults to "${WORKDIR}/testimage"." 15200 TEST_LOG_DIR[doc] = "Holds the SSH log and the boot log for QEMU machines. The TEST_LOG_DIR variable defaults to "${WORKDIR}/testimage"."
@@ -15530,6 +15495,47 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
15530 </glossdef> 15495 </glossdef>
15531 </glossentry> 15496 </glossentry>
15532 15497
15498 <glossentry id='var-TESTIMAGE_AUTO'><glossterm>TESTIMAGE_AUTO</glossterm>
15499 <info>
15500 TESTIMAGE_AUTO[doc] = "Enables automatic testing of an image once it is built."
15501 </info>
15502 <glossdef>
15503 <para role="glossdeffirst">
15504<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
15505 Automatically runs the series of automated tests for
15506 images when an image is successfully built.
15507 Setting <filename>TESTIMAGE_AUTO</filename> to "1"
15508 causes any image that successfully builds to automatically
15509 boot under QEMU.
15510 Using the variable also adds in dependencies so that any
15511 SDK for which testing is requested is automatically built
15512 first.
15513 </para>
15514
15515 <para>
15516 These tests are written in Python making use of the
15517 <filename>unittest</filename> module, and the majority of
15518 them run commands on the target system over
15519 <filename>ssh</filename>.
15520 You can set this variable to "1" in your
15521 <filename>local.conf</filename> file in the
15522 <link linkend='build-directory'>Build Directory</link>
15523 to have the OpenEmbedded build system automatically run
15524 these tests after an image successfully builds:
15525 <literallayout class='monospaced'>
15526 TESTIMAGE_AUTO = "1"
15527 </literallayout>
15528 For more information on enabling, running, and writing
15529 these tests, see the
15530 "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>"
15531 section in the Yocto Project Development Tasks Manual and
15532 the
15533 "<link linkend='ref-classes-testimage*'><filename>testimage*.bbclass</filename></link>"
15534 section.
15535 </para>
15536 </glossdef>
15537 </glossentry>
15538
15533 <glossentry id='var-THISDIR'><glossterm>THISDIR</glossterm> 15539 <glossentry id='var-THISDIR'><glossterm>THISDIR</glossterm>
15534 <info> 15540 <info>
15535 THISDIR[doc] = "The directory in which the file BitBake is currently parsing is located." 15541 THISDIR[doc] = "The directory in which the file BitBake is currently parsing is located."