summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/classes.rst
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2025-04-03 15:33:14 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2025-04-03 16:28:33 +0100
commit80807dd0441a746d9efce16d661079e4624ddc1e (patch)
treeb026f7a87068f4193d282223e400bd4c10002497 /documentation/ref-manual/classes.rst
parenta6dbc53b4330d3a0bf833adaad2814c6d459f28a (diff)
downloadpoky-80807dd0441a746d9efce16d661079e4624ddc1e.tar.gz
ref-manual/classes: ptest-python-pytest: improve the current documentation
Improve the current ptest-python-pytest documentation and PTEST_PYTEST_DIR variable definition. Namely remove the default value that may evolve over time. Suggested-by: Quentin Schulz <quentin.schulz@cherry.de> (From yocto-docs rev: a83406103ca73d84fc8f5c50a8968faf91276a62) 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.rst7
1 files changed, 3 insertions, 4 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index 8b930fe3d2..59efcbe19a 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2712,13 +2712,12 @@ section in the Yocto Project Development Tasks Manual.
2712``ptest-python-pytest`` 2712``ptest-python-pytest``
2713======================= 2713=======================
2714 2714
2715The :ref:`ref-classes-ptest-python-pytest` class can be used in Python-based 2715The :ref:`ref-classes-ptest-python-pytest` class can be inherited in Python-based
2716recipes to automatically configure the :ref:`ref-classes-ptest` class for Python 2716recipes to automatically configure the :ref:`ref-classes-ptest` class for Python
2717packages leveraging the `pytest <https://docs.pytest.org>`__ unit test framework. 2717packages leveraging the `pytest <https://docs.pytest.org>`__ unit test framework.
2718 2718
2719Within the recipe, the :term:`PTEST_PYTEST_DIR` variable can be overridden to 2719Within the recipe, the :term:`PTEST_PYTEST_DIR` variable specifies the path to
2720specify the path to the directory containing the tests (default value: 2720the directory containing the tests that will be installed in :term:`D` by the
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`` 2721:ref:`ref-tasks-install_ptest_base` task, as well as a specific ``run-ptest``
2723script for this task. 2722script for this task.
2724 2723