Skip to content

Commit ecdcd5e

Browse files
committed
q-dev: update docs
1 parent a6d25ab commit ecdcd5e

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

doc/manpages/qvm-device.rst

+22-12
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Commands
4141
list
4242
^^^^
4343

44-
| :command:`qvm-device` *DEVICE_CLASS* list [-h] [--verbose] [--quiet] [-s] [*VMNAME* [*VMNAME* ...]]
44+
| :command:`qvm-device` *DEVICE_CLASS* list [-h] [--verbose] [--quiet] [*VMNAME* [*VMNAME* ...]]
4545
4646
List devices.
4747

@@ -63,9 +63,11 @@ aliases: ls, l
6363
attach
6464
^^^^^^
6565

66-
| :command:`qvm-device` *DEVICE_CLASS* attach [-h] [--verbose] [--quiet] [--ro] *VMNAME* *BACKEND_DOMAIN:DEVICE_ID*
66+
| :command:`qvm-device` *DEVICE_CLASS* attach [-h] [--verbose] [--quiet] [--ro] *VMNAME* *BACKEND_DOMAIN:PORT_ID[:DEVICE_ID]*
6767
68-
Attach the device with *DEVICE_ID* from *BACKEND_DOMAIN* to the domain *VMNAME*
68+
Attach the device from *BACKEND_DOMAIN* and port with *PORT_ID* to domain *VMNAME*.
69+
If optional *DEVICE_ID* is provided and does not match device ID of plugged device the attachment fails.
70+
The *DEVICE_ID* equals to `*` is ignored.
6971

7072
.. option:: --option, -o
7173

@@ -80,26 +82,30 @@ Attach the device with *DEVICE_ID* from *BACKEND_DOMAIN* to the domain *VMNAME*
8082

8183
.. option:: --persistent, -p
8284

83-
Alias for `assign --required` for backward compatibility.
85+
Short version for `attach` & `assign --required` for backward compatibility.
8486

8587
aliases: a, at
8688

8789
detach
8890
^^^^^^
8991

90-
| :command:`qvm-device` *DEVICE_CLASS* detach [-h] [--verbose] [--quiet] *VMNAME* *BACKEND_DOMAIN:DEVICE_ID*
92+
| :command:`qvm-device` *DEVICE_CLASS* detach [-h] [--verbose] [--quiet] *VMNAME* *BACKEND_DOMAIN:PORT_ID[:DEVICE_ID]*
9193
92-
Detach the device with *BACKEND_DOMAIN:DEVICE_ID* from domain *VMNAME*.
94+
Detach the device with *BACKEND_DOMAIN:PORT_ID* from domain *VMNAME*.
95+
If optional *DEVICE_ID* is provided and does not match device ID of plugged device the detachment fails.
96+
The *DEVICE_ID* equals to `*` is ignored.
9397
If no device is given, detach all *DEVICE_CLASS* devices.
9498

9599
aliases: d, dt
96100

97101
assign
98102
^^^^^^
99103

100-
| :command:`qvm-device` *DEVICE_CLASS* assign [-h] [--verbose] [--quiet] [--ro] *VMNAME* *BACKEND_DOMAIN:DEVICE_ID*
104+
| :command:`qvm-device` *DEVICE_CLASS* assign [-h] [--verbose] [--quiet] [--ro] *VMNAME* *BACKEND_DOMAIN:PORT_ID[:DEVICE_ID]*
101105
102-
Assign the device with *DEVICE_ID* from *BACKEND_DOMAIN* to the domain *VMNAME*
106+
Assign the device from *BACKEND_DOMAIN* and port with *PORT_ID* to domain *VMNAME*.
107+
If optional *DEVICE_ID* is not provided it device id of the plugged device is loaded.
108+
If *DEVICE_ID* is not provided and no device is currently plugged into the port, the assignment process will fail.
103109

104110
.. option:: --option, -o
105111

@@ -122,29 +128,33 @@ Assign the device with *DEVICE_ID* from *BACKEND_DOMAIN* to the domain *VMNAME*
122128

123129
.. option:: --port, --only-port
124130

125-
Ignore device presented identity and attach any device connected to the given port number.
131+
Ignore device presented identity and attach automatically any device connected to this port in the future.
132+
It is equivalent of providing `BACKEND_DOMAIN:PORT_ID:*` as argument.
126133

127134
.. option:: --device, --only-device
128135

129-
Ignore current port identity and attach this device connected to any port.
136+
Ignore the current port where the device is plugged in and ensure that this device will be attached automatically in the future, regardless of which port it is connected to.
137+
It is equivalent of providing `BACKEND_DOMAIN:*:DEVICE_ID` as argument.
130138

131139
aliases: s
132140

133141
unassign
134142
^^^^^^^^
135143

136-
| :command:`qvm-device` *DEVICE_CLASS* unassign [-h] [--verbose] [--quiet] *VMNAME* *BACKEND_DOMAIN:DEVICE_ID*
144+
| :command:`qvm-device` *DEVICE_CLASS* unassign [-h] [--verbose] [--quiet] *VMNAME* *BACKEND_DOMAIN:PORT_ID[:DEVICE_ID]*
137145
138-
Remove assignment of device with *BACKEND_DOMAIN:DEVICE_ID* from domain *VMNAME*.
146+
Remove assignment of device with *BACKEND_DOMAIN:PORT_ID:DEVICE_ID* from domain *VMNAME*.
139147
If no device is given, remove assignments of all *DEVICE_CLASS* devices.
140148

141149
.. option:: --port, --only-port
142150

143151
Remove port assignment.
152+
It is equivalent of providing `BACKEND_DOMAIN:PORT_ID:*` as argument.
144153

145154
.. option:: --device, --only-device
146155

147156
Remove device identity based assignment.
157+
It is equivalent of providing `BACKEND_DOMAIN:*:DEVICE_ID` as argument.
148158

149159
aliases: u
150160

0 commit comments

Comments
 (0)