diff mbox series

QA, ptest: Add documentation of unimplemented-ptest QA check

Message ID 20231003090430.692589-1-yoann.congal@smile.fr
State New
Headers show
Series QA, ptest: Add documentation of unimplemented-ptest QA check | expand

Commit Message

Yoann Congal Oct. 3, 2023, 9:04 a.m. UTC 
From: Jérémy Rosen <jeremy.rosen@smile.fr>

Signed-off-by: Jérémy Rosen <jeremy.rosen@smile.fr>
Reviewed-by: Yoann Congal <yoann.congal@smile.fr>

---
NB: This is the documentation part of this not merged yet patch series :
https://lists.openembedded.org/g/openembedded-core/message/188448

 documentation/ref-manual/classes.rst   |  3 +++
 documentation/ref-manual/qa-checks.rst | 11 +++++++++++
 2 files changed, 14 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 3f0d4844e..3eede8c7b 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 ptest 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 4a02e7206..cc9afeb7c 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 [unimpemented-ptest]``
+
+    This check will detect if the source of the package contains some upstream-
+    provided tests and, if such tests are detected, 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
 ===================================