summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2025-01-23 16:48:03 +0100
committerSteve Sakoman <steve@sakoman.com>2025-01-29 06:20:44 -0800
commitbcff406b2829ec792a690e31c6f6254d0c66fd7a (patch)
tree061e44447c399938949db8cc4dafeafc43869a1c
parentedcb76934dcf5759f8e15fccac560175ddcebc9d (diff)
downloadpoky-bcff406b2829ec792a690e31c6f6254d0c66fd7a.tar.gz
test-manual/ptest: link to common framework ptest classes
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> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: eb44bae3071b751820a6564f31a50ec1bfde5e42) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 411b18e489a97ea4cde05613cdd4c86deb0cb8cb) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
-rw-r--r--documentation/test-manual/ptest.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/documentation/test-manual/ptest.rst b/documentation/test-manual/ptest.rst
index dea1bad23b..2c021af515 100644
--- a/documentation/test-manual/ptest.rst
+++ b/documentation/test-manual/ptest.rst
@@ -61,6 +61,20 @@ test. Here is what you have to do for each recipe:
61 61
62 inherit ptest 62 inherit ptest
63 63
64 .. note::
65
66 Classes for common frameworks already exist in :term:`OpenEmbedded-Core
67 (OE-Core)`, such as:
68
69 - :oe_git:`go-ptest </openembedded-core/tree/meta/classes-recipe/go-ptest.bbclass>`
70 - :ref:`ref-classes-ptest-cargo`
71 - :ref:`ref-classes-ptest-gnome`
72 - :oe_git:`ptest-perl </openembedded-core/tree/meta/classes-recipe/ptest-perl.bbclass>`
73 - :oe_git:`ptest-python-pytest </openembedded-core/tree/meta/classes-recipe/ptest-python-pytest.bbclass>`
74
75 Inheriting these classes with the ``inherit`` keyword in your recipe will
76 make the next steps automatic.
77
64- *Create run-ptest:* This script starts your test. Locate the 78- *Create run-ptest:* This script starts your test. Locate the
65 script where you will refer to it using 79 script where you will refer to it using
66 :term:`SRC_URI`. Here is an 80 :term:`SRC_URI`. Here is an