diff options
author | Antonin Godard <antonin.godard@bootlin.com> | 2024-12-26 16:20:17 +0100 |
---|---|---|
committer | Steve Sakoman <steve@sakoman.com> | 2025-01-09 06:25:36 -0800 |
commit | 7117d115eab7351ecf21388ec720a3bb5f4a9b30 (patch) | |
tree | f0a641b48d50a108d8249d1991b56814635c7758 /documentation | |
parent | 3f782b6e4527d5b02cc98203b0fb79620b6a89df (diff) | |
download | poky-7117d115eab7351ecf21388ec720a3bb5f4a9b30.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: 79aa34db34def525a11c41d951365bcb891318c4)
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>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/dev-manual/index.rst | 1 | ||||
-rw-r--r-- | documentation/migration-guides/migration-1.5.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/classes.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/images.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/release-process.rst | 4 | ||||
-rw-r--r-- | documentation/ref-manual/tasks.rst | 8 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 20 | ||||
-rw-r--r-- | documentation/test-manual/index.rst | 1 | ||||
-rw-r--r-- | documentation/test-manual/intro.rst | 4 | ||||
-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 7afd0d820e..8243c0f4cb 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 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 | |||
248 | framework replaces the older ``imagetest-qemu`` framework. | 248 | framework replaces the older ``imagetest-qemu`` framework. |
249 | 249 | ||
250 | You can learn more about performing automated image tests in the | 250 | You can learn more about performing automated image tests in the |
251 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" | 251 | ":ref:`test-manual/runtime-testing:performing automated runtime testing`" |
252 | section in the Yocto Project Development Tasks Manual. | 252 | section in the Yocto Project Test Environment Manual. |
253 | 253 | ||
254 | .. _migration-1.5-build-history: | 254 | .. _migration-1.5-build-history: |
255 | 255 | ||
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index f416a6d623..5bd1d50947 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -3212,8 +3212,8 @@ after it is built, you can set :term:`TESTIMAGE_AUTO`:: | |||
3212 | TESTIMAGE_AUTO = "1" | 3212 | TESTIMAGE_AUTO = "1" |
3213 | 3213 | ||
3214 | For information on how to enable, run, and create new tests, see the | 3214 | For information on how to enable, run, and create new tests, see the |
3215 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" | 3215 | ":ref:`test-manual/runtime-testing:performing automated runtime testing`" |
3216 | section in the Yocto Project Development Tasks Manual. | 3216 | section in the Yocto Project Test Environment Manual. |
3217 | 3217 | ||
3218 | .. _ref-classes-testsdk: | 3218 | .. _ref-classes-testsdk: |
3219 | 3219 | ||
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: | |||
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 (:term:`Initramfs`) image tailored for use with the | 126 | 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 | |||
148 | developer, you can validate your projects. This section overviews the | 148 | developer, you can validate your projects. This section overviews the |
149 | available test infrastructure used in the Yocto Project. For information | 149 | available test infrastructure used in the Yocto Project. For information |
150 | on how to run available tests on your projects, see the | 150 | on 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`" |
152 | section in the Yocto Project Development Tasks Manual. | 152 | section in the Yocto Project Test Environment Manual. |
153 | 153 | ||
154 | The QA/testing infrastructure is woven into the project to the point | 154 | The QA/testing infrastructure is woven into the project to the point |
155 | where core developers take some of it for granted. The infrastructure | 155 | 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 2e4b23408d..5cd23449fa 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst | |||
@@ -616,8 +616,8 @@ information on how the root filesystem is created. | |||
616 | 616 | ||
617 | Boots an image and performs runtime tests within the image. For | 617 | Boots an image and performs runtime tests within the image. For |
618 | information on automatically testing images, see the | 618 | information on automatically testing images, see the |
619 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" | 619 | ":ref:`test-manual/runtime-testing:performing automated runtime testing`" |
620 | section in the Yocto Project Development Tasks Manual. | 620 | section in the Yocto Project Test Environment Manual. |
621 | 621 | ||
622 | .. _ref-tasks-testimage_auto: | 622 | .. _ref-tasks-testimage_auto: |
623 | 623 | ||
@@ -629,8 +629,8 @@ after it has been built. This task is enabled when you set | |||
629 | :term:`TESTIMAGE_AUTO` equal to "1". | 629 | :term:`TESTIMAGE_AUTO` equal to "1". |
630 | 630 | ||
631 | For information on automatically testing images, see the | 631 | For information 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`" |
633 | section in the Yocto Project Development Tasks Manual. | 633 | section in the Yocto Project Test Environment Manual. |
634 | 634 | ||
635 | Kernel-Related Tasks | 635 | Kernel-Related Tasks |
636 | ==================== | 636 | ==================== |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 200def084f..3ba3897787 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -9143,8 +9143,8 @@ system and gives an overview of their function and contents. | |||
9143 | file. | 9143 | file. |
9144 | 9144 | ||
9145 | For more information on testing images, see the | 9145 | For more information on testing images, see the |
9146 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" | 9146 | ":ref:`test-manual/runtime-testing:performing automated runtime testing`" |
9147 | section in the Yocto Project Development Tasks Manual. | 9147 | section in the Yocto Project Test Environment Manual. |
9148 | 9148 | ||
9149 | :term:`TEST_SERIALCONTROL_CMD` | 9149 | :term:`TEST_SERIALCONTROL_CMD` |
9150 | For automated hardware testing, specifies the command to use to | 9150 | For automated hardware testing, specifies the command to use to |
@@ -9215,8 +9215,8 @@ system and gives an overview of their function and contents. | |||
9215 | TEST_SUITES = "test_A test_B" | 9215 | TEST_SUITES = "test_A test_B" |
9216 | 9216 | ||
9217 | For more information on testing images, see the | 9217 | For more information on testing images, see the |
9218 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" | 9218 | ":ref:`test-manual/runtime-testing:performing automated runtime testing`" |
9219 | section in the Yocto Project Development Tasks Manual. | 9219 | section in the Yocto Project Test Environment Manual. |
9220 | 9220 | ||
9221 | :term:`TEST_TARGET` | 9221 | :term:`TEST_TARGET` |
9222 | Specifies the target controller to use when running tests against a | 9222 | Specifies the target controller to use when running tests against a |
@@ -9234,8 +9234,8 @@ system and gives an overview of their function and contents. | |||
9234 | You can provide the following arguments with :term:`TEST_TARGET`: | 9234 | You can provide the following arguments with :term:`TEST_TARGET`: |
9235 | 9235 | ||
9236 | - *"qemu":* Boots a QEMU image and runs the tests. See the | 9236 | - *"qemu":* Boots a QEMU image and runs the tests. See the |
9237 | ":ref:`dev-manual/runtime-testing:enabling runtime tests on qemu`" section | 9237 | ":ref:`test-manual/runtime-testing:enabling runtime tests on qemu`" section |
9238 | in the Yocto Project Development Tasks Manual for more | 9238 | in the Yocto Project Test Environment Manual for more |
9239 | information. | 9239 | information. |
9240 | 9240 | ||
9241 | - *"simpleremote":* Runs the tests on target hardware that is | 9241 | - *"simpleremote":* Runs the tests on target hardware that is |
@@ -9250,8 +9250,8 @@ system and gives an overview of their function and contents. | |||
9250 | ``meta/lib/oeqa/controllers/simpleremote.py``. | 9250 | ``meta/lib/oeqa/controllers/simpleremote.py``. |
9251 | 9251 | ||
9252 | For information on running tests on hardware, see the | 9252 | For information on running tests on hardware, see the |
9253 | ":ref:`dev-manual/runtime-testing:enabling runtime tests on hardware`" | 9253 | ":ref:`test-manual/runtime-testing:enabling runtime tests on hardware`" |
9254 | section in the Yocto Project Development Tasks Manual. | 9254 | section in the Yocto Project Test Environment Manual. |
9255 | 9255 | ||
9256 | :term:`TEST_TARGET_IP` | 9256 | :term:`TEST_TARGET_IP` |
9257 | The IP address of your hardware under test. The :term:`TEST_TARGET_IP` | 9257 | The IP address of your hardware under test. The :term:`TEST_TARGET_IP` |
@@ -9287,8 +9287,8 @@ system and gives an overview of their function and contents. | |||
9287 | 9287 | ||
9288 | For more information | 9288 | For more information |
9289 | on enabling, running, and writing these tests, see the | 9289 | on enabling, running, and writing these tests, see the |
9290 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" | 9290 | ":ref:`test-manual/runtime-testing:performing automated runtime testing`" |
9291 | section in the Yocto Project Development Tasks Manual and the | 9291 | section in the Yocto Project Test Environment Manual and the |
9292 | ":ref:`ref-classes-testimage`" section. | 9292 | ":ref:`ref-classes-testimage`" section. |
9293 | 9293 | ||
9294 | :term:`TESTIMAGE_FAILED_QA_ARTIFACTS` | 9294 | :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 | |||
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 7bbd11295f..5d451b6c28 100644 --- a/documentation/test-manual/intro.rst +++ b/documentation/test-manual/intro.rst | |||
@@ -130,7 +130,9 @@ the following types of tests: | |||
130 | $ bitbake image -c testimage | 130 | $ bitbake image -c testimage |
131 | 131 | ||
132 | The tests use the :ref:`ref-classes-testimage` | 132 | The tests use the :ref:`ref-classes-testimage` |
133 | class and the :ref:`ref-tasks-testimage` task. | 133 | class and the :ref:`ref-tasks-testimage` task. See the |
134 | :ref:`test-manual/runtime-testing:Performing Automated Runtime Testing` | ||
135 | section of the Yocto Project Test Environment Manual for more information. | ||
134 | 136 | ||
135 | - *Layer Testing:* The Autobuilder has the possibility to test whether | 137 | - *Layer Testing:* The Autobuilder has the possibility to test whether |
136 | specific layers work with the test of the system. The layers tested | 138 | 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 7a2b42f25a..557e0530b0 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 | ************************************ | ||
3 | Performing Automated Runtime Testing | 4 | Performing 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 |
@@ -179,7 +180,7 @@ Selecting SystemdbootTarget | |||
179 | 180 | ||
180 | If you did not set :term:`TEST_TARGET` to "SystemdbootTarget", then you do | 181 | If you did not set :term:`TEST_TARGET` to "SystemdbootTarget", then you do |
181 | not need any information in this section. You can skip down to the | 182 | not need any information in this section. You can skip down to the |
182 | ":ref:`dev-manual/runtime-testing:running tests`" section. | 183 | ":ref:`test-manual/runtime-testing:running tests`" section. |
183 | 184 | ||
184 | If you did set :term:`TEST_TARGET` to "SystemdbootTarget", you also need to | 185 | If you did set :term:`TEST_TARGET` to "SystemdbootTarget", you also need to |
185 | perform a one-time setup of your controller image by doing the following: | 186 | perform a one-time setup of your controller image by doing the following: |