From a287584563263bcdbf6d1e7268cf52e894860942 Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Thu, 3 Apr 2025 15:33:14 +0200 Subject: 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 (From yocto-docs rev: a83406103ca73d84fc8f5c50a8968faf91276a62) Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/ref-manual/classes.rst | 7 +++---- documentation/ref-manual/variables.rst | 2 +- 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. ``ptest-python-pytest`` ======================= -The :ref:`ref-classes-ptest-python-pytest` class can be used in Python-based +The :ref:`ref-classes-ptest-python-pytest` class can be inherited in Python-based recipes to automatically configure the :ref:`ref-classes-ptest` class for Python packages leveraging the `pytest `__ unit test framework. -Within the recipe, the :term:`PTEST_PYTEST_DIR` variable can be overridden to -specify the path to the directory containing the tests (default value: -``tests``). Test contained in this directory are installed in :term:`D` by the +Within the recipe, the :term:`PTEST_PYTEST_DIR` variable specifies the path to +the directory containing the tests that will be installed in :term:`D` by the :ref:`ref-tasks-install_ptest_base` task, as well as a specific ``run-ptest`` script for this task. 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. :term:`PTEST_PYTEST_DIR` Within the :ref:`ref-classes-ptest-python-pytest` class, the :term:`PTEST_PYTEST_DIR` variable represents the path within the source - tree of a Python package holding the unit tests to be tested with the + tree of a Python package holding the unit tests to be run with the `pytest `__ framework. The default value for this variable is ``tests``. -- cgit v1.2.3-54-g00ecf