mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-01-29 21:08:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual/classes: ptest-python-pytest: improve the current documentation

Browse Source 
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>
This commit is contained in:
Antonin Godard
2025-04-03 15:33:14 +02:00
committed by Richard Purdie
parent e894acce6e
commit a287584563
2 changed files with 4 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
documentation/ref-manual/classes.rst
View File

@@ -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 <https://docs.pytest.org>`__ 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.

2
documentation/ref-manual/variables.rst
View File

@@ -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 <https://docs.pytest.org>`__ framework. The default value for this
variable is ``tests``.