From 587d779d563f93bdc5d4422923186befe4398520 Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Thu, 26 Dec 2024 16:20:16 +0100 Subject: 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 (From yocto-docs rev: b79d1c8d501418d20c024c92b0ace755dd6b1c88) Signed-off-by: Antonin Godard (cherry picked from commit b389c06b709e4791e1cce5e8a5b58f6b0cd03a14) Signed-off-by: Antonin Godard Signed-off-by: Steve Sakoman --- documentation/ref-manual/classes.rst | 4 ++-- documentation/ref-manual/features.rst | 2 +- documentation/ref-manual/qa-checks.rst | 2 +- documentation/ref-manual/release-process.rst | 2 +- documentation/ref-manual/variables.rst | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) (limited to 'documentation/ref-manual') 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. This class is intended to be inherited by individual recipes. However, the class' functionality is largely disabled unless "ptest" appears in :term:`DISTRO_FEATURES`. See the -":ref:`dev-manual/packages:testing packages with ptest`" +":ref:`test-manual/ptest:testing packages with ptest`" section in the Yocto Project Development Tasks Manual for more information on ptest. @@ -2650,7 +2650,7 @@ Enables package tests (ptests) specifically for GNOME packages, which have tests intended to be executed with ``gnome-desktop-testing``. For information on setting up and running ptests, see the -":ref:`dev-manual/packages:testing packages with ptest`" +":ref:`test-manual/ptest:testing packages with ptest`" section in the Yocto Project Development Tasks Manual. .. _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: - *ptest:* Enables building the package tests where supported by individual recipes. For more information on package tests, see the - ":ref:`dev-manual/packages:testing packages with ptest`" section + ":ref:`test-manual/ptest:testing packages with ptest`" section in the Yocto Project Development Tasks Manual. - *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 This check will detect if the source of the package contains some upstream-provided tests and, if so, that ptests are implemented for this - recipe. See the ":ref:`dev-manual/packages:testing packages with ptest`" + recipe. See the ":ref:`test-manual/ptest:testing packages with ptest`" section in the Yocto Project Development Tasks Manual. See also the ":ref:`ref-classes-ptest`" section. 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: operation and functions. However, the test can also use the IP address of a machine to test. -- :ref:`ptest `: +- :ref:`ptest `: Runs tests against packages produced during the build for a given piece of software. The test allows the packages to be run within a 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. :term:`PTEST_ENABLED` Specifies whether or not :ref:`Package - Test ` (ptest) + Test ` (ptest) functionality is enabled when building a recipe. You should not set this variable directly. Enabling and disabling building Package Tests at build time should be done by adding "ptest" to (or removing it -- cgit v1.2.3-54-g00ecf