diff mbox

[v2] qemu-doc.texi: Add usb sound card info

Message ID A26195C6-FDDD-49BC-A870-E297124D554E@gmail.com
State New
Headers show

Commit Message

Programmingkid Aug. 6, 2015, 1:10 p.m. UTC
Add info on usb sound card to qemu documentation.

Signed-off-by: John Arbuckle <programmingkidx@gmail.com>

---
Changed 'thru' to 'through'

 qemu-doc.texi |    5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)

Comments

Markus Armbruster Aug. 8, 2015, 6:04 a.m. UTC | #1
Copying USB maintainer...

Programmingkid <programmingkidx@gmail.com> writes:

> Add info on usb sound card to qemu documentation.
>
> Signed-off-by: John Arbuckle <programmingkidx@gmail.com>
>
> ---
> Changed 'thru' to 'through'
>
>  qemu-doc.texi |    5 ++++-
>  1 files changed, 4 insertions(+), 1 deletions(-)
>
> diff --git a/qemu-doc.texi b/qemu-doc.texi
> index 0125bc7..9a8f353 100644
> --- a/qemu-doc.texi
> +++ b/qemu-doc.texi
> @@ -1328,7 +1328,8 @@ as necessary to connect multiple USB devices.
>  @subsection Connecting USB devices
>  
>  USB devices can be connected with the @option{-usbdevice} commandline option
> -or the @code{usb_add} monitor command.  Available devices are:
> +or the @code{usb_add} monitor command. Note: some devices may only work if
> +added like this: -usb -device <usb device>. Available devices are:

I'm afraid "may only work" is a bit misleading.  All of them work with
-device.  Old ones are also supported by -usbdevice for backward
compatibility.  The whole section should be rewritten to point to
-device instead of legacy -usbdevice, but that's no reason to hold up
your patch.

I'd just drop this hunk for now.  Suboptimal, but I can't think of a
better way short of doing the rewrite.  Perhaps Gerd can.

> +or the @code{usb_add} monitor command. Note: some devices may only work if
> +added like this: -usb -device <usb device>. Available devices are:

>  @table @code
>  @item mouse
> @@ -1381,6 +1382,8 @@ usage:
>  @example
>  qemu-system-i386 [...OPTIONS...] -usbdevice bt:hci,vlan=3 -bt device:keyboard,vlan=3
>  @end example
> +@item usb-audio
> +USB sound card. Can only be used if added through the command-line like this: -usb -device usb-audio
>  @end table
>  
>  @node host_usb_devices

Long line.  Could perhaps be fixed on commit.

With the first hunk dropped and the line wrapped:

Reviewed-by: Markus Armbruster <armbru@redhat.com>
Programmingkid Aug. 8, 2015, 12:48 p.m. UTC | #2
On Aug 8, 2015, at 2:04 AM, Markus Armbruster wrote:

> Copying USB maintainer...
> 
> Programmingkid <programmingkidx@gmail.com> writes:
> 
>> Add info on usb sound card to qemu documentation.
>> 
>> Signed-off-by: John Arbuckle <programmingkidx@gmail.com>
>> 
>> ---
>> Changed 'thru' to 'through'
>> 
>> qemu-doc.texi |    5 ++++-
>> 1 files changed, 4 insertions(+), 1 deletions(-)
>> 
>> diff --git a/qemu-doc.texi b/qemu-doc.texi
>> index 0125bc7..9a8f353 100644
>> --- a/qemu-doc.texi
>> +++ b/qemu-doc.texi
>> @@ -1328,7 +1328,8 @@ as necessary to connect multiple USB devices.
>> @subsection Connecting USB devices
>> 
>> USB devices can be connected with the @option{-usbdevice} commandline option
>> -or the @code{usb_add} monitor command.  Available devices are:
>> +or the @code{usb_add} monitor command. Note: some devices may only work if
>> +added like this: -usb -device <usb device>. Available devices are:
> 
> I'm afraid "may only work" is a bit misleading.  All of them work with
> -device.  Old ones are also supported by -usbdevice for backward
> compatibility.  The whole section should be rewritten to point to
> -device instead of legacy -usbdevice, but that's no reason to hold up
> your patch.

I did not know -usbdevice was considered legacy. If that is the case, then it should probably
be removed from the documentation in favor for -usb -device <device name>. 

A patch should be made that would allow all USB devices to be added using the usb_add
monitor command. 

> I'd just drop this hunk for now.  Suboptimal, but I can't think of a
> better way short of doing the rewrite.  Perhaps Gerd can.
> 
>> +or the @code{usb_add} monitor command. Note: some devices may only work if
>> +added like this: -usb -device <usb device>. Available devices are:
> 
>> @table @code
>> @item mouse
>> @@ -1381,6 +1382,8 @@ usage:
>> @example
>> qemu-system-i386 [...OPTIONS...] -usbdevice bt:hci,vlan=3 -bt device:keyboard,vlan=3
>> @end example
>> +@item usb-audio
>> +USB sound card. Can only be used if added through the command-line like this: -usb -device usb-audio
>> @end table
>> 
>> @node host_usb_devices
> 
> Long line.  Could perhaps be fixed on commit.
> 
> With the first hunk dropped and the line wrapped:
> 
> Reviewed-by: Markus Armbruster <armbru@redhat.com>
diff mbox

Patch

diff --git a/qemu-doc.texi b/qemu-doc.texi
index 0125bc7..9a8f353 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -1328,7 +1328,8 @@  as necessary to connect multiple USB devices.
 @subsection Connecting USB devices
 
 USB devices can be connected with the @option{-usbdevice} commandline option
-or the @code{usb_add} monitor command.  Available devices are:
+or the @code{usb_add} monitor command. Note: some devices may only work if
+added like this: -usb -device <usb device>. Available devices are:
 
 @table @code
 @item mouse
@@ -1381,6 +1382,8 @@  usage:
 @example
 qemu-system-i386 [...OPTIONS...] -usbdevice bt:hci,vlan=3 -bt device:keyboard,vlan=3
 @end example
+@item usb-audio
+USB sound card. Can only be used if added through the command-line like this: -usb -device usb-audio
 @end table
 
 @node host_usb_devices