summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2024-12-26 16:20:16 +0100
committerSteve Sakoman <steve@sakoman.com>2025-01-09 06:25:36 -0800
commit3f782b6e4527d5b02cc98203b0fb79620b6a89df (patch)
tree8eae2524c9aab854a24414d1f9069bf04adf40b7 /documentation/ref-manual
parentda6fec8a1da6b22e1cd28ba638ff4b9e4777630e (diff)
downloadpoky-3f782b6e4527d5b02cc98203b0fb79620b6a89df.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: 110e15c4407dfc03c7d931e4488eb43dbfad7570) 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.rst4
-rw-r--r--documentation/ref-manual/features.rst2
-rw-r--r--documentation/ref-manual/qa-checks.rst2
-rw-r--r--documentation/ref-manual/release-process.rst2
-rw-r--r--documentation/ref-manual/variables.rst2
5 files changed, 6 insertions, 6 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 8c3cc0140f..f416a6d623 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2615,7 +2615,7 @@ runtime tests for recipes that build software that provides these tests.
2615This class is intended to be inherited by individual recipes. However, 2615This class is intended to be inherited by individual recipes. However,
2616the class' functionality is largely disabled unless "ptest" appears in 2616the class' functionality is largely disabled unless "ptest" appears in
2617:term:`DISTRO_FEATURES`. See the 2617:term:`DISTRO_FEATURES`. See the
2618":ref:`dev-manual/packages:testing packages with ptest`" 2618":ref:`test-manual/ptest:testing packages with ptest`"
2619section in the Yocto Project Development Tasks Manual for more information 2619section in the Yocto Project Development Tasks Manual for more information
2620on ptest. 2620on ptest.
2621 2621
@@ -2639,7 +2639,7 @@ Enables package tests (ptests) specifically for GNOME packages, which
2639have tests intended to be executed with ``gnome-desktop-testing``. 2639have tests intended to be executed with ``gnome-desktop-testing``.
2640 2640
2641For information on setting up and running ptests, see the 2641For information on setting up and running ptests, see the
2642":ref:`dev-manual/packages:testing packages with ptest`" 2642":ref:`test-manual/ptest:testing packages with ptest`"
2643section in the Yocto Project Development Tasks Manual. 2643section in the Yocto Project Development Tasks Manual.
2644 2644
2645.. _ref-classes-python3-dir: 2645.. _ref-classes-python3-dir:
diff --git a/documentation/ref-manual/features.rst b/documentation/ref-manual/features.rst
index b2ba731bb2..face6c1062 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 869100ce34..200def084f 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -6828,7 +6828,7 @@ system and gives an overview of their function and contents.
6828 6828
6829 :term:`PTEST_ENABLED` 6829 :term:`PTEST_ENABLED`
6830 Specifies whether or not :ref:`Package 6830 Specifies whether or not :ref:`Package
6831 Test <dev-manual/packages:testing packages with ptest>` (ptest) 6831 Test <test-manual/ptest:testing packages with ptest>` (ptest)
6832 functionality is enabled when building a recipe. You should not set 6832 functionality is enabled when building a recipe. You should not set
6833 this variable directly. Enabling and disabling building Package Tests 6833 this variable directly. Enabling and disabling building Package Tests
6834 at build time should be done by adding "ptest" to (or removing it 6834 at build time should be done by adding "ptest" to (or removing it