summaryrefslogtreecommitdiffstats
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:29:51 +0100
commita287584563263bcdbf6d1e7268cf52e894860942 (patch)
tree16e5ab79a2af1187799280d88371d3a26bfdd5c2
parente894acce6ede8bedafc1859ea0345ee6d80e9c74 (diff)
downloadpoky-a287584563263bcdbf6d1e7268cf52e894860942.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>
-rw-r--r--documentation/ref-manual/classes.rst7
-rw-r--r--documentation/ref-manual/variables.rst2
2 files changed, 4 insertions, 5 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
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 62e339ed81..794440b9fd 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7159,7 +7159,7 @@ system and gives an overview of their function and contents.
7159 :term:`PTEST_PYTEST_DIR` 7159 :term:`PTEST_PYTEST_DIR`
7160 Within the :ref:`ref-classes-ptest-python-pytest` class, the 7160 Within the :ref:`ref-classes-ptest-python-pytest` class, the
7161 :term:`PTEST_PYTEST_DIR` variable represents the path within the source 7161 :term:`PTEST_PYTEST_DIR` variable represents the path within the source
7162 tree of a Python package holding the unit tests to be tested with the 7162 tree of a Python package holding the unit tests to be run with the
7163 `pytest <https://docs.pytest.org>`__ framework. The default value for this 7163 `pytest <https://docs.pytest.org>`__ framework. The default value for this
7164 variable is ``tests``. 7164 variable is ``tests``.
7165 7165