diff options
author | Antonin Godard <antonin.godard@bootlin.com> | 2024-12-26 16:20:17 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-01-09 13:58:17 +0000 |
commit | d6ae2c0decc0e71f1d0c1a752d9cc0602e727557 (patch) | |
tree | 080bfb822641563f04f0eb4655fafed376000362 /documentation | |
parent | d720994f023f9c0bf23d6234089b21e23d837dc5 (diff) | |
download | poky-d6ae2c0decc0e71f1d0c1a752d9cc0602e727557.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: 6b44257874858db3aa426d3e84a79c41cb4937a3)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
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 c853462d6f..22c4301a49 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -3232,8 +3232,8 @@ after it is built, you can set :term:`TESTIMAGE_AUTO`:: | |||
3232 | TESTIMAGE_AUTO = "1" | 3232 | TESTIMAGE_AUTO = "1" |
3233 | 3233 | ||
3234 | For information on how to enable, run, and create new tests, see the | 3234 | For information on how to enable, run, and create new tests, see the |
3235 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" | 3235 | ":ref:`test-manual/runtime-testing:performing automated runtime testing`" |
3236 | section in the Yocto Project Development Tasks Manual. | 3236 | section in the Yocto Project Test Environment Manual. |
3237 | 3237 | ||
3238 | .. _ref-classes-testsdk: | 3238 | .. _ref-classes-testsdk: |
3239 | 3239 | ||
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 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. | |||
615 | 615 | ||
616 | Boots an image and performs runtime tests within the image. For | 616 | Boots an image and performs runtime tests within the image. For |
617 | information on automatically testing images, see the | 617 | information on automatically testing images, see the |
618 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" | 618 | ":ref:`test-manual/runtime-testing:performing automated runtime testing`" |
619 | section in the Yocto Project Development Tasks Manual. | 619 | section in the Yocto Project Test Environment Manual. |
620 | 620 | ||
621 | .. _ref-tasks-testimage_auto: | 621 | .. _ref-tasks-testimage_auto: |
622 | 622 | ||
@@ -628,8 +628,8 @@ after it has been built. This task is enabled when you set | |||
628 | :term:`TESTIMAGE_AUTO` equal to "1". | 628 | :term:`TESTIMAGE_AUTO` equal to "1". |
629 | 629 | ||
630 | For information on automatically testing images, see the | 630 | For information on automatically testing images, see the |
631 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" | 631 | ":ref:`test-manual/runtime-testing:performing automated runtime testing`" |
632 | section in the Yocto Project Development Tasks Manual. | 632 | section in the Yocto Project Test Environment Manual. |
633 | 633 | ||
634 | Kernel-Related Tasks | 634 | Kernel-Related Tasks |
635 | ==================== | 635 | ==================== |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index f4d50b7918..702a6caf87 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -9305,8 +9305,8 @@ system and gives an overview of their function and contents. | |||
9305 | file. | 9305 | file. |
9306 | 9306 | ||
9307 | For more information on testing images, see the | 9307 | For more information on testing images, see the |
9308 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" | 9308 | ":ref:`test-manual/runtime-testing:performing automated runtime testing`" |
9309 | section in the Yocto Project Development Tasks Manual. | 9309 | section in the Yocto Project Test Environment Manual. |
9310 | 9310 | ||
9311 | :term:`TEST_SERIALCONTROL_CMD` | 9311 | :term:`TEST_SERIALCONTROL_CMD` |
9312 | For automated hardware testing, specifies the command to use to | 9312 | For automated hardware testing, specifies the command to use to |
@@ -9377,8 +9377,8 @@ system and gives an overview of their function and contents. | |||
9377 | TEST_SUITES = "test_A test_B" | 9377 | TEST_SUITES = "test_A test_B" |
9378 | 9378 | ||
9379 | For more information on testing images, see the | 9379 | For more information on testing images, see the |
9380 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" | 9380 | ":ref:`test-manual/runtime-testing:performing automated runtime testing`" |
9381 | section in the Yocto Project Development Tasks Manual. | 9381 | section in the Yocto Project Test Environment Manual. |
9382 | 9382 | ||
9383 | :term:`TEST_TARGET` | 9383 | :term:`TEST_TARGET` |
9384 | Specifies the target controller to use when running tests against a | 9384 | Specifies the target controller to use when running tests against a |
@@ -9396,8 +9396,8 @@ system and gives an overview of their function and contents. | |||
9396 | You can provide the following arguments with :term:`TEST_TARGET`: | 9396 | You can provide the following arguments with :term:`TEST_TARGET`: |
9397 | 9397 | ||
9398 | - *"qemu":* Boots a QEMU image and runs the tests. See the | 9398 | - *"qemu":* Boots a QEMU image and runs the tests. See the |
9399 | ":ref:`dev-manual/runtime-testing:enabling runtime tests on qemu`" section | 9399 | ":ref:`test-manual/runtime-testing:enabling runtime tests on qemu`" section |
9400 | in the Yocto Project Development Tasks Manual for more | 9400 | in the Yocto Project Test Environment Manual for more |
9401 | information. | 9401 | information. |
9402 | 9402 | ||
9403 | - *"simpleremote":* Runs the tests on target hardware that is | 9403 | - *"simpleremote":* Runs the tests on target hardware that is |
@@ -9412,8 +9412,8 @@ system and gives an overview of their function and contents. | |||
9412 | ``meta/lib/oeqa/controllers/simpleremote.py``. | 9412 | ``meta/lib/oeqa/controllers/simpleremote.py``. |
9413 | 9413 | ||
9414 | For information on running tests on hardware, see the | 9414 | For information on running tests on hardware, see the |
9415 | ":ref:`dev-manual/runtime-testing:enabling runtime tests on hardware`" | 9415 | ":ref:`test-manual/runtime-testing:enabling runtime tests on hardware`" |
9416 | section in the Yocto Project Development Tasks Manual. | 9416 | section in the Yocto Project Test Environment Manual. |
9417 | 9417 | ||
9418 | :term:`TEST_TARGET_IP` | 9418 | :term:`TEST_TARGET_IP` |
9419 | The IP address of your hardware under test. The :term:`TEST_TARGET_IP` | 9419 | The IP address of your hardware under test. The :term:`TEST_TARGET_IP` |
@@ -9449,8 +9449,8 @@ system and gives an overview of their function and contents. | |||
9449 | 9449 | ||
9450 | For more information | 9450 | For more information |
9451 | on enabling, running, and writing these tests, see the | 9451 | on enabling, running, and writing these tests, see the |
9452 | ":ref:`dev-manual/runtime-testing:performing automated runtime testing`" | 9452 | ":ref:`test-manual/runtime-testing:performing automated runtime testing`" |
9453 | section in the Yocto Project Development Tasks Manual and the | 9453 | section in the Yocto Project Test Environment Manual and the |
9454 | ":ref:`ref-classes-testimage`" section. | 9454 | ":ref:`ref-classes-testimage`" section. |
9455 | 9455 | ||
9456 | :term:`TESTIMAGE_FAILED_QA_ARTIFACTS` | 9456 | :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 252d3ea731..1a8e938a2e 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: |