diff mbox series

ref-manual: document PTEST_RUNNER_TIMEOUT variable

Message ID 20260227200241.66128-1-tim.orling@konsulko.com
State New
Headers show
Series ref-manual: document PTEST_RUNNER_TIMEOUT variable | expand

Commit Message

Tim Orling Feb. 27, 2026, 8:02 p.m. UTC 
Add PTEST_RUNNER_TIMEOUT to the variable glossary and mention it in the
testimage class documentation.

The variable was added to testimage.bbclass to control the per-suite
timeout for ptest-runner during runtime testing. It defaults to 450
seconds and can be overridden in image recipes.

Signed-off-by: Tim Orling <tim.orling@konsulko.com>
---
 documentation/ref-manual/classes.rst   |  5 +++++
 documentation/ref-manual/variables.rst | 14 ++++++++++++++
 2 files changed, 19 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index eb76c8916..7a045b6b7 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -3110,6 +3110,11 @@  after it is built, you can set :term:`TESTIMAGE_AUTO`::
 
    TESTIMAGE_AUTO = "1"
 
+The class defines :term:`PTEST_RUNNER_TIMEOUT`, which controls
+the per-suite timeout for ``ptest-runner`` during runtime testing.
+Image recipes can override this variable to adjust the timeout for
+specific images or multiconfig variants.
+
 For information on how to enable, run, and create new tests, see the
 ":ref:`test-manual/runtime-testing:performing automated runtime testing`"
 section in the Yocto Project Test Environment Manual.
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 208b5e43d..587f67cc6 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -7793,6 +7793,20 @@  system and gives an overview of their function and contents.
       For more information, see
       the :ref:`ref-classes-ptest-python-pytest` class documentation.
 
+   :term:`PTEST_RUNNER_TIMEOUT`
+      Specifies the timeout in seconds for each ptest suite executed by
+      ``ptest-runner`` during :ref:`ref-classes-testimage` runtime testing.
+      The default value is ``"450"`` (7.5 minutes).
+
+      This variable is set in the :ref:`ref-classes-testimage` class and can
+      be overridden in image recipes to adjust the timeout for specific
+      images or multiconfig variants. For example, in ``core-image-ptest``::
+
+         PTEST_RUNNER_TIMEOUT:virtclass-mcextend-python3-cffi = "600"
+
+      The value is passed to the ``ptest-runner -t`` option on the target
+      at test execution time.
+
    :term:`PV`
       The version of the recipe. The version is normally extracted from the
       recipe filename. For example, if the recipe is named