Merge pull request #1697 from Bastian-Krause/bst/doc-conf-improvements

doc: describe all network resources

Author: Emantor

doc/configuration.rst

@@ -318,8 +318,8 @@ Used by:
 
 NetworkYKUSHPowerPort
 +++++++++++++++++++++
-A :any:`NetworkYKUSHPowerPort` describes a `YKUSHPowerPort`_ available on a
-remote computer.
+A :any:`NetworkYKUSHPowerPort` describes a `YKUSHPowerPort`_ resource available
+on a remote computer.
 
 USBPowerPort
 ++++++++++++
@@ -351,6 +351,11 @@ Used by:
    looking for, paths without the interface will fail to match since they use
    the ``usb`` driver.
 
+NetworkUSBPowerPort
++++++++++++++++++++
+A :any:`NetworkUSBPowerPort` describes a `USBPowerPort`_ resource available on
+a remote computer.
+
 SiSPMPowerPort
 ++++++++++++++
 A :any:`SiSPMPowerPort` describes a *GEMBIRD SiS-PM* as supported by
@@ -373,6 +378,11 @@ Arguments:
 Used by:
   - `SiSPMPowerDriver`_
 
+NetworkSiSPMPowerPort
++++++++++++++++++++++
+A :any:`NetworkSiSPMPowerPort` describes a `SiSPMPowerPort`_ resource available
+on a remote computer.
+
 TasmotaPowerPort
 ++++++++++++++++
 A :any:`TasmotaPowerPort` resource describes a switchable `Tasmota
@@ -474,6 +484,11 @@ Arguments:
 Used by:
   - `DeditecRelaisDriver`_
 
+NetworkDeditecRelais8
++++++++++++++++++++++
+A :any:`NetworkDeditecRelais8` describes a `DeditecRelais8`_ resource available
+on a remote computer.
+
 OneWirePIO
 ++++++++++
 A :any:`OneWirePIO` describes a *1-Wire* programmable I/O pin.
@@ -523,7 +538,8 @@ Used by:
 
 NetworkLXAIOBusPIO
 ++++++++++++++++++
-A :any:`NetworkLXAIOBusPIO` describes an `LXAIOBusPIO`_ exported over the network.
+A :any:`NetworkLXAIOBusPIO` describes an `LXAIOBusPIO`_ resource available on a
+remote computer.
 
 HIDRelay
 ++++++++
@@ -582,7 +598,8 @@ Used by:
 
 NetworkHIDRelay
 +++++++++++++++
-A :any:`NetworkHIDRelay` describes an `HIDRelay`_ exported over the network.
+A :any:`NetworkHIDRelay` describes an `HIDRelay`_ resource available on a
+remote computer.
 
 SysfsGPIO
 +++++++++
@@ -600,6 +617,11 @@ Arguments:
 Used by:
   - `GpioDigitalOutputDriver`_
 
+NetworkSysfsGPIO
+++++++++++++++++
+A :any:`NetworkSysfsGPIO` describes a `SysfsGPIO`_ resource available on a
+remote computer.
+
 MatchedSysfsGPIO
 ++++++++++++++++
 A :any:`MatchedSysfsGPIO` describes a GPIO line, like a `SysfsGPIO`_.
@@ -684,11 +706,8 @@ Used by:
 
 NetworkUSBMassStorage
 ~~~~~~~~~~~~~~~~~~~~~
-A :any:`NetworkUSBMassStorage` resource describes a USB memory stick or similar
-device available on a remote computer.
-
-The NetworkUSBMassStorage can be used in test cases by calling the
-``write_files()``, ``write_image()``, and ``get_size()`` functions.
+A :any:`NetworkUSBMassStorage` resource describes `USBMassStorage`_ resource
+available on a remote computer.
 
 SigrokDevice
 ~~~~~~~~~~~~
@@ -768,18 +787,18 @@ Used by:
 
 NetworkMXSUSBLoader
 ~~~~~~~~~~~~~~~~~~~
-A :any:`NetworkMXSUSBLoader` describes an `MXSUSBLoader`_ available on a remote
-computer.
+A :any:`NetworkMXSUSBLoader` describes an `MXSUSBLoader`_ resource available on
+a remote computer.
 
 NetworkIMXUSBLoader
 ~~~~~~~~~~~~~~~~~~~
-A :any:`NetworkIMXUSBLoader` describes an `IMXUSBLoader`_ available on a remote
-computer.
+A :any:`NetworkIMXUSBLoader` describes an `IMXUSBLoader`_ resource available on
+a remote computer.
 
 NetworkRKUSBLoader
 ~~~~~~~~~~~~~~~~~~
-A :any:`NetworkRKUSBLoader` describes an `RKUSBLoader`_ available on a remote
-computer.
+A :any:`NetworkRKUSBLoader` describes an `RKUSBLoader`_ resource available on a
+remote computer.
 
 AndroidUSBFastboot
 ~~~~~~~~~~~~~~~~~~
@@ -804,6 +823,11 @@ Arguments:
 Used by:
   - `AndroidFastbootDriver`_
 
+RemoteAndroidUSBFastboot
+~~~~~~~~~~~~~~~~~~~~~~~~
+A :any:`RemoteAndroidUSBFastboot` describes a `AndroidUSBFastboot`_ resource
+available on a remote computer.
+
 AndroidNetFastboot
 ~~~~~~~~~~~~~~~~~~
 An :any:`AndroidNetFastboot` resource describes a network device in *Fastboot
@@ -824,6 +848,11 @@ Arguments:
 Used by:
   - `AndroidFastbootDriver`_
 
+RemoteAndroidNetFastboot
+~~~~~~~~~~~~~~~~~~~~~~~~
+A :any:`RemoteAndroidNetFastboot` describes an `AndroidNetFastboot`_ resource
+available on a remote computer.
+
 DFUDevice
 ~~~~~~~~~
 A :any:`DFUDevice` resource describes a USB device in DFU (Device Firmware
@@ -841,6 +870,11 @@ Arguments:
 Used by:
   - `DFUDriver`_
 
+NetworkDFUDevice
+~~~~~~~~~~~~~~~~
+A :any:`NetworkDFUDevice` describes a `DFUDevice`_ resource available on a
+remote computer.
+
 NetworkInterface
 ~~~~~~~~~~~~~~~~
 A :any:`NetworkInterface` resource describes a network adapter (such as
@@ -898,6 +932,11 @@ Used by:
   - `OpenOCDDriver`_
   - `QuartusHPSDriver`_
 
+NetworkAlteraUSBBlaster
+~~~~~~~~~~~~~~~~~~~~~~~
+A :any:`NetworkAlteraUSBBlaster` describes an `AlteraUSBBlaster`_ resource
+available on a remote computer.
+
 USBDebugger
 ~~~~~~~~~~~
 A :any:`USBDebugger` resource describes a JTAG USB adapter (for example an
@@ -915,6 +954,11 @@ Arguments:
 Used by:
   - `OpenOCDDriver`_
 
+NetworkUSBDebugger
+~~~~~~~~~~~~~~~~~~
+A :any:`NetworkUSBDebugger` describes a `USBDebugger`_ resource available on a
+remote computer.
+
 SNMPEthernetPort
 ~~~~~~~~~~~~~~~~
 A :any:`SNMPEthernetPort` resource describes a port on an Ethernet switch,
@@ -958,9 +1002,8 @@ Used by:
 
 NetworkSigrokUSBDevice
 ~~~~~~~~~~~~~~~~~~~~~~
-A :any:`NetworkSigrokUSBDevice` resource describes a *Sigrok* USB device
-connected to a host which is exported over the network.
-The `SigrokDriver`_ will access it via SSH.
+A :any:`NetworkSigrokUSBDevice` describes a `SigrokUSBDevice`_ resource
+available on a remote computer.
 
 SigrokUSBSerialDevice
 ~~~~~~~~~~~~~~~~~~~~~
@@ -987,6 +1030,11 @@ Used by:
   - `SigrokPowerDriver`_
   - `SigrokDmmDriver`_
 
+NetworkSigrokUSBSerialDevice
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+A :any:`NetworkSigrokUSBSerialDevice` describes a `SigrokUSBSerialDevice`_
+resource available on a remote computer.
+
 USBSDMuxDevice
 ~~~~~~~~~~~~~~
 A :any:`USBSDMuxDevice` resource describes a Pengutronix
@@ -1008,8 +1056,8 @@ Used by:
 
 NetworkUSBSDMuxDevice
 ~~~~~~~~~~~~~~~~~~~~~
-A :any:`NetworkUSBSDMuxDevice` resource describes a `USBSDMuxDevice`_ available
-on a remote computer.
+A :any:`NetworkUSBSDMuxDevice` resource describes a `USBSDMuxDevice`_ resource
+available on a remote computer.
 
 LXAUSBMux
 ~~~~~~~~~
@@ -1029,8 +1077,8 @@ Used by:
 
 NetworkLXAUSBMux
 ~~~~~~~~~~~~~~~~
-A :any:`NetworkLXAUSBMux` resource describes an `LXAUSBMux`_ available on a
-remote computer.
+A :any:`NetworkLXAUSBMux` resource describes an `LXAUSBMux`_ resource available
+on a remote computer.
 
 USBSDWireDevice
 ~~~~~~~~~~~~~~~
@@ -1052,8 +1100,8 @@ Used by:
 
 NetworkUSBSDWireDevice
 ~~~~~~~~~~~~~~~~~~~~~~
-A :any:`NetworkUSBSDWireDevice` resource describes a `USBSDWireDevice`_ available
-on a remote computer.
+A :any:`NetworkUSBSDWireDevice` resource describes a `USBSDWireDevice`_
+resource available on a remote computer.
 
 USBVideo
 ~~~~~~~~
@@ -1162,7 +1210,8 @@ Used by:
 
 NetworkFlashrom
 ~~~~~~~~~~~~~~~
-A :any:`NetworkFlashrom` describes a `Flashrom`_ available on a remote computer.
+A :any:`NetworkFlashrom` describes a `Flashrom`_ resource available on a remote
+computer.
 
 USBFlashableDevice
 ~~~~~~~~~~~~~~~~~~
@@ -1191,7 +1240,7 @@ Used by:
 NetworkUSBFlashableDevice
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 A :any:`NetworkUSBFlashableDevice` resource describes a `USBFlashableDevice`_
-resource available on a remote computer
+resource available on a remote computer.
 
 DediprogFlasher
 ~~~~~~~~~~~~~~~
@@ -1220,8 +1269,8 @@ Used by:
 
 NetworkDediprogFlasher
 ~~~~~~~~~~~~~~~~~~~~~~
-A :any:`NetworkDediprogFlasher` describes a `DediprogFlasher`_ available on a
-remote computer.
+A :any:`NetworkDediprogFlasher` describes a `DediprogFlasher`_ resource
+available on a remote computer.
 
 XenaManager
 ~~~~~~~~~~~
@@ -1944,9 +1993,9 @@ USB or network *Fastboot state*.
 Binds to:
   fastboot:
     - `AndroidUSBFastboot`_
-    - RemoteAndroidUSBFastboot
+    - `RemoteAndroidUSBFastboot`_
     - `AndroidNetFastboot`_
-    - RemoteAndroidNetFastboot
+    - `RemoteAndroidNetFastboot`_
 
 Implements:
   - None (yet)
@@ -1974,7 +2023,7 @@ Firmware Upgrade) mode.
 Binds to:
   dfu:
     - `DFUDevice`_
-    - NetworkDFUDevice
+    - `NetworkDFUDevice`_
 
 Implements:
   - None (yet)
@@ -2002,9 +2051,9 @@ Consider updating your OpenOCD version when using multiple USB Blasters.
 Binds to:
   interface:
     - `AlteraUSBBlaster`_
-    - NetworkAlteraUSBBlaster
+    - `NetworkAlteraUSBBlaster`_
     - `USBDebugger`_
-    - NetworkUSBDebugger
+    - `NetworkUSBDebugger`_
 
 Implements:
   - :any:`BootstrapProtocol`
@@ -2037,7 +2086,7 @@ flash a target's QSPI.
 Binds to:
   interface:
     - `AlteraUSBBlaster`_
-    - NetworkAlteraUSBBlaster
+    - `NetworkAlteraUSBBlaster`_
 
 Implements:
   - None
@@ -2197,7 +2246,7 @@ target power state without user interaction.
 Binds to:
   hub:
     - `USBPowerPort`_
-    - NetworkUSBPowerPort
+    - `NetworkUSBPowerPort`_
 
 Implements:
   - :any:`PowerProtocol`
@@ -2219,7 +2268,7 @@ target power state without user interaction.
 Binds to:
   port:
     - `SiSPMPowerPort`_
-    - NetworkSiSPMPowerPort
+    - `NetworkSiSPMPowerPort`_
 
 Implements:
   - :any:`PowerProtocol`
@@ -2266,7 +2315,7 @@ Binds to:
   gpio:
     - `SysfsGPIO`_
     - `MatchedSysfsGPIO`_
-    - NetworkSysfsGPIO
+    - `NetworkSysfsGPIO`_
 
 Implements:
   - :any:`DigitalOutputProtocol`
@@ -2444,7 +2493,7 @@ It can set and get the current state of the resource.
 Binds to:
   relais:
     - `DeditecRelais8`_
-    - NetworkDeditecRelais8
+    - `NetworkDeditecRelais8`_
 
 Implements:
   - :any:`DigitalOutputProtocol`
@@ -2826,7 +2875,7 @@ control a programmable power supply.
 Binds to:
   sigrok:
     - `SigrokUSBSerialDevice`_
-    - NetworkSigrokUSBSerialDevice
+    - `NetworkSigrokUSBSerialDevice`_
 
 Implements:
   - :any:`PowerProtocol`
@@ -2857,7 +2906,7 @@ Binds to:
     - `SigrokUSBDevice`_
     - `NetworkSigrokUSBDevice`_
     - `SigrokUSBSerialDevice`_
-    - NetworkSigrokUSBSerialDevice
+    - `NetworkSigrokUSBSerialDevice`_
 
 Implements:
   - None yet