diff mbox

usb: Deprecate the legacy -usbdevice option

Message ID 1495175716-12735-1-git-send-email-thuth@redhat.com
State New
Headers show

Commit Message

Thomas Huth May 19, 2017, 6:35 a.m. UTC
The '-usbdevice' option is considered as deprecated nowadays and
we might want to remove these options in a future version of QEMU.
So mark this options as deprecated in the documenation and print out
a warning if it is used to tell the user what to use instead.
While we're at it, improve also some other minor USB-related spots
in qemu-options.hx that were not up to date anymore.

Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 qemu-options.hx | 9 +++++----
 vl.c            | 2 ++
 2 files changed, 7 insertions(+), 4 deletions(-)

Comments

Paolo Bonzini May 19, 2017, 8:11 a.m. UTC | #1
On 19/05/2017 08:35, Thomas Huth wrote:
> The '-usbdevice' option is considered as deprecated nowadays and
> we might want to remove these options in a future version of QEMU.
> So mark this options as deprecated in the documenation and print out
> a warning if it is used to tell the user what to use instead.
> While we're at it, improve also some other minor USB-related spots
> in qemu-options.hx that were not up to date anymore.
> 
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  qemu-options.hx | 9 +++++----
>  vl.c            | 2 ++
>  2 files changed, 7 insertions(+), 4 deletions(-)
> 
> diff --git a/qemu-options.hx b/qemu-options.hx
> index fd31428..f688123 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -983,12 +983,12 @@ STEXI
>  ETEXI
>  
>  DEF("usb", 0, QEMU_OPTION_usb,
> -    "-usb            enable the USB driver (will be the default soon)\n",
> +    "-usb            enable the USB driver (if it is not used by default yet)\n",
>      QEMU_ARCH_ALL)
>  STEXI
>  @item -usb
>  @findex -usb
> -Enable the USB driver (will be the default soon)
> +Enable the USB driver (if it is not used by default yet).
>  ETEXI
>  
>  DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
> @@ -998,7 +998,8 @@ STEXI
>  
>  @item -usbdevice @var{devname}
>  @findex -usbdevice
> -Add the USB device @var{devname}. @xref{usb_devices}.
> +Add the USB device @var{devname}. Note that this option is deprecated,
> +please use @code{-device usb-...} instead. @xref{usb_devices}.
>  
>  @table @option
>  
> @@ -1376,7 +1377,7 @@ output such as guest graphics, guest console, and the QEMU monitor in a
>  window. With this option, you can have QEMU listen on VNC display
>  @var{display} and redirect the VGA display over the VNC session. It is
>  very useful to enable the usb tablet device when using this option
> -(option @option{-usbdevice tablet}). When using the VNC display, you
> +(option @option{-device usb-tablet}). When using the VNC display, you
>  must use the @option{-k} parameter to set the keyboard layout if you are
>  not using en-us. Valid syntax for the @var{display} is
>  
> diff --git a/vl.c b/vl.c
> index abecaf8..3ca6bd3 100644
> --- a/vl.c
> +++ b/vl.c
> @@ -3748,6 +3748,8 @@ int main(int argc, char **argv, char **envp)
>                  qemu_opts_parse_noisily(olist, "usb=on", false);
>                  break;
>              case QEMU_OPTION_usbdevice:
> +                error_report("'-usbdevice' is deprecated, please use "
> +                             "'-device usb-...' instead");
>                  olist = qemu_find_opts("machine");
>                  qemu_opts_parse_noisily(olist, "usb=on", false);
>                  add_device_config(DEV_USB, optarg);
> 

Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
diff mbox

Patch

diff --git a/qemu-options.hx b/qemu-options.hx
index fd31428..f688123 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -983,12 +983,12 @@  STEXI
 ETEXI
 
 DEF("usb", 0, QEMU_OPTION_usb,
-    "-usb            enable the USB driver (will be the default soon)\n",
+    "-usb            enable the USB driver (if it is not used by default yet)\n",
     QEMU_ARCH_ALL)
 STEXI
 @item -usb
 @findex -usb
-Enable the USB driver (will be the default soon)
+Enable the USB driver (if it is not used by default yet).
 ETEXI
 
 DEF("usbdevice", HAS_ARG, QEMU_OPTION_usbdevice,
@@ -998,7 +998,8 @@  STEXI
 
 @item -usbdevice @var{devname}
 @findex -usbdevice
-Add the USB device @var{devname}. @xref{usb_devices}.
+Add the USB device @var{devname}. Note that this option is deprecated,
+please use @code{-device usb-...} instead. @xref{usb_devices}.
 
 @table @option
 
@@ -1376,7 +1377,7 @@  output such as guest graphics, guest console, and the QEMU monitor in a
 window. With this option, you can have QEMU listen on VNC display
 @var{display} and redirect the VGA display over the VNC session. It is
 very useful to enable the usb tablet device when using this option
-(option @option{-usbdevice tablet}). When using the VNC display, you
+(option @option{-device usb-tablet}). When using the VNC display, you
 must use the @option{-k} parameter to set the keyboard layout if you are
 not using en-us. Valid syntax for the @var{display} is
 
diff --git a/vl.c b/vl.c
index abecaf8..3ca6bd3 100644
--- a/vl.c
+++ b/vl.c
@@ -3748,6 +3748,8 @@  int main(int argc, char **argv, char **envp)
                 qemu_opts_parse_noisily(olist, "usb=on", false);
                 break;
             case QEMU_OPTION_usbdevice:
+                error_report("'-usbdevice' is deprecated, please use "
+                             "'-device usb-...' instead");
                 olist = qemu_find_opts("machine");
                 qemu_opts_parse_noisily(olist, "usb=on", false);
                 add_device_config(DEV_USB, optarg);