diff mbox series

[6/7] ref-manual/variables.rst: document the TEST_SERIALCONTROL_PS1 variable

Message ID 20260630-sync-documentation-conf-v1-6-da14b40cb515@bootlin.com
State New
Headers show
Series Sync yocto-docs glossary with meta/conf/documentation.conf | expand

Commit Message

Antonin Godard June 30, 2026, 8:13 a.m. UTC 
Added by commit d817b27d73d2 ("testexport: support for executing
tests over serial") in OE-Core.

Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
 documentation/ref-manual/variables.rst | 6 ++++++
 1 file changed, 6 insertions(+)
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 20bcf8d60..d23eabad8 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -10998,6 +10998,12 @@  system and gives an overview of their function and contents.
       wish, for example, to separate the machine-specific and
       non-machine-specific parts of the command.
 
+   :term:`TEST_SERIALCONTROL_PS1`
+      For automated hardware testing with the :ref:`ref-classes-testexport`
+      class, the :term:`TEST_SERIALCONTROL_PS1` variable specifies a regex
+      string representing an empty prompt on the target terminal. For example:
+      ``root@target:.*#``.
+
    :term:`TEST_SERVER_IP`
       The IP address of the build machine (host machine). This IP address
       is usually automatically detected. However, if detection fails, this