| Message ID | 20250123-ptest-common-classes-v2-1-71d6f80573b9@bootlin.com |
|---|---|
| State | Under Review |
| Headers | show |
| Series | [yocto-docs,v2] test-manual/ptest: link to common framework ptest classes | expand |
Hi Antonin, On 1/23/25 4:48 PM, Antonin Godard wrote: > 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> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de> Thanks! Quentin
diff --git a/documentation/test-manual/ptest.rst b/documentation/test-manual/ptest.rst index dea1bad23bd98817a2020030efdad7ce4e4b36c0..2c021af5151a1d0269d99a51b7ec0a98d78b4f82 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: inherit ptest + .. note:: + + Classes for common frameworks already exist in :term:`OpenEmbedded-Core + (OE-Core)`, such as: + + - :oe_git:`go-ptest </openembedded-core/tree/meta/classes-recipe/go-ptest.bbclass>` + - :ref:`ref-classes-ptest-cargo` + - :ref:`ref-classes-ptest-gnome` + - :oe_git:`ptest-perl </openembedded-core/tree/meta/classes-recipe/ptest-perl.bbclass>` + - :oe_git:`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
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> --- Changes in v2: - Fix typo reported by Quentin Schulz - When possible, link to ref-classes-ptest-* - Add link to ptest-gnome - Use :term: for oecore - Link to v1: https://lore.kernel.org/r/20250117-ptest-common-classes-v1-1-043c7fd46da5@bootlin.com --- documentation/test-manual/ptest.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) --- base-commit: 8bd2bc3c00ca80f4c000a2a8d618a9f8ea3aa54b change-id: 20250117-ptest-common-classes-25e9b4dc0968 Best regards,