aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJérémy Rosen <jeremy.rosen@smile.fr>2023-10-10 15:51:40 +0200
committerMichael Opdenacker <michael.opdenacker@bootlin.com>2023-10-19 15:43:34 +0200
commitd90106ff2d905e457659acdb65a91ce5dcfdd05e (patch)
tree9533739c7f9e9b1c5740946047f8b4eb48c22ec4
parentbcd58d68e72226be1930593f5f7fb37de15b7913 (diff)
downloadyocto-docs-d90106ff2d905e457659acdb65a91ce5dcfdd05e.tar.gz
ref-manual: Add documentation for the unimplemented-ptest QA warning
Signed-off-by: Jérémy Rosen <jeremy.rosen@smile.fr> Reviewed-by: Yoann Congal <yoann.congal@smile.fr> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
-rw-r--r--documentation/ref-manual/classes.rst3
-rw-r--r--documentation/ref-manual/qa-checks.rst11
2 files changed, 14 insertions, 0 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 3f0d4844e8..c7a5e9a63a 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -1480,6 +1480,9 @@ Here are the tests you can list with the :term:`WARN_QA` and
also inherits :ref:`ref-classes-features_check` in order for the
requirement to actually work.
+- ``unimplemented-ptest:`` Checks that ptests are implemented for upstream
+ tests.
+
- ``unlisted-pkg-lics:`` Checks that all declared licenses applying
for a package are also declared on the recipe level (i.e. any license
in ``LICENSE:*`` should appear in :term:`LICENSE`).
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index 4a02e7206a..58526a0e57 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -789,6 +789,17 @@ Errors and Warnings
use a relative path rather than an absolute one, or to pick up the path from
runtime configuration or environment variables.
+.. _qa-check-unimplemented-ptest:
+
+- ``<tool> tests detected [unimplemented-ptest]``
+
+ 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`"
+ section in the Yocto Project Development Tasks Manual. See also the
+ ":ref:`ref-classes-ptest`" section.
+
+
Configuring and Disabling QA Checks
===================================