From e5b1aa3792e1a162ab584641cbe32d41d1b37c26 Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Thu, 26 Dec 2024 16:20:17 +0100 Subject: [PATCH] ref-manual: move runtime-testing section to the test-manual In the same fashion as the previous commit ("ref-manual/packages: move ptest section to the test-manual"), move the runtime testing section of the development tasks manual to the test environment manual. Add a link to it from the test-manual/intro document. (From yocto-docs rev: 8ac3e2eb1dd4149b24af03666813dc6d94df466d) Signed-off-by: Antonin Godard (cherry picked from commit 6b44257874858db3aa426d3e84a79c41cb4937a3) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman --- documentation/dev-manual/index.rst | 1 - .../migration-guides/migration-1.5.rst | 4 ++-- documentation/ref-manual/classes.rst | 4 ++-- documentation/ref-manual/images.rst | 4 ++-- documentation/ref-manual/release-process.rst | 4 ++-- documentation/ref-manual/tasks.rst | 8 ++++---- documentation/ref-manual/variables.rst | 20 +++++++++---------- documentation/test-manual/index.rst | 1 + documentation/test-manual/intro.rst | 4 +++- .../runtime-testing.rst | 5 +++-- 10 files changed, 29 insertions(+), 26 deletions(-) rename documentation/{dev-manual => test-manual}/runtime-testing.rst (99%) diff --git a/documentation/dev-manual/index.rst b/documentation/dev-manual/index.rst index 7afd0d820e..8243c0f4cb 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 c8f3cbc165..da26cca63d 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 8bde67c900..925fc8a676 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 c45f9104a9..d6bdc92f07 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 3383a4e1b0..c4452228a7 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 df751d75a3..d2e1f4ce14 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 ed77866dc6..7faea61416 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -9252,8 +9252,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 @@ -9324,8 +9324,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 @@ -9343,8 +9343,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 @@ -9359,8 +9359,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` @@ -9396,8 +9396,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 ad71f37910..d365d337ea 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 252d3ea731..1a8e938a2e 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 7a2b42f25a..557e0530b0 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: