summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/classes.rst
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2025-03-25 10:20:45 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-03-27 15:25:05 +0000
commit7e822e13de6b85e156d3508f076f580e63dda01e (patch)
treefff3b281882f907040d09df2dc9b5906d1c43198 /documentation/ref-manual/classes.rst
parent498666694ff22d3d851d429f760fb5504a8995af (diff)
downloadpoky-7e822e13de6b85e156d3508f076f580e63dda01e.tar.gz
ref-manual/classes.rst: document the ptest-python-pytest class and variables
Add documentation for the ptest-python-pytest class, and the PTEST_PYTEST_DIR variable which can be overriden. (From yocto-docs rev: 1abee62c2b9f32dfa42782893940f211db930b4c) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/classes.rst')
-rw-r--r--documentation/ref-manual/classes.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 6797927fe8..8b930fe3d2 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2707,6 +2707,21 @@ For information on setting up and running ptests, see the
2707":ref:`test-manual/ptest:testing packages with ptest`" 2707":ref:`test-manual/ptest:testing packages with ptest`"
2708section in the Yocto Project Development Tasks Manual. 2708section in the Yocto Project Development Tasks Manual.
2709 2709
2710.. _ref-classes-ptest-python-pytest:
2711
2712``ptest-python-pytest``
2713=======================
2714
2715The :ref:`ref-classes-ptest-python-pytest` class can be used in Python-based
2716recipes to automatically configure the :ref:`ref-classes-ptest` class for Python
2717packages leveraging the `pytest <https://docs.pytest.org>`__ unit test framework.
2718
2719Within the recipe, the :term:`PTEST_PYTEST_DIR` variable can be overridden to
2720specify the path to the directory containing the tests (default value:
2721``tests``). Test contained in this directory are installed in :term:`D` by the
2722:ref:`ref-tasks-install_ptest_base` task, as well as a specific ``run-ptest``
2723script for this task.
2724
2710.. _ref-classes-python3-dir: 2725.. _ref-classes-python3-dir:
2711 2726
2712``python3-dir`` 2727``python3-dir``