diff mbox series

[yocto-docs] test-manual/ptest: link to common framework ptest classes

Message ID 20250117-ptest-common-classes-v1-1-043c7fd46da5@bootlin.com
State Under Review
Headers show
Series [yocto-docs] test-manual/ptest: link to common framework ptest classes | expand

Commit Message

Antonin Godard Jan. 17, 2025, 2:19 p.m. UTC 
We document how to add ptest support for a recipe by inheriting the
ptest class. We may as well tell the user to inherit a ptest class for a
common framework which does most of the job for you.

Suggested-by: Quentin Schulz <quentin.schulz@cherry.de>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/test-manual/ptest.rst | 13 +++++++++++++
 1 file changed, 13 insertions(+)


---
base-commit: 6b44257874858db3aa426d3e84a79c41cb4937a3
change-id: 20250117-ptest-common-classes-25e9b4dc0968

Best regards,
diff mbox series

Patch

diff --git a/documentation/test-manual/ptest.rst b/documentation/test-manual/ptest.rst
index dea1bad23bd98817a2020030efdad7ce4e4b36c0..d5a0d007ac118ced77c06b141d4e681f81e60cd2 100644
--- a/documentation/test-manual/ptest.rst
+++ b/documentation/test-manual/ptest.rst
@@ -61,6 +61,19 @@  test. Here is what you have to do for each recipe:
 
       inherit ptest
 
+   .. note::
+
+      Existing class for common frameworks already exist in
+      :oe_git:`openembedded-core </openembedded-core>`, such as:
+
+      -  :oe_git:`meta/classes-recipe/go-ptest </openembedded-core/tree/meta/classes-recipe/go-ptest.bbclass>`
+      -  :oe_git:`meta/classes-recipe/ptest-cargo </openembedded-core/tree/meta/classes-recipe/ptest-cargo.bbclass>`
+      -  :oe_git:`meta/classes-recipe/ptest-perl </openembedded-core/tree/meta/classes-recipe/ptest-perl.bbclass>`
+      -  :oe_git:`meta/classes-recipe/ptest-python-pytest </openembedded-core/tree/meta/classes-recipe/ptest-python-pytest.bbclass>`
+
+      Inheriting these classes with the ``inherit`` keyword in your recipe will
+      make the next steps automatic.
+
 -  *Create run-ptest:* This script starts your test. Locate the
    script where you will refer to it using
    :term:`SRC_URI`. Here is an