Skip to content

Commit c9bbdd7

Browse files
jluebbejluebbe
committed
doc: remove unneccessary quotes in yaml examples
For ID_SERIAL_SHORT and ID_PATH with @ (parent match), no quote is needed to mark it as a string. This now matches the output from labgrid-suggest. Signed-off-by: Jan Luebbe <[email protected]>
1 parent 89961fa commit c9bbdd7

File tree

2 files changed

+24
-24
lines changed

2 files changed

+24
-24
lines changed

‎doc/configuration.rst‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ This allows identification through hot-plugging or rebooting.
7474
7575
USBSerialPort:
7676
match:
77-
'ID_SERIAL_SHORT': 'P-00-00682'
77+
ID_SERIAL_SHORT: P-00-00682
7878
speed: 115200
7979
8080
The example would search for a USB serial converter with the key
@@ -431,7 +431,7 @@ A USBMassStorage resource describes a USB memory stick or similar device.
431431
432432
USBMassStorage:
433433
match:
434-
'ID_PATH': 'pci-0000:06:00.0-usb-0:1.3.2:1.0-scsi-0:0:0:3'
434+
ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0-scsi-0:0:0:3
435435
436436
- match (str): key and value for a udev match, see `udev Matching`_
437437

@@ -474,7 +474,7 @@ An IMXUSBLoader resource describes a USB device in the imx loader state.
474474
475475
IMXUSBLoader:
476476
match:
477-
'ID_PATH': 'pci-0000:06:00.0-usb-0:1.3.2:1.0'
477+
ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
478478
479479
- match (str): key and value for a udev match, see `udev Matching`_
480480

@@ -490,7 +490,7 @@ An MXSUSBLoader resource describes a USB device in the mxs loader state.
490490
491491
MXSUSBLoader:
492492
match:
493-
'ID_PATH': 'pci-0000:06:00.0-usb-0:1.3.2:1.0'
493+
ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
494494
495495
- match (str): key and value for a udev match, see `udev Matching`_
496496

@@ -506,7 +506,7 @@ An RKUSBLoader resource describes a USB device in the rockchip loader state.
506506
507507
RKUSBLoader:
508508
match:
509-
'sys_name': '1-3'
509+
sys_name: '1-3'
510510
511511
- match (str): key and value for a udev match, see `udev Matching`_
512512

@@ -533,7 +533,7 @@ An AndroidFastboot resource describes a USB device in the fastboot state.
533533
534534
AndroidFastboot:
535535
match:
536-
'ID_PATH': 'pci-0000:06:00.0-usb-0:1.3.2:1.0'
536+
ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
537537
538538
- match (str): key and value for a udev match, see `udev Matching`_
539539

@@ -549,7 +549,7 @@ Ethernet or WiFi)
549549
550550
USBNetworkInterface:
551551
match:
552-
'ID_PATH': 'pci-0000:06:00.0-usb-0:1.3.2:1.0'
552+
ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
553553
554554
- match (str): key and value for a udev match, see `udev Matching`_
555555

@@ -566,7 +566,7 @@ An AlteraUSBBlaster resource describes an Altera USB blaster.
566566
567567
AlteraUSBBlaster:
568568
match:
569-
'ID_PATH': 'pci-0000:06:00.0-usb-0:1.3.2:1.0'
569+
ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
570570
571571
- match (dict): key and value for a udev match, see `udev Matching`_
572572

@@ -583,7 +583,7 @@ FT2232H).
583583
584584
USBDebugger:
585585
match:
586-
ID_PATH: 'pci-0000:00:10.0-usb-0:1.4'
586+
ID_PATH: pci-0000:00:10.0-usb-0:1.4
587587
588588
- match (dict): key and value for a udev match, see `udev Matching`_
589589

@@ -614,7 +614,7 @@ A SigrokUSBDevice resource describes a sigrok USB device.
614614
driver: fx2lafw
615615
channel: "D0=CLK,D1=DATA"
616616
match:
617-
'ID_PATH': 'pci-0000:06:00.0-usb-0:1.3.2:1.0'
617+
ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
618618
619619
- driver (str): name of the sigrok driver to use
620620
- channel (str): optional, channel mapping as described in the sigrok-cli man page
@@ -634,7 +634,7 @@ host which is exported over the network. The SigrokDriver will access it via SSH
634634
driver: fx2lafw
635635
channel: "D0=CLK,D1=DATA"
636636
match:
637-
'ID_PATH': 'pci-0000:06:00.0-usb-0:1.3.2:1.0'
637+
ID_PATH: pci-0000:06:00.0-usb-0:1.3.2:1.0
638638
host: remote.example.computer
639639
640640
- driver (str): name of the sigrok driver to use
@@ -673,7 +673,7 @@ device.
673673
674674
USBSDMuxDevice:
675675
match:
676-
'@ID_PATH': 'pci-0000:00:14.0-usb-0:1.2'
676+
'@ID_PATH': pci-0000:00:14.0-usb-0:1.2
677677
678678
- match (str): key and value for a udev match, see `udev Matching`_
679679

@@ -694,7 +694,7 @@ A :any:`LXAUSBMux` resource describes a Linux Automation GmbH USB-Mux device.
694694
695695
LXAUSBMux:
696696
match:
697-
'@ID_PATH': 'pci-0000:00:14.0-usb-0:1.2'
697+
'@ID_PATH': pci-0000:00:14.0-usb-0:1.2
698698
699699
- match (str): key and value for a udev match, see `udev Matching`_
700700

@@ -717,7 +717,7 @@ device.
717717
718718
USBSDWireDevice:
719719
match:
720-
'@ID_PATH': 'pci-0000:00:14.0-usb-0:1.2'
720+
'@ID_PATH': pci-0000:00:14.0-usb-0:1.2
721721
722722
- match (str): key and value for a udev match, see `udev Matching`_
723723

@@ -740,7 +740,7 @@ Video4Linux2 kernel driver.
740740
741741
USBVideo:
742742
match:
743-
'@ID_PATH': 'pci-0000:00:14.0-usb-0:1.2'
743+
'@ID_PATH': pci-0000:00:14.0-usb-0:1.2
744744
745745
- match (str): key and value for a udev match, see `udev Matching`_
746746

@@ -802,7 +802,7 @@ The low-level communication is handled by the ``usbtmc`` kernel driver.
802802
803803
USBTMC:
804804
match:
805-
'@ID_PATH': 'pci-0000:00:14.0-usb-0:1.2'
805+
'@ID_PATH': pci-0000:00:14.0-usb-0:1.2
806806
807807
- match (str): key and value for a udev match, see `udev Matching`_
808808

@@ -864,7 +864,7 @@ running a flashing program with `FlashScriptDriver`_.
864864
865865
USBFlashableDevice:
866866
match:
867-
SUBSYSTEM: 'usb'
867+
SUBSYSTEM: usb
868868
ID_SERIAL: '1234'
869869
870870
- match (str): key and value pairs for a udev match, see `udev Matching`_
@@ -920,7 +920,7 @@ A :any:`HTTPVideoStream` resource describes a IP video stream over HTTP or HTTPS
920920
.. code-block:: yaml
921921
922922
HTTPVideoStream:
923-
url: 'http://192.168.110.11/0.ts'
923+
url: http://192.168.110.11/0.ts
924924
925925
- url (str): URI of the IP video stream
926926

@@ -1009,7 +1009,7 @@ created through interaction with that daemon.
10091009
.. code-block:: yaml
10101010
10111011
DockerDaemon:
1012-
docker_daemon_url: 'unix://var/run/docker.sock'
1012+
docker_daemon_url: unix://var/run/docker.sock
10131013
10141014
The example describes a docker daemon accessible via the
10151015
'/var/run/docker.sock' unix socket. When used by a `DockerDriver`, the
@@ -1099,7 +1099,7 @@ don't use a parent match.
10991099
11001100
AndroidFastboot:
11011101
match:
1102-
'sys_name': '1-1.2.3'
1102+
sys_name: '1-1.2.3'
11031103
11041104
Matching a Specific UART in a Dual-Port Adapter
11051105
+++++++++++++++++++++++++++++++++++++++++++++++
@@ -1151,7 +1151,7 @@ We use the ``ID_USB_INTERFACE_NUM`` to distinguish between the two ports:
11511151
USBSerialPort:
11521152
match:
11531153
'@sys_name': '3-10.2.2.2'
1154-
'ID_USB_INTERFACE_NUM': '01'
1154+
ID_USB_INTERFACE_NUM: '01'
11551155
11561156
Matching a USB UART by Serial Number
11571157
++++++++++++++++++++++++++++++++++++
@@ -1165,7 +1165,7 @@ changes or a board has been moved between host systems.
11651165
11661166
USBSerialPort:
11671167
match:
1168-
'ID_SERIAL_SHORT': 'P-00-03564'
1168+
ID_SERIAL_SHORT: P-00-03564
11691169
11701170
To check if your device has a serial number, you can use ``udevadm info``:
11711171

@@ -1243,7 +1243,7 @@ Implements:
12431243
ShellDriver:
12441244
prompt: 'root@\w+:[^ ]+ '
12451245
login_prompt: ' login: '
1246-
username: 'root'
1246+
username: root
12471247
12481248
Arguments:
12491249
- prompt (regex): shell prompt to match after logging in

‎doc/getting_started.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ Additional groups and resources can be added:
228228
location: example-location
229229
USBSerialPort:
230230
match:
231-
'ID_SERIAL_SHORT': 'P-00-00682'
231+
ID_SERIAL_SHORT: P-00-00682
232232
speed: 115200
233233
NetworkPowerPort:
234234
model: netio

0 commit comments

Comments
 (0)