Skip to content

Commit 2f88a5a

Browse files
doc/configuration: fix spelling inconsistencies, improve wording
Signed-off-by: Bastian Krause <bst@pengutronix.de>
1 parent 11e09f4 commit 2f88a5a

1 file changed

Lines changed: 38 additions & 37 deletions

File tree

doc/configuration.rst

Lines changed: 38 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ NetworkSerialPort
4646
+++++++++++++++++
4747
A :any:`NetworkSerialPort` describes a serial port which is exported over the
4848
network, usually using `RFC2217 <https://datatracker.ietf.org/doc/rfc2217/>`_
49-
or raw tcp.
49+
or raw TCP.
5050

5151
.. code-block:: yaml
5252
@@ -157,48 +157,48 @@ The ``model`` property selects one of several `backend implementations
157157
Currently available are:
158158

159159
``apc``
160-
Controls an *APU PDU* via SNMP.
160+
Controls *APU PDUs* via SNMP.
161161

162162
``digipower``
163-
Controls a *DigiPower PDU* via a simple HTTP API.
163+
Controls *DigiPower PDUs* via a simple HTTP API.
164164

165165
``digitalloggers_http``
166-
Control a *Digital Loggers PDUs* that use the legacy HTTP API. Note that
166+
Controls *Digital Loggers PDUs* that use the legacy HTTP API. Note that
167167
host argument must include the protocol, such as
168168
``http://192.168.0.3`` or ``http://admin:pass@192.168.0.4``.
169169

170170
``eaton``
171171
Controls *Eaton ePDUs* via SNMP.
172172

173173
``eg_pms2_network``
174-
Controls the *EG_PMS2_LAN* & *EG_PMS2_WLAN* devices, through simple HTTP POST
174+
Controls *EG_PMS2_LAN* and *EG_PMS2_WLAN* devices, through simple HTTP POST
175175
and GET requests. The device requires a password for logging into the
176176
control interface, this module deliberately uses the standard password ``1``
177177
and is not compatible with a different password.
178178

179179
``eth008``
180-
Controls a *Robot-Electronics eth008* via a simple HTTP API.
180+
Controls *Robot-Electronics eth008* via a simple HTTP API.
181181

182182
``gude``
183-
Controls a *Gude PDU* via a simple HTTP API.
183+
Controls *Gude PDUs* via a simple HTTP API.
184184

185185
``gude24``
186-
Controls a *Gude Expert Power Control 8008 PDU* via a simple HTTP API.
186+
Controls *Gude Expert Power Control 8008 PDUs* via a simple HTTP API.
187187

188188
``gude8031``
189-
Controls a *Gude Expert Power Control 8031 PDU* via a simple HTTP API.
189+
Controls *Gude Expert Power Control 8031 PDUs* via a simple HTTP API.
190190

191191
``gude8225``
192-
Controls a *Gude Expert Power Control 8225 PDUs via a simple HTTP API.
192+
Controls *Gude Expert Power Control 8225 PDUs* via a simple HTTP API.
193193

194194
``gude8316``
195-
Controls a *Gude Expert Power Control 8316 PDU* via a simple HTTP API.
195+
Controls *Gude Expert Power Control 8316 PDUs* via a simple HTTP API.
196196

197197
``netio``
198-
Controls a *NETIO 4-Port PDU* via a simple HTTP API.
198+
Controls *NETIO 4-Port PDUs* via a simple HTTP API.
199199

200200
``netio_kshell``
201-
Controls a *NETIO 4C PDU* via a Telnet interface.
201+
Controls *NETIO 4C PDUs* via a Telnet interface.
202202

203203
``raritan``
204204
Controls *Raritan PDUs* via SNMP.
@@ -211,7 +211,7 @@ Currently available are:
211211
for details.
212212

213213
``sentry``
214-
Controls a *Sentry PDU* via SNMP using Sentry3-MIB.
214+
Controls *Sentry PDUs* via SNMP using Sentry3-MIB.
215215
It was tested on *CW-24VDD* and *4805-XLS-16*.
216216

217217
``shelly_gen1``
@@ -317,7 +317,7 @@ Used by:
317317
- `USBPowerDriver`_
318318

319319
.. note::
320-
Labgrid requires that the interface is contained in the ID_PATH.
320+
labgrid requires that the interface is contained in the ID_PATH.
321321
This usually means that the ID_PATH should end with ``:1.0``.
322322
Only this first interface is registered with the ``hub`` driver labgrid is
323323
looking for, paths without the interface will fail to match since they use
@@ -473,7 +473,7 @@ A :any:`NetworkLXAIOBusPIO` describes an `LXAIOBusPIO`_ exported over the networ
473473

474474
HIDRelay
475475
++++++++
476-
An :any:`HIDRelay` resource describes a single output of a HID protocol based
476+
An :any:`HIDRelay` resource describes a single output of an HID protocol based
477477
USB relays.
478478
It currently supports the widely used *dcttech USBRelay*.
479479

@@ -495,8 +495,8 @@ Used by:
495495

496496
HttpDigitalOutput
497497
+++++++++++++++++
498-
A :any:`HttpDigitalOutput` resource describes a generic digital output that can be
499-
controlled via HTTP.
498+
An :any:`HttpDigitalOutput` resource describes a generic digital output that
499+
can be controlled via HTTP.
500500

501501
.. code-block:: yaml
502502
@@ -794,7 +794,7 @@ Used by:
794794

795795
USBDebugger
796796
~~~~~~~~~~~
797-
An :any:`USBDebugger` resource describes a JTAG USB adapter (for example an
797+
A :any:`USBDebugger` resource describes a JTAG USB adapter (for example an
798798
*FTDI FT2232H*).
799799

800800
.. code-block:: yaml
@@ -903,7 +903,7 @@ on a remote computer.
903903

904904
LXAUSBMux
905905
~~~~~~~~~
906-
A :any:`LXAUSBMux` resource describes a *Linux Automation GmbH USB-Mux* device.
906+
An :any:`LXAUSBMux` resource describes a *Linux Automation GmbH USB-Mux* device.
907907

908908
.. code-block:: yaml
909909
@@ -919,14 +919,13 @@ Used by:
919919

920920
NetworkLXAUSBMux
921921
~~~~~~~~~~~~~~~~
922-
A :any:`NetworkLXAUSBMux` resource describes a `LXAUSBMux`_ available on a
922+
A :any:`NetworkLXAUSBMux` resource describes an `LXAUSBMux`_ available on a
923923
remote computer.
924924

925925
USBSDWireDevice
926926
~~~~~~~~~~~~~~~
927927
A :any:`USBSDWireDevice` resource describes a Tizen
928-
`SD Wire device <https://wiki.tizen.org/SDWire>`_
929-
device.
928+
`SD Wire device <https://wiki.tizen.org/SDWire>`_.
930929

931930
.. code-block:: yaml
932931
@@ -949,7 +948,7 @@ on a remote computer.
949948
USBVideo
950949
~~~~~~~~
951950
A :any:`USBVideo` resource describes a USB video camera which is supported by a
952-
Video4Linux2 kernel driver.
951+
Video4Linux2 (v4l2) kernel driver.
953952

954953
.. code-block:: yaml
955954
@@ -1161,7 +1160,7 @@ Such device could be a signal generator.
11611160
url: '192.168.110.11'
11621161
11631162
Arguments:
1164-
- type (str): device resource type following the pyVISA resource syntax, e.g.
1163+
- type (str): device resource type following the PyVISA resource syntax, e.g.
11651164
ASRL, TCPIP...
11661165
- url (str): device identifier on selected resource, e.g. <ip> for TCPIP
11671166
resource
@@ -1171,7 +1170,7 @@ Used by:
11711170

11721171
HTTPVideoStream
11731172
~~~~~~~~~~~~~~~
1174-
A :any:`HTTPVideoStream` resource describes a IP video stream over HTTP or HTTPS.
1173+
An :any:`HTTPVideoStream` resource describes an IP video stream over HTTP or HTTPS.
11751174

11761175
.. code-block:: yaml
11771176
@@ -1624,7 +1623,7 @@ Arguments:
16241623

16251624
SSHDriver
16261625
~~~~~~~~~
1627-
A :any:`SSHDriver` requires a `NetworkService`_ resource and allows the
1626+
An :any:`SSHDriver` requires a `NetworkService`_ resource and allows the
16281627
execution of commands and file upload via network.
16291628
It uses SSH's ``ServerAliveInterval`` option to detect failed connections.
16301629

@@ -2234,7 +2233,7 @@ Arguments:
22342233

22352234
HIDRelayDriver
22362235
~~~~~~~~~~~~~~
2237-
A :any:`HIDRelayDriver` controls a `HIDRelay`_ or `NetworkHIDRelay`_ resource.
2236+
An :any:`HIDRelayDriver` controls an `HIDRelay`_ or `NetworkHIDRelay`_ resource.
22382237
It can set and get the current state of the resource.
22392238

22402239
Binds to:
@@ -2384,8 +2383,9 @@ Arguments:
23842383

23852384
RKUSBDriver
23862385
~~~~~~~~~~~
2387-
A :any:`RKUSBDriver` is used to upload an image into a device in the *Rockchip
2388-
USB loader state*. This is useful to bootstrap a bootloader onto a device.
2386+
An :any:`RKUSBDriver` is used to upload an image into a device in the *Rockchip
2387+
USB loader state*.
2388+
This is useful to bootstrap a bootloader onto a device.
23892389

23902390
Binds to:
23912391
loader:
@@ -2721,8 +2721,9 @@ argument being "dut", "host", "off", or "client".
27212721

27222722
LXAUSBMuxDriver
27232723
~~~~~~~~~~~~~~~
2724-
The :any:`LXAUSBMuxDriver` uses a `LXAUSBMux`_ resource to control a USB-Mux
2725-
device via the `usbmuxctl <https://github.com/linux-automation/usbmuxctl>`_ tool.
2724+
The :any:`LXAUSBMuxDriver` uses an `LXAUSBMux`_ resource to control a USB-Mux
2725+
device via the `usbmuxctl <https://github.com/linux-automation/usbmuxctl>`_
2726+
tool.
27262727

27272728
Binds to:
27282729
mux:
@@ -2789,7 +2790,7 @@ Appropriate configuration parameters can be determined by using the GStreamer
27892790

27902791
USBAudioInputDriver
27912792
~~~~~~~~~~~~~~~~~~~
2792-
The :any:`USBAudioInputDriver` is used to receive a audio stream from a local
2793+
The :any:`USBAudioInputDriver` is used to receive an audio stream from a local
27932794
or remote USB audio input.
27942795
It uses the GStreamer command line utility ``gst-launch`` on the sender side to
27952796
stream the audio to the client.
@@ -2811,7 +2812,7 @@ Arguments:
28112812

28122813
USBTMCDriver
28132814
~~~~~~~~~~~~
2814-
The :any:`USBTMCDriver` is used to control a oscilloscope via the *USB TMC
2815+
The :any:`USBTMCDriver` is used to control an oscilloscope via the *USB TMC
28152816
protocol*.
28162817

28172818
Binds to:
@@ -2835,7 +2836,7 @@ but more devices can be added by extending ``on_activate()`` in
28352836

28362837
FlashromDriver
28372838
~~~~~~~~~~~~~~
2838-
The :any:`FlashromDriver` is used to flash a rom, using the flashrom utility.
2839+
The :any:`FlashromDriver` is used to flash a ROM, using the flashrom utility.
28392840

28402841
.. code-block:: yaml
28412842
@@ -3036,8 +3037,8 @@ Arguments:
30363037

30373038
HttpDigitalOutputDriver
30383039
~~~~~~~~~~~~~~~~~~~~~~~
3039-
A :any:`HttpDigitalOutputDriver` binds to a `HttpDigitalOutput`_ to set and get
3040-
a digital output state via HTTP.
3040+
A :any:`HttpDigitalOutputDriver` binds to an `HttpDigitalOutput`_ to set and
3041+
get a digital output state via HTTP.
30413042

30423043
Binds to:
30433044
http:

0 commit comments

Comments
 (0)