summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2024-12-26 16:20:17 +0100
committerSteve Sakoman <steve@sakoman.com>2025-01-09 08:41:04 -0800
commitac2d3a537751ddc3399f82fc85bfb4a6dd38cf7d (patch)
tree4874a7fe52d07cbf9d7d177f9765ddcec91a881c
parent2497f29afd1ff66964b84dc79a7cd1126bbc94fa (diff)
downloadpoky-ac2d3a537751ddc3399f82fc85bfb4a6dd38cf7d.tar.gz
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: 3128bf149f40928e6c2a3e264590a0c6c9778c6a) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 6b44257874858db3aa426d3e84a79c41cb4937a3) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r--documentation/dev-manual/index.rst1
-rw-r--r--documentation/migration-guides/migration-1.5.rst4
-rw-r--r--documentation/ref-manual/classes.rst4
-rw-r--r--documentation/ref-manual/images.rst4
-rw-r--r--documentation/ref-manual/release-process.rst4
-rw-r--r--documentation/ref-manual/tasks.rst8
-rw-r--r--documentation/ref-manual/variables.rst20
-rw-r--r--documentation/test-manual/index.rst1
-rw-r--r--documentation/test-manual/intro.rst4
-rw-r--r--documentation/test-manual/runtime-testing.rst (renamed from documentation/dev-manual/runtime-testing.rst)5
10 files changed, 29 insertions, 26 deletions
diff --git a/documentation/dev-manual/index.rst b/documentation/dev-manual/index.rst
index 9ccf60f701..ef0512d246 100644
--- a/documentation/dev-manual/index.rst
+++ b/documentation/dev-manual/index.rst
@@ -39,7 +39,6 @@ Yocto Project Development Tasks Manual
39 external-scm 39 external-scm
40 read-only-rootfs 40 read-only-rootfs
41 build-quality 41 build-quality
42 runtime-testing
43 debugging 42 debugging
44 licenses 43 licenses
45 security-subjects 44 security-subjects
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst
index 06334d6fc7..adfecb98aa 100644
--- a/documentation/migration-guides/migration-1.5.rst
+++ b/documentation/migration-guides/migration-1.5.rst
@@ -243,8 +243,8 @@ A new automated image testing framework has been added through the
243framework replaces the older ``imagetest-qemu`` framework. 243framework replaces the older ``imagetest-qemu`` framework.
244 244
245You can learn more about performing automated image tests in the 245You can learn more about performing automated image tests in the
246":ref:`dev-manual/runtime-testing:performing automated runtime testing`" 246":ref:`test-manual/runtime-testing:performing automated runtime testing`"
247section in the Yocto Project Development Tasks Manual. 247section in the Yocto Project Test Environment Manual.
248 248
249.. _migration-1.5-build-history: 249.. _migration-1.5-build-history:
250 250
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index b609c3af66..31bb1eeb94 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -3064,8 +3064,8 @@ after it is built, you can set :term:`TESTIMAGE_AUTO`::
3064 TESTIMAGE_AUTO = "1" 3064 TESTIMAGE_AUTO = "1"
3065 3065
3066For information on how to enable, run, and create new tests, see the 3066For information on how to enable, run, and create new tests, see the
3067":ref:`dev-manual/runtime-testing:performing automated runtime testing`" 3067":ref:`test-manual/runtime-testing:performing automated runtime testing`"
3068section in the Yocto Project Development Tasks Manual. 3068section in the Yocto Project Test Environment Manual.
3069 3069
3070.. _ref-classes-testsdk: 3070.. _ref-classes-testsdk:
3071 3071
diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst
index f875633128..d36a4b2507 100644
--- a/documentation/ref-manual/images.rst
+++ b/documentation/ref-manual/images.rst
@@ -119,8 +119,8 @@ Here is a list of supported recipes:
119 deployed to a separate partition so that you can boot into it and use 119 deployed to a separate partition so that you can boot into it and use
120 it to deploy a second image to be tested. You can find more 120 it to deploy a second image to be tested. You can find more
121 information about runtime testing in the 121 information about runtime testing in the
122 ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" 122 ":ref:`test-manual/runtime-testing:performing automated runtime testing`"
123 section in the Yocto Project Development Tasks Manual. 123 section in the Yocto Project Test Environment Manual.
124 124
125- ``core-image-testmaster-initramfs``: A RAM-based Initial Root 125- ``core-image-testmaster-initramfs``: A RAM-based Initial Root
126 Filesystem (initramfs) image tailored for use with the 126 Filesystem (initramfs) image tailored for use with the
diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst
index 89f79812e8..aed4c51aa2 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
148developer, you can validate your projects. This section overviews the 148developer, you can validate your projects. This section overviews the
149available test infrastructure used in the Yocto Project. For information 149available test infrastructure used in the Yocto Project. For information
150on how to run available tests on your projects, see the 150on how to run available tests on your projects, see the
151":ref:`dev-manual/runtime-testing:performing automated runtime testing`" 151":ref:`test-manual/runtime-testing:performing automated runtime testing`"
152section in the Yocto Project Development Tasks Manual. 152section in the Yocto Project Test Environment Manual.
153 153
154The QA/testing infrastructure is woven into the project to the point 154The QA/testing infrastructure is woven into the project to the point
155where core developers take some of it for granted. The infrastructure 155where 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 346e9491f3..c69fbaa518 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -629,8 +629,8 @@ information on how the root filesystem is created.
629 629
630Boots an image and performs runtime tests within the image. For 630Boots an image and performs runtime tests within the image. For
631information on automatically testing images, see the 631information on automatically testing images, see the
632":ref:`dev-manual/runtime-testing:performing automated runtime testing`" 632":ref:`test-manual/runtime-testing:performing automated runtime testing`"
633section in the Yocto Project Development Tasks Manual. 633section in the Yocto Project Test Environment Manual.
634 634
635.. _ref-tasks-testimage_auto: 635.. _ref-tasks-testimage_auto:
636 636
@@ -642,8 +642,8 @@ after it has been built. This task is enabled when you set
642:term:`TESTIMAGE_AUTO` equal to "1". 642:term:`TESTIMAGE_AUTO` equal to "1".
643 643
644For information on automatically testing images, see the 644For information on automatically testing images, see the
645":ref:`dev-manual/runtime-testing:performing automated runtime testing`" 645":ref:`test-manual/runtime-testing:performing automated runtime testing`"
646section in the Yocto Project Development Tasks Manual. 646section in the Yocto Project Test Environment Manual.
647 647
648Kernel-Related Tasks 648Kernel-Related Tasks
649==================== 649====================
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 8ab7391f98..feb8be6be9 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -8688,8 +8688,8 @@ system and gives an overview of their function and contents.
8688 file. 8688 file.
8689 8689
8690 For more information on testing images, see the 8690 For more information on testing images, see the
8691 ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" 8691 ":ref:`test-manual/runtime-testing:performing automated runtime testing`"
8692 section in the Yocto Project Development Tasks Manual. 8692 section in the Yocto Project Test Environment Manual.
8693 8693
8694 :term:`TEST_SERIALCONTROL_CMD` 8694 :term:`TEST_SERIALCONTROL_CMD`
8695 For automated hardware testing, specifies the command to use to 8695 For automated hardware testing, specifies the command to use to
@@ -8761,8 +8761,8 @@ system and gives an overview of their function and contents.
8761 TEST_SUITES = "test_A test_B" 8761 TEST_SUITES = "test_A test_B"
8762 8762
8763 For more information on testing images, see the 8763 For more information on testing images, see the
8764 ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" 8764 ":ref:`test-manual/runtime-testing:performing automated runtime testing`"
8765 section in the Yocto Project Development Tasks Manual. 8765 section in the Yocto Project Test Environment Manual.
8766 8766
8767 :term:`TEST_TARGET` 8767 :term:`TEST_TARGET`
8768 Specifies the target controller to use when running tests against a 8768 Specifies the target controller to use when running tests against a
@@ -8780,8 +8780,8 @@ system and gives an overview of their function and contents.
8780 You can provide the following arguments with :term:`TEST_TARGET`: 8780 You can provide the following arguments with :term:`TEST_TARGET`:
8781 8781
8782 - *"qemu":* Boots a QEMU image and runs the tests. See the 8782 - *"qemu":* Boots a QEMU image and runs the tests. See the
8783 ":ref:`dev-manual/runtime-testing:enabling runtime tests on qemu`" section 8783 ":ref:`test-manual/runtime-testing:enabling runtime tests on qemu`" section
8784 in the Yocto Project Development Tasks Manual for more 8784 in the Yocto Project Test Environment Manual for more
8785 information. 8785 information.
8786 8786
8787 - *"simpleremote":* Runs the tests on target hardware that is 8787 - *"simpleremote":* Runs the tests on target hardware that is
@@ -8796,8 +8796,8 @@ system and gives an overview of their function and contents.
8796 ``meta/lib/oeqa/controllers/simpleremote.py``. 8796 ``meta/lib/oeqa/controllers/simpleremote.py``.
8797 8797
8798 For information on running tests on hardware, see the 8798 For information on running tests on hardware, see the
8799 ":ref:`dev-manual/runtime-testing:enabling runtime tests on hardware`" 8799 ":ref:`test-manual/runtime-testing:enabling runtime tests on hardware`"
8800 section in the Yocto Project Development Tasks Manual. 8800 section in the Yocto Project Test Environment Manual.
8801 8801
8802 :term:`TEST_TARGET_IP` 8802 :term:`TEST_TARGET_IP`
8803 The IP address of your hardware under test. The :term:`TEST_TARGET_IP` 8803 The IP address of your hardware under test. The :term:`TEST_TARGET_IP`
@@ -8833,8 +8833,8 @@ system and gives an overview of their function and contents.
8833 8833
8834 For more information 8834 For more information
8835 on enabling, running, and writing these tests, see the 8835 on enabling, running, and writing these tests, see the
8836 ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" 8836 ":ref:`test-manual/runtime-testing:performing automated runtime testing`"
8837 section in the Yocto Project Development Tasks Manual and the 8837 section in the Yocto Project Test Environment Manual and the
8838 ":ref:`ref-classes-testimage`" section. 8838 ":ref:`ref-classes-testimage`" section.
8839 8839
8840 :term:`THISDIR` 8840 :term:`THISDIR`
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
13 intro 13 intro
14 test-process 14 test-process
15 ptest 15 ptest
16 runtime-testing
16 understand-autobuilder 17 understand-autobuilder
17 reproducible-builds 18 reproducible-builds
18 yocto-project-compatible 19 yocto-project-compatible
diff --git a/documentation/test-manual/intro.rst b/documentation/test-manual/intro.rst
index ff9b6d3794..3e97a939e6 100644
--- a/documentation/test-manual/intro.rst
+++ b/documentation/test-manual/intro.rst
@@ -131,7 +131,9 @@ the following types of tests:
131 $ bitbake image -c testimage 131 $ bitbake image -c testimage
132 132
133 The tests use the :ref:`ref-classes-testimage` 133 The tests use the :ref:`ref-classes-testimage`
134 class and the :ref:`ref-tasks-testimage` task. 134 class and the :ref:`ref-tasks-testimage` task. See the
135 :ref:`test-manual/runtime-testing:Performing Automated Runtime Testing`
136 section of the Yocto Project Test Environment Manual for more information.
135 137
136- *Layer Testing:* The Autobuilder has the possibility to test whether 138- *Layer Testing:* The Autobuilder has the possibility to test whether
137 specific layers work with the test of the system. The layers tested 139 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
index bd3f42ac09..88797c7ad8 100644
--- a/documentation/dev-manual/runtime-testing.rst
+++ b/documentation/test-manual/runtime-testing.rst
@@ -1,5 +1,6 @@
1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK 1.. SPDX-License-Identifier: CC-BY-SA-2.0-UK
2 2
3************************************
3Performing Automated Runtime Testing 4Performing Automated Runtime Testing
4************************************ 5************************************
5 6
@@ -153,7 +154,7 @@ options are available:
153 154
154 If you choose "SystemdbootTarget", there are additional requirements 155 If you choose "SystemdbootTarget", there are additional requirements
155 and considerations. See the 156 and considerations. See the
156 ":ref:`dev-manual/runtime-testing:selecting systemdboottarget`" section, which 157 ":ref:`test-manual/runtime-testing:selecting systemdboottarget`" section, which
157 follows, for more information. 158 follows, for more information.
158 159
159- *"BeagleBoneTarget":* Choose "BeagleBoneTarget" if you are deploying 160- *"BeagleBoneTarget":* Choose "BeagleBoneTarget" if you are deploying
@@ -185,7 +186,7 @@ Selecting SystemdbootTarget
185 186
186If you did not set :term:`TEST_TARGET` to "SystemdbootTarget", then you do 187If you did not set :term:`TEST_TARGET` to "SystemdbootTarget", then you do
187not need any information in this section. You can skip down to the 188not need any information in this section. You can skip down to the
188":ref:`dev-manual/runtime-testing:running tests`" section. 189":ref:`test-manual/runtime-testing:running tests`" section.
189 190
190If you did set :term:`TEST_TARGET` to "SystemdbootTarget", you also need to 191If you did set :term:`TEST_TARGET` to "SystemdbootTarget", you also need to
191perform a one-time setup of your controller image by doing the following: 192perform a one-time setup of your controller image by doing the following: