diff mbox series

qemu-options: Mark -virtioconsole as deprecated

Message ID 1525345473-31593-1-git-send-email-thuth@redhat.com
State New
Headers show
Series qemu-options: Mark -virtioconsole as deprecated | expand

Commit Message

Thomas Huth May 3, 2018, 11:04 a.m. UTC
The qemu-doc already states that this option is only maintained for
backward compatibility and "-device virtconsole" should be used
instead. So let's take the next step and mark this option officially
as deprecated.

Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 qemu-doc.texi   | 5 +++++
 qemu-options.hx | 2 +-
 vl.c            | 2 ++
 3 files changed, 8 insertions(+), 1 deletion(-)

Comments

Markus Armbruster May 3, 2018, 11:31 a.m. UTC | #1
Thomas Huth <thuth@redhat.com> writes:

> The qemu-doc already states that this option is only maintained for
> backward compatibility and "-device virtconsole" should be used
> instead. So let's take the next step and mark this option officially
> as deprecated.
>
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  qemu-doc.texi   | 5 +++++
>  qemu-options.hx | 2 +-
>  vl.c            | 2 ++
>  3 files changed, 8 insertions(+), 1 deletion(-)
>
> diff --git a/qemu-doc.texi b/qemu-doc.texi
> index 5813d27..e48ed05 100644
> --- a/qemu-doc.texi
> +++ b/qemu-doc.texi
> @@ -2931,6 +2931,11 @@ The @code{-localtime} option has been replaced by @code{-rtc base=localtime}.
>  
>  The @code{-startdate} option has been replaced by @code{-rtc base=@var{date}}.
>  
> +@subsection -virtioconsole (since 2.13.0)
> +
> +You can use @code{-device virtconsole} instead of @code{-virtioconsole}
> +to configure a virtio-console.
> +

Or maybe "Option @option{-virtioconsole} has been replaced by
@option{-device virtconsole}", to better match similar notes nearby.
Your choice.

>  @section qemu-img command line arguments
>  
>  @subsection convert -s (since 2.0.0)
> diff --git a/qemu-options.hx b/qemu-options.hx
> index c611766..7693d2c 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -3676,7 +3676,7 @@ STEXI
>  @findex -virtioconsole
>  Set virtio console.
>  
> -This option is maintained for backward compatibility.
> +This option is deprecated and only maintained for backward compatibility.

Suggest "This option is deprecated, use @option{-device virtconsole}
instead".

>  
>  Please use @code{-device virtconsole} for the new way of invocation.
>  ETEXI
> diff --git a/vl.c b/vl.c
> index 7487535..c409ff3 100644
> --- a/vl.c
> +++ b/vl.c
> @@ -3634,6 +3634,8 @@ int main(int argc, char **argv, char **envp)
>                  }
>                  break;
>              case QEMU_OPTION_virtiocon:
> +                warn_report("This option is deprecated, "
> +                            "use '-device virtconsole' instead.");

Please drop the period.

>                  add_device_config(DEV_VIRTCON, optarg);
>                  default_virtcon = 0;
>                  if (strncmp(optarg, "mon:", 4) == 0) {

With that:
Reviewed-by: Markus Armbruster <armbru@redhat.com>
diff mbox series

Patch

diff --git a/qemu-doc.texi b/qemu-doc.texi
index 5813d27..e48ed05 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -2931,6 +2931,11 @@  The @code{-localtime} option has been replaced by @code{-rtc base=localtime}.
 
 The @code{-startdate} option has been replaced by @code{-rtc base=@var{date}}.
 
+@subsection -virtioconsole (since 2.13.0)
+
+You can use @code{-device virtconsole} instead of @code{-virtioconsole}
+to configure a virtio-console.
+
 @section qemu-img command line arguments
 
 @subsection convert -s (since 2.0.0)
diff --git a/qemu-options.hx b/qemu-options.hx
index c611766..7693d2c 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -3676,7 +3676,7 @@  STEXI
 @findex -virtioconsole
 Set virtio console.
 
-This option is maintained for backward compatibility.
+This option is deprecated and only maintained for backward compatibility.
 
 Please use @code{-device virtconsole} for the new way of invocation.
 ETEXI
diff --git a/vl.c b/vl.c
index 7487535..c409ff3 100644
--- a/vl.c
+++ b/vl.c
@@ -3634,6 +3634,8 @@  int main(int argc, char **argv, char **envp)
                 }
                 break;
             case QEMU_OPTION_virtiocon:
+                warn_report("This option is deprecated, "
+                            "use '-device virtconsole' instead.");
                 add_device_config(DEV_VIRTCON, optarg);
                 default_virtcon = 0;
                 if (strncmp(optarg, "mon:", 4) == 0) {