Skip to content

Commit 1296989

Browse files
authored
Merge pull request #1433 from Bastian-Krause/bst/docs-2024-06
doc/configuration: miscellaneous fixes
2 parents 0d293be + c3a3fe5 commit 1296989

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

doc/configuration.rst

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ Currently available are:
236236

237237
``ubus``
238238
Controls *PoE switches* running OpenWrt using the *ubus* interface.
239-
Further infromation available at <https://openwrt.org/docs/techref/ubus>
239+
Further information available at <https://openwrt.org/docs/techref/ubus>
240240

241241
Used by:
242242
- `NetworkPowerDriver`_
@@ -515,13 +515,13 @@ expressions.
515515

516516
Arguments:
517517
- url (str): URL to use for setting a new state
518-
- body_asserted (str): Request body to send to assert the output
519-
- body_deasserted (str): Request body to send to de-assert the output
518+
- body_asserted (str): request body to send to assert the output
519+
- body_deasserted (str): request body to send to de-assert the output
520520
- method (str, default="PUT"): HTTP method to set a new state
521521

522-
- url_get (str): URL to use instead of ``url`` for getting the state
523-
- body_get_asserted (str): Regular Expression that matches an asserted response body
524-
- body_get_deasserted (str): Regular Expression that matches a de-asserted response body
522+
- url_get (str): optional, URL to use instead of ``url`` for getting the state
523+
- body_get_asserted (str): optional, regular expression that matches an asserted response body
524+
- body_get_deasserted (str): optional, regular expression that matches a de-asserted response body
525525

526526
Used by:
527527
- `HttpDigitalOutputDriver`_
@@ -1047,7 +1047,6 @@ A :any:`USBTMC` resource describes an oscilloscope connected via the *USB TMC
10471047
protocol*.
10481048
The low-level communication is handled by the "usbtmc" kernel driver.
10491049

1050-
10511050
.. code-block:: yaml
10521051
10531052
USBTMC:
@@ -1134,7 +1133,6 @@ NetworkUSBFlashableDevice
11341133
A :any:`NetworkUSBFlashableDevice` resource describes a `USBFlashableDevice`_
11351134
resource available on a remote computer
11361135

1137-
11381136
DediprogFlasher
11391137
~~~~~~~~~~~~~~~
11401138
A :any:`DediprogFlasher` resource is used to configure the parameters to a
@@ -1199,7 +1197,7 @@ Arguments:
11991197
ASRL, TCPIP...
12001198
- url (str): device identifier on selected resource, e.g. <ip> for TCPIP
12011199
resource
1202-
- backend (str): Visa library backend, e.g. '@sim' for pyvisa-sim backend
1200+
- backend (str): optional, Visa library backend, e.g. '@sim' for pyvisa-sim backend
12031201

12041202
Used by:
12051203
- `PyVISADriver`_
@@ -1389,7 +1387,7 @@ interrupts or unix kill signals may lead to hanging containers, however;
13891387
therefore auto-cleanup is important.
13901388

13911389
Arguments:
1392-
- docker_daemon_url (str): The url of the daemon to use for this target
1390+
- docker_daemon_url (str): url of the daemon to use for this target
13931391

13941392
Used by:
13951393
- `DockerDriver`_
@@ -2213,6 +2211,7 @@ Implements:
22132211
22142212
SerialPortDigitalOutputDriver:
22152213
signal: 'dtr'
2214+
invert: false
22162215
bindings:
22172216
serial: 'nameOfSerial'
22182217
@@ -2660,7 +2659,6 @@ Binds to:
26602659
dtb: '../images/mydtb.dtb'
26612660
kernel: '../images/vmlinuz'
26622661
2663-
26642662
Implements:
26652663
- :any:`ConsoleProtocol`
26662664
- :any:`PowerProtocol`
@@ -3026,6 +3024,9 @@ The :any:`DediprogFlashDriver` is used to flash an SPI device using DediprogFlas
30263024
30273025
DediprogFlashDriver:
30283026
image: 'foo'
3027+
3028+
.. code-block:: yaml
3029+
30293030
images:
30303031
foo: '../images/image_to_load.raw'
30313032
@@ -3084,10 +3085,10 @@ Implements:
30843085
30853086
Arguments:
30863087
- image_uri (str): identifier of the docker image to use (may have a tag suffix)
3087-
- command (str): command to run in the container (optional, depends on image)
3088-
- volumes (list): list to configure volumes mounted inside the container (optional)
3088+
- command (str): optional, command to run in the container (depends on image)
3089+
- volumes (list): optional, list to configure volumes mounted inside the container
30893090
- container_name (str): name of the container
3090-
- environment (list): list of environment variables (optional)
3091+
- environment (list): optional, list of environment variables
30913092
- host_config (dict): dictionary of host configurations
30923093
- network_services (list): dictionaries that describe individual `NetworkService`_
30933094
instances that come alive when the container is created. The "address" argument

0 commit comments

Comments
 (0)