diff --git a/documentation/dev-manual/index.rst b/documentation/dev-manual/index.rst index 7afd0d820e94d56cb2145962b9b1a976c7951936..8243c0f4cb2598fedee27d3d29e5d0d5b3d1e107 100644 --- a/documentation/dev-manual/index.rst +++ b/documentation/dev-manual/index.rst @@ -39,7 +39,6 @@ Yocto Project Development Tasks Manual external-scm read-only-rootfs build-quality - runtime-testing debugging licenses security-subjects diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst index c8f3cbc1655421e43968af23faad08d4ce1bd525..da26cca63d2336ada8acda3ea22dc8d45a47bbc2 100644 --- a/documentation/migration-guides/migration-1.5.rst +++ b/documentation/migration-guides/migration-1.5.rst @@ -248,8 +248,8 @@ A new automated image testing framework has been added through the framework replaces the older ``imagetest-qemu`` framework. You can learn more about performing automated image tests in the -":ref:`dev-manual/runtime-testing:performing automated runtime testing`" -section in the Yocto Project Development Tasks Manual. +":ref:`test-manual/runtime-testing:performing automated runtime testing`" +section in the Yocto Project Test Environment Manual. .. _migration-1.5-build-history: diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 7da2a6d70955976c3c10e2971a4b6c5324c570b9..a4168624e4a4bf117e00ed20bd338729d032eadc 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -3231,8 +3231,8 @@ after it is built, you can set :term:`TESTIMAGE_AUTO`:: TESTIMAGE_AUTO = "1" For information on how to enable, run, and create new tests, see the -":ref:`dev-manual/runtime-testing:performing automated runtime testing`" -section in the Yocto Project Development Tasks Manual. +":ref:`test-manual/runtime-testing:performing automated runtime testing`" +section in the Yocto Project Test Environment Manual. .. _ref-classes-testsdk: diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst index c45f9104a949f7470fe11e8e70533c7a2ee8b16e..d6bdc92f0744eae5761bf499b8a0e2bd094f1822 100644 --- a/documentation/ref-manual/images.rst +++ b/documentation/ref-manual/images.rst @@ -119,8 +119,8 @@ Here is a list of supported recipes: deployed to a separate partition so that you can boot into it and use it to deploy a second image to be tested. You can find more information about runtime testing in the - ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" - section in the Yocto Project Development Tasks Manual. + ":ref:`test-manual/runtime-testing:performing automated runtime testing`" + section in the Yocto Project Test Environment Manual. - ``core-image-testmaster-initramfs``: A RAM-based Initial Root Filesystem (:term:`Initramfs`) image tailored for use with the diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst index 3383a4e1b099f92e3d2b6f412698c3fe12cfe7fc..c4452228a70268649f56ed3ecfde1f7418926fc6 100644 --- a/documentation/ref-manual/release-process.rst +++ b/documentation/ref-manual/release-process.rst @@ -148,8 +148,8 @@ Additionally, because the test strategies are visible to you as a developer, you can validate your projects. This section overviews the available test infrastructure used in the Yocto Project. For information on how to run available tests on your projects, see the -":ref:`dev-manual/runtime-testing:performing automated runtime testing`" -section in the Yocto Project Development Tasks Manual. +":ref:`test-manual/runtime-testing:performing automated runtime testing`" +section in the Yocto Project Test Environment Manual. The QA/testing infrastructure is woven into the project to the point where core developers take some of it for granted. The infrastructure diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index df751d75a34bcdba51d9838a819dc9c1d99f19e6..d2e1f4ce143c6dce2c9110a8c98d1945faf71fea 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst @@ -615,8 +615,8 @@ information on how the root filesystem is created. Boots an image and performs runtime tests within the image. For information on automatically testing images, see the -":ref:`dev-manual/runtime-testing:performing automated runtime testing`" -section in the Yocto Project Development Tasks Manual. +":ref:`test-manual/runtime-testing:performing automated runtime testing`" +section in the Yocto Project Test Environment Manual. .. _ref-tasks-testimage_auto: @@ -628,8 +628,8 @@ after it has been built. This task is enabled when you set :term:`TESTIMAGE_AUTO` equal to "1". For information on automatically testing images, see the -":ref:`dev-manual/runtime-testing:performing automated runtime testing`" -section in the Yocto Project Development Tasks Manual. +":ref:`test-manual/runtime-testing:performing automated runtime testing`" +section in the Yocto Project Test Environment Manual. Kernel-Related Tasks ==================== diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index f78403fad0f844e54267c7f547b1abd98e1816af..a84acfd77effab04ad7834da9330586c6ee35ba7 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -9204,8 +9204,8 @@ system and gives an overview of their function and contents. file. For more information on testing images, see the - ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" - section in the Yocto Project Development Tasks Manual. + ":ref:`test-manual/runtime-testing:performing automated runtime testing`" + section in the Yocto Project Test Environment Manual. :term:`TEST_SERIALCONTROL_CMD` For automated hardware testing, specifies the command to use to @@ -9276,8 +9276,8 @@ system and gives an overview of their function and contents. TEST_SUITES = "test_A test_B" For more information on testing images, see the - ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" - section in the Yocto Project Development Tasks Manual. + ":ref:`test-manual/runtime-testing:performing automated runtime testing`" + section in the Yocto Project Test Environment Manual. :term:`TEST_TARGET` Specifies the target controller to use when running tests against a @@ -9295,8 +9295,8 @@ system and gives an overview of their function and contents. You can provide the following arguments with :term:`TEST_TARGET`: - *"qemu":* Boots a QEMU image and runs the tests. See the - ":ref:`dev-manual/runtime-testing:enabling runtime tests on qemu`" section - in the Yocto Project Development Tasks Manual for more + ":ref:`test-manual/runtime-testing:enabling runtime tests on qemu`" section + in the Yocto Project Test Environment Manual for more information. - *"simpleremote":* Runs the tests on target hardware that is @@ -9311,8 +9311,8 @@ system and gives an overview of their function and contents. ``meta/lib/oeqa/controllers/simpleremote.py``. For information on running tests on hardware, see the - ":ref:`dev-manual/runtime-testing:enabling runtime tests on hardware`" - section in the Yocto Project Development Tasks Manual. + ":ref:`test-manual/runtime-testing:enabling runtime tests on hardware`" + section in the Yocto Project Test Environment Manual. :term:`TEST_TARGET_IP` The IP address of your hardware under test. The :term:`TEST_TARGET_IP` @@ -9348,8 +9348,8 @@ system and gives an overview of their function and contents. For more information on enabling, running, and writing these tests, see the - ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" - section in the Yocto Project Development Tasks Manual and the + ":ref:`test-manual/runtime-testing:performing automated runtime testing`" + section in the Yocto Project Test Environment Manual and the ":ref:`ref-classes-testimage`" section. :term:`TESTIMAGE_FAILED_QA_ARTIFACTS` diff --git a/documentation/test-manual/index.rst b/documentation/test-manual/index.rst index ad71f379106261af32dc925d700ed36da43d234b..d365d337ea5ba71a71707aee996444cb7d155ddc 100644 --- a/documentation/test-manual/index.rst +++ b/documentation/test-manual/index.rst @@ -13,6 +13,7 @@ Yocto Project Test Environment Manual intro test-process ptest + runtime-testing understand-autobuilder reproducible-builds yocto-project-compatible diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst index 252d3ea731c39709b8fbe64d281722c172a282a9..1a8e938a2ea23e1b441e0b30ac4fa69229dafac6 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst @@ -130,7 +130,9 @@ the following types of tests: $ bitbake image -c testimage The tests use the :ref:`ref-classes-testimage` - class and the :ref:`ref-tasks-testimage` task. + class and the :ref:`ref-tasks-testimage` task. See the + :ref:`test-manual/runtime-testing:Performing Automated Runtime Testing` + section of the Yocto Project Test Environment Manual for more information. - *Layer Testing:* The Autobuilder has the possibility to test whether specific layers work with the test of the system. The layers tested diff --git a/documentation/dev-manual/runtime-testing.rst b/documentation/test-manual/runtime-testing.rst similarity index 99% rename from documentation/dev-manual/runtime-testing.rst rename to documentation/test-manual/runtime-testing.rst index 7a2b42f25af2cd6e3488d706276d52f0cc6ebae9..557e0530b05513cc6dfab2f75cbfa54c86e685d3 100644 --- a/documentation/dev-manual/runtime-testing.rst +++ b/documentation/test-manual/runtime-testing.rst @@ -1,5 +1,6 @@ .. SPDX-License-Identifier: CC-BY-SA-2.0-UK +************************************ Performing Automated Runtime Testing ************************************ @@ -153,7 +154,7 @@ options are available: If you choose "SystemdbootTarget", there are additional requirements and considerations. See the - ":ref:`dev-manual/runtime-testing:selecting systemdboottarget`" section, which + ":ref:`test-manual/runtime-testing:selecting systemdboottarget`" section, which follows, for more information. - *"BeagleBoneTarget":* Choose "BeagleBoneTarget" if you are deploying @@ -179,7 +180,7 @@ Selecting SystemdbootTarget If you did not set :term:`TEST_TARGET` to "SystemdbootTarget", then you do not need any information in this section. You can skip down to the -":ref:`dev-manual/runtime-testing:running tests`" section. +":ref:`test-manual/runtime-testing:running tests`" section. If you did set :term:`TEST_TARGET` to "SystemdbootTarget", you also need to perform a one-time setup of your controller image by doing the following: