diff options
| author | Antonin Godard <antonin.godard@bootlin.com> | 2024-12-26 16:20:16 +0100 |
|---|---|---|
| committer | Steve Sakoman <steve@sakoman.com> | 2025-01-09 06:02:49 -0800 |
| commit | 587d779d563f93bdc5d4422923186befe4398520 (patch) | |
| tree | 1c826de148ccc521d1ca6f6fc4de9dace31a1cfd /documentation/ref-manual | |
| parent | 843c4a8de76bac455afba2080ee6b02359359162 (diff) | |
| download | poky-587d779d563f93bdc5d4422923186befe4398520.tar.gz | |
ref-manual/packages: move ptest section to the test-manual
[ YOCTO #15106 ]
It makes more sense to document ptests in the test-manual. Since ptests
are still related to packages, keep a link to ptests from packages.rst
to the test-manual.
Reported-by: Yoann Congal <yoann.congal@smile.fr>
(From yocto-docs rev: b79d1c8d501418d20c024c92b0ace755dd6b1c88)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
(cherry picked from commit b389c06b709e4791e1cce5e8a5b58f6b0cd03a14)
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/classes.rst | 4 | ||||
| -rw-r--r-- | documentation/ref-manual/features.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/qa-checks.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/release-process.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/variables.rst | 2 |
5 files changed, 6 insertions, 6 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 1f861328fe..8bde67c900 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
| @@ -2626,7 +2626,7 @@ runtime tests for recipes that build software that provides these tests. | |||
| 2626 | This class is intended to be inherited by individual recipes. However, | 2626 | This class is intended to be inherited by individual recipes. However, |
| 2627 | the class' functionality is largely disabled unless "ptest" appears in | 2627 | the class' functionality is largely disabled unless "ptest" appears in |
| 2628 | :term:`DISTRO_FEATURES`. See the | 2628 | :term:`DISTRO_FEATURES`. See the |
| 2629 | ":ref:`dev-manual/packages:testing packages with ptest`" | 2629 | ":ref:`test-manual/ptest:testing packages with ptest`" |
| 2630 | section in the Yocto Project Development Tasks Manual for more information | 2630 | section in the Yocto Project Development Tasks Manual for more information |
| 2631 | on ptest. | 2631 | on ptest. |
| 2632 | 2632 | ||
| @@ -2650,7 +2650,7 @@ Enables package tests (ptests) specifically for GNOME packages, which | |||
| 2650 | have tests intended to be executed with ``gnome-desktop-testing``. | 2650 | have tests intended to be executed with ``gnome-desktop-testing``. |
| 2651 | 2651 | ||
| 2652 | For information on setting up and running ptests, see the | 2652 | For information on setting up and running ptests, see the |
| 2653 | ":ref:`dev-manual/packages:testing packages with ptest`" | 2653 | ":ref:`test-manual/ptest:testing packages with ptest`" |
| 2654 | section in the Yocto Project Development Tasks Manual. | 2654 | section in the Yocto Project Development Tasks Manual. |
| 2655 | 2655 | ||
| 2656 | .. _ref-classes-python3-dir: | 2656 | .. _ref-classes-python3-dir: |
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst index 6e52dfce17..c6215391ee 100644 --- a/documentation/ref-manual/features.rst +++ b/documentation/ref-manual/features.rst | |||
| @@ -207,7 +207,7 @@ metadata, as extra layers can define their own: | |||
| 207 | 207 | ||
| 208 | - *ptest:* Enables building the package tests where supported by | 208 | - *ptest:* Enables building the package tests where supported by |
| 209 | individual recipes. For more information on package tests, see the | 209 | individual recipes. For more information on package tests, see the |
| 210 | ":ref:`dev-manual/packages:testing packages with ptest`" section | 210 | ":ref:`test-manual/ptest:testing packages with ptest`" section |
| 211 | in the Yocto Project Development Tasks Manual. | 211 | in the Yocto Project Development Tasks Manual. |
| 212 | 212 | ||
| 213 | - *pulseaudio:* Include support for | 213 | - *pulseaudio:* Include support for |
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst index 1b83834df1..27d46de3fd 100644 --- a/documentation/ref-manual/qa-checks.rst +++ b/documentation/ref-manual/qa-checks.rst | |||
| @@ -791,7 +791,7 @@ Errors and Warnings | |||
| 791 | 791 | ||
| 792 | This check will detect if the source of the package contains some | 792 | This check will detect if the source of the package contains some |
| 793 | upstream-provided tests and, if so, that ptests are implemented for this | 793 | upstream-provided tests and, if so, that ptests are implemented for this |
| 794 | recipe. See the ":ref:`dev-manual/packages:testing packages with ptest`" | 794 | recipe. See the ":ref:`test-manual/ptest:testing packages with ptest`" |
| 795 | section in the Yocto Project Development Tasks Manual. See also the | 795 | section in the Yocto Project Development Tasks Manual. See also the |
| 796 | ":ref:`ref-classes-ptest`" section. | 796 | ":ref:`ref-classes-ptest`" section. |
| 797 | 797 | ||
diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst index 691e7d3ed9..3383a4e1b0 100644 --- a/documentation/ref-manual/release-process.rst +++ b/documentation/ref-manual/release-process.rst | |||
| @@ -175,7 +175,7 @@ consists of the following pieces: | |||
| 175 | operation and functions. However, the test can also use the IP | 175 | operation and functions. However, the test can also use the IP |
| 176 | address of a machine to test. | 176 | address of a machine to test. |
| 177 | 177 | ||
| 178 | - :ref:`ptest <dev-manual/packages:testing packages with ptest>`: | 178 | - :ref:`ptest <test-manual/ptest:testing packages with ptest>`: |
| 179 | Runs tests against packages produced during the build for a given | 179 | Runs tests against packages produced during the build for a given |
| 180 | piece of software. The test allows the packages to be run within a | 180 | piece of software. The test allows the packages to be run within a |
| 181 | target image. | 181 | target image. |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 68520475a5..ed77866dc6 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -6891,7 +6891,7 @@ system and gives an overview of their function and contents. | |||
| 6891 | 6891 | ||
| 6892 | :term:`PTEST_ENABLED` | 6892 | :term:`PTEST_ENABLED` |
| 6893 | Specifies whether or not :ref:`Package | 6893 | Specifies whether or not :ref:`Package |
| 6894 | Test <dev-manual/packages:testing packages with ptest>` (ptest) | 6894 | Test <test-manual/ptest:testing packages with ptest>` (ptest) |
| 6895 | functionality is enabled when building a recipe. You should not set | 6895 | functionality is enabled when building a recipe. You should not set |
| 6896 | this variable directly. Enabling and disabling building Package Tests | 6896 | this variable directly. Enabling and disabling building Package Tests |
| 6897 | at build time should be done by adding "ptest" to (or removing it | 6897 | at build time should be done by adding "ptest" to (or removing it |
