diff mbox series

[PATCHv3,4/4] qemu-doc: deprecate query-cpus and info cpus

Message ID 1518690027-31318-5-git-send-email-mihajlov@linux.vnet.ibm.com
State New
Headers show
Series ] add query-cpu-fast and related s390 changes | expand

Commit Message

Viktor VM Mihajlovski Feb. 15, 2018, 10:20 a.m. UTC
Start the deprecation period for QAPI query-cpus (replaced by
query-cpus-fast) and HMP 'info cpus' (replaced by 'info cpus_fast')
beginning with 2.12.0.

Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
---
 hmp-commands-info.hx |  4 ++--
 qapi-schema.json     |  4 ++++
 qemu-doc.texi        | 10 ++++++++++
 3 files changed, 16 insertions(+), 2 deletions(-)

Comments

Eric Blake Feb. 15, 2018, 2:23 p.m. UTC | #1
On 02/15/2018 04:20 AM, Viktor Mihajlovski wrote:
> Start the deprecation period for QAPI query-cpus (replaced by
> query-cpus-fast) and HMP 'info cpus' (replaced by 'info cpus_fast')
> beginning with 2.12.0.

See my comments on 2/4 - if we want, we could just make HMP 'info cpus' 
be the fast version, with no slow version counterpart, right away 
without a deprecation period.  If we do that, then...

> 
> Signed-off-by: Viktor Mihajlovski <mihajlov@linux.vnet.ibm.com>
> ---
>   hmp-commands-info.hx |  4 ++--
>   qapi-schema.json     |  4 ++++
>   qemu-doc.texi        | 10 ++++++++++
>   3 files changed, 16 insertions(+), 2 deletions(-)
> 
> diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
> index 16ac602..2ccb9c7 100644
> --- a/hmp-commands-info.hx
> +++ b/hmp-commands-info.hx
> @@ -149,14 +149,14 @@ ETEXI
>           .name       = "cpus",
>           .args_type  = "",
>           .params     = "",
> -        .help       = "show infos for each CPU",
> +        .help       = "show infos for each CPU (deprecated, use info cpus_fast instead)",

changes to this file no longer need to happen in this patch, and


> +++ b/qemu-doc.texi
> @@ -2757,6 +2757,12 @@ used and it will be removed with no replacement.
>   The ``convert -s snapshot_id_or_name'' argument is obsoleted
>   by the ``convert -l snapshot_param'' argument instead.
>   
> +@section System emulator monitor commands
> +
> +@subsection query-cpus (since 2.12.0)
> +
> +The ``query-cpus'' command is replaced by the ``query-cpus-fast'' command.
> +
>   @section System emulator human monitor commands
>   
>   @subsection host_net_add (since 2.10.0)
> @@ -2767,6 +2773,10 @@ The ``host_net_add'' command is replaced by the ``netdev_add'' command.
>   
>   The ``host_net_remove'' command is replaced by the ``netdev_del'' command.
>   
> +@subsection info cpus (since 2.12.0)
> +
> +The ``info cpus'' command is replaced by the ``info cpus_fast'' command.
> +

this hunk could be dropped.

But if we really want a deprecation period on the HMP side as well, then 
this patch is fine.

Reviewed-by: Eric Blake <eblake@redhat.com>
diff mbox series

Patch

diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx
index 16ac602..2ccb9c7 100644
--- a/hmp-commands-info.hx
+++ b/hmp-commands-info.hx
@@ -149,14 +149,14 @@  ETEXI
         .name       = "cpus",
         .args_type  = "",
         .params     = "",
-        .help       = "show infos for each CPU",
+        .help       = "show infos for each CPU (deprecated, use info cpus_fast instead)",
         .cmd        = hmp_info_cpus,
     },
 
 STEXI
 @item info cpus
 @findex info cpus
-Show infos for each CPU.
+Show infos for each CPU. Deprecated, please use @code{info cpus_fast} instead.
 ETEXI
 
     {
diff --git a/qapi-schema.json b/qapi-schema.json
index e6ca63f..cd98a94 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -587,6 +587,10 @@ 
 #       ]
 #    }
 #
+# Notes: This interface is deprecated (since 2.12.0), and it is strongly
+#        recommended that you avoid using it. Use @query-cpus-fast to
+#        obtain information about virtual CPUs.
+#
 ##
 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
 
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 769968a..46aacb6 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -2757,6 +2757,12 @@  used and it will be removed with no replacement.
 The ``convert -s snapshot_id_or_name'' argument is obsoleted
 by the ``convert -l snapshot_param'' argument instead.
 
+@section System emulator monitor commands
+
+@subsection query-cpus (since 2.12.0)
+
+The ``query-cpus'' command is replaced by the ``query-cpus-fast'' command.
+
 @section System emulator human monitor commands
 
 @subsection host_net_add (since 2.10.0)
@@ -2767,6 +2773,10 @@  The ``host_net_add'' command is replaced by the ``netdev_add'' command.
 
 The ``host_net_remove'' command is replaced by the ``netdev_del'' command.
 
+@subsection info cpus (since 2.12.0)
+
+The ``info cpus'' command is replaced by the ``info cpus_fast'' command.
+
 @section System emulator devices
 
 @subsection ivshmem (since 2.6.0)