diff options
| -rw-r--r-- | documentation/dev-manual/dev-manual-common-tasks.xml | 7 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-classes.xml | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-tasks.xml | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/ref-variables.xml | 76 |
4 files changed, 46 insertions, 41 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml index 25f0fab1ac..cee1d40ab4 100644 --- a/documentation/dev-manual/dev-manual-common-tasks.xml +++ b/documentation/dev-manual/dev-manual-common-tasks.xml @@ -11798,16 +11798,15 @@ To run the tests automatically after the OpenEmbedded build system successfully creates an image, first set the - <ulink url='&YOCTO_DOCS_REF_URL;#var-TEST_IMAGE'><filename>TEST_IMAGE</filename></ulink> + <ulink url='&YOCTO_DOCS_REF_URL;#var-TESTIMAGE_AUTO'><filename>TESTIMAGE_AUTO</filename></ulink> variable to "1" in your <filename>local.conf</filename> file in the <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>: <literallayout class='monospaced'> - TEST_IMAGE = "1" + TESTIMAGE_AUTO = "1" </literallayout> Next, build your image. - If the image successfully builds, the tests will be - run: + If the image successfully builds, the tests run: <literallayout class='monospaced'> bitbake core-image-sato </literallayout></para></listitem> diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 24d7a0a99e..d2f5c3ebc1 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -3519,7 +3519,7 @@ This check was removed for YP 2.3 release </literallayout> The <filename>testimage-auto</filename> class runs tests on an image after the image is constructed (i.e. - <link linkend='var-TEST_IMAGE'><filename>TEST_IMAGE</filename></link> + <link linkend='var-TESTIMAGE_AUTO'><filename>TESTIMAGE_AUTO</filename></link> must be set to "1"). </para> diff --git a/documentation/ref-manual/ref-tasks.xml b/documentation/ref-manual/ref-tasks.xml index ccd0f85cfd..8f3ff26d24 100644 --- a/documentation/ref-manual/ref-tasks.xml +++ b/documentation/ref-manual/ref-tasks.xml @@ -886,7 +886,7 @@ Boots an image and performs runtime tests within the image immediately after it has been built. This task is enabled when you set - <link linkend='var-TEST_IMAGE'><filename>TEST_IMAGE</filename></link> + <link linkend='var-TESTIMAGE_AUTO'><filename>TESTIMAGE_AUTO</filename></link> equal to "1". </para> 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" </glossdef> </glossentry> - <glossentry id='var-TEST_IMAGE'><glossterm>TEST_IMAGE</glossterm> - <info> - 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." - </info> - <glossdef> - <para role="glossdeffirst"> -<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> - Automatically runs the series of automated tests for - images when an image is successfully built. - </para> - - <para> - These tests are written in Python making use of the - <filename>unittest</filename> module, and the majority of - them run commands on the target system over - <filename>ssh</filename>. - You can set this variable to "1" in your - <filename>local.conf</filename> file in the - <link linkend='build-directory'>Build Directory</link> - to have the OpenEmbedded build system automatically run - these tests after an image successfully builds: - <literallayout class='monospaced'> - TEST_IMAGE = "1" - </literallayout> - For more information on enabling, running, and writing - these tests, see the - "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" - section in the Yocto Project Development Tasks Manual and - the - "<link linkend='ref-classes-testimage*'><filename>testimage*.bbclass</filename></link>" - section. - </para> - </glossdef> - </glossentry> - <glossentry id='var-TEST_LOG_DIR'><glossterm>TEST_LOG_DIR</glossterm> <info> 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" </glossdef> </glossentry> + <glossentry id='var-TESTIMAGE_AUTO'><glossterm>TESTIMAGE_AUTO</glossterm> + <info> + TESTIMAGE_AUTO[doc] = "Enables automatic testing of an image once it is built." + </info> + <glossdef> + <para role="glossdeffirst"> +<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> + Automatically runs the series of automated tests for + images when an image is successfully built. + Setting <filename>TESTIMAGE_AUTO</filename> to "1" + causes any image that successfully builds to automatically + boot under QEMU. + Using the variable also adds in dependencies so that any + SDK for which testing is requested is automatically built + first. + </para> + + <para> + These tests are written in Python making use of the + <filename>unittest</filename> module, and the majority of + them run commands on the target system over + <filename>ssh</filename>. + You can set this variable to "1" in your + <filename>local.conf</filename> file in the + <link linkend='build-directory'>Build Directory</link> + to have the OpenEmbedded build system automatically run + these tests after an image successfully builds: + <literallayout class='monospaced'> + TESTIMAGE_AUTO = "1" + </literallayout> + For more information on enabling, running, and writing + these tests, see the + "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" + section in the Yocto Project Development Tasks Manual and + the + "<link linkend='ref-classes-testimage*'><filename>testimage*.bbclass</filename></link>" + section. + </para> + </glossdef> + </glossentry> + <glossentry id='var-THISDIR'><glossterm>THISDIR</glossterm> <info> THISDIR[doc] = "The directory in which the file BitBake is currently parsing is located." |