Skip to content

Commit

Permalink
doc/configuration.rst: Fix FlashScriptDriver documentation
Browse files Browse the repository at this point in the history
The HTTPVideoDriver was accidentally put in the middle of the
FlashScriptDriver documentation, so move it back together

Signed-off-by: Joshua Watt <Joshua.Watt@garmin.com>
  • Loading branch information
JoshuaWatt committed Apr 5, 2023
1 parent 69bca20 commit a84447c
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions doc/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2598,6 +2598,17 @@ These arguments will be expanded as `Python format strings
<https://docs.python.org/3/library/string.html#format-string-syntax>`_ with the
following keys:

========== =========================================================
Key Description
========== =========================================================
``device`` The :any:`Resource` bound to the driver
``file`` The :any:`ManagedFile` used to track the flashable script
========== =========================================================

Properties of these keys can be selected using the Python format string syntax,
e.g. ``{device.devnode}`` to select the device node path of
:any:`USBFlashableDevice`

HTTPVideoDriver
~~~~~~~~~~~~~~~
The :any:`HTTPVideoDriver` is used to show a video stream over HTTP or HTTPS
Expand All @@ -2614,18 +2625,6 @@ Although the driver can be used from Python code by calling the `stream()`
method, it is currently mainly useful for the ``video`` subcommand of
``labgrid-client``.


========== =========================================================
Key Description
========== =========================================================
``device`` The :any:`Resource` bound to the driver
``file`` The :any:`ManagedFile` used to track the flashable script
========== =========================================================

Properties of these keys can be selected using the Python format string syntax,
e.g. ``{device.devnode}`` to select the device node path of
:any:`USBFlashableDevice`

XenaDriver
~~~~~~~~~~
The XenaDriver allows to use Xena networking test equipment.
Expand Down

0 comments on commit a84447c

Please sign in to comment.