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 08:41:04 -0800 |
| commit | 2497f29afd1ff66964b84dc79a7cd1126bbc94fa (patch) | |
| tree | 494d2d1a6b358c3796d870e1e060a949addf37b9 /documentation/ref-manual | |
| parent | 1418534d2215890723c281f852b6a6fd08acdbcf (diff) | |
| download | poky-2497f29afd1ff66964b84dc79a7cd1126bbc94fa.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: 8b6ada020d595d86c7bbe78a27b7a6301715b039)
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 | 1 | ||||
| -rw-r--r-- | documentation/ref-manual/release-process.rst | 2 | ||||
| -rw-r--r-- | documentation/ref-manual/variables.rst | 2 |
5 files changed, 5 insertions, 6 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 52a77a11be..b609c3af66 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
| @@ -2478,7 +2478,7 @@ runtime tests for recipes that build software that provides these tests. | |||
| 2478 | This class is intended to be inherited by individual recipes. However, | 2478 | This class is intended to be inherited by individual recipes. However, |
| 2479 | the class' functionality is largely disabled unless "ptest" appears in | 2479 | the class' functionality is largely disabled unless "ptest" appears in |
| 2480 | :term:`DISTRO_FEATURES`. See the | 2480 | :term:`DISTRO_FEATURES`. See the |
| 2481 | ":ref:`dev-manual/packages:testing packages with ptest`" | 2481 | ":ref:`test-manual/ptest:testing packages with ptest`" |
| 2482 | section in the Yocto Project Development Tasks Manual for more information | 2482 | section in the Yocto Project Development Tasks Manual for more information |
| 2483 | on ptest. | 2483 | on ptest. |
| 2484 | 2484 | ||
| @@ -2491,7 +2491,7 @@ Enables package tests (ptests) specifically for GNOME packages, which | |||
| 2491 | have tests intended to be executed with ``gnome-desktop-testing``. | 2491 | have tests intended to be executed with ``gnome-desktop-testing``. |
| 2492 | 2492 | ||
| 2493 | For information on setting up and running ptests, see the | 2493 | For information on setting up and running ptests, see the |
| 2494 | ":ref:`dev-manual/packages:testing packages with ptest`" | 2494 | ":ref:`test-manual/ptest:testing packages with ptest`" |
| 2495 | section in the Yocto Project Development Tasks Manual. | 2495 | section in the Yocto Project Development Tasks Manual. |
| 2496 | 2496 | ||
| 2497 | .. _ref-classes-python3-dir: | 2497 | .. _ref-classes-python3-dir: |
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst index bd393abd07..4d5f900ab8 100644 --- a/documentation/ref-manual/features.rst +++ b/documentation/ref-manual/features.rst | |||
| @@ -157,7 +157,7 @@ metadata: | |||
| 157 | 157 | ||
| 158 | - *ptest:* Enables building the package tests where supported by | 158 | - *ptest:* Enables building the package tests where supported by |
| 159 | individual recipes. For more information on package tests, see the | 159 | individual recipes. For more information on package tests, see the |
| 160 | ":ref:`dev-manual/packages:testing packages with ptest`" section | 160 | ":ref:`test-manual/ptest:testing packages with ptest`" section |
| 161 | in the Yocto Project Development Tasks Manual. | 161 | in the Yocto Project Development Tasks Manual. |
| 162 | 162 | ||
| 163 | - *smbfs:* Include SMB networks client support (for mounting | 163 | - *smbfs:* Include SMB networks client support (for mounting |
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst index 1e5fe21b02..92d2a42afb 100644 --- a/documentation/ref-manual/qa-checks.rst +++ b/documentation/ref-manual/qa-checks.rst | |||
| @@ -789,7 +789,6 @@ Errors and Warnings | |||
| 789 | use a relative path rather than an absolute one, or to pick up the path from | 789 | use a relative path rather than an absolute one, or to pick up the path from |
| 790 | runtime configuration or environment variables. | 790 | runtime configuration or environment variables. |
| 791 | 791 | ||
| 792 | |||
| 793 | Configuring and Disabling QA Checks | 792 | Configuring and Disabling QA Checks |
| 794 | =================================== | 793 | =================================== |
| 795 | 794 | ||
diff --git a/documentation/ref-manual/release-process.rst b/documentation/ref-manual/release-process.rst index 5733dd70ff..89f79812e8 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 7f0d09903b..8ab7391f98 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -6434,7 +6434,7 @@ system and gives an overview of their function and contents. | |||
| 6434 | 6434 | ||
| 6435 | :term:`PTEST_ENABLED` | 6435 | :term:`PTEST_ENABLED` |
| 6436 | Specifies whether or not :ref:`Package | 6436 | Specifies whether or not :ref:`Package |
| 6437 | Test <dev-manual/packages:testing packages with ptest>` (ptest) | 6437 | Test <test-manual/ptest:testing packages with ptest>` (ptest) |
| 6438 | functionality is enabled when building a recipe. You should not set | 6438 | functionality is enabled when building a recipe. You should not set |
| 6439 | this variable directly. Enabling and disabling building Package Tests | 6439 | this variable directly. Enabling and disabling building Package Tests |
| 6440 | at build time should be done by adding "ptest" to (or removing it | 6440 | at build time should be done by adding "ptest" to (or removing it |
