From 400d491e8d9d2ac0623fe491c3795af3e12a1621 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 30 Oct 2018 11:41:37 -0700 Subject: ref-manual, dev-manual: Removed TEST_IMAGE for TESTIMAGE_AUTO. The TEST_IMAGE variable went away and was replaced with the TESTIMAGE_AUTO variable. Fixed all related/affected areas. (From yocto-docs rev: 84e2c149fa823ab6e12be17b049c9bae1c1dd904) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- .../dev-manual/dev-manual-common-tasks.xml | 7 +- documentation/ref-manual/ref-classes.xml | 2 +- documentation/ref-manual/ref-tasks.xml | 2 +- documentation/ref-manual/ref-variables.xml | 76 ++++++++++++---------- 4 files changed, 46 insertions(+), 41 deletions(-) (limited to 'documentation') 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 - TEST_IMAGE + TESTIMAGE_AUTO variable to "1" in your local.conf file in the Build Directory: - TEST_IMAGE = "1" + TESTIMAGE_AUTO = "1" Next, build your image. - If the image successfully builds, the tests will be - run: + If the image successfully builds, the tests run: bitbake core-image-sato 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 The testimage-auto class runs tests on an image after the image is constructed (i.e. - TEST_IMAGE + TESTIMAGE_AUTO must be set to "1"). 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 - TEST_IMAGE + TESTIMAGE_AUTO equal to "1". 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" - TEST_IMAGE - - 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." - - - - - Automatically runs the series of automated tests for - images when an image is successfully built. - - - - These tests are written in Python making use of the - unittest module, and the majority of - them run commands on the target system over - ssh. - You can set this variable to "1" in your - local.conf file in the - Build Directory - to have the OpenEmbedded build system automatically run - these tests after an image successfully builds: - - TEST_IMAGE = "1" - - For more information on enabling, running, and writing - these tests, see the - "Performing Automated Runtime Testing" - section in the Yocto Project Development Tasks Manual and - the - "testimage*.bbclass" - section. - - - - TEST_LOG_DIR 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" + TESTIMAGE_AUTO + + TESTIMAGE_AUTO[doc] = "Enables automatic testing of an image once it is built." + + + + + Automatically runs the series of automated tests for + images when an image is successfully built. + Setting TESTIMAGE_AUTO 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. + + + + These tests are written in Python making use of the + unittest module, and the majority of + them run commands on the target system over + ssh. + You can set this variable to "1" in your + local.conf file in the + Build Directory + to have the OpenEmbedded build system automatically run + these tests after an image successfully builds: + + TESTIMAGE_AUTO = "1" + + For more information on enabling, running, and writing + these tests, see the + "Performing Automated Runtime Testing" + section in the Yocto Project Development Tasks Manual and + the + "testimage*.bbclass" + section. + + + + THISDIR THISDIR[doc] = "The directory in which the file BitBake is currently parsing is located." -- cgit v1.2.3-54-g00ecf