diff mbox series

qapi: document leftover members in qapi/stats.json

Message ID 20240325104504.1358734-1-pbonzini@redhat.com
State New
Headers show
Series qapi: document leftover members in qapi/stats.json | expand

Commit Message

Paolo Bonzini March 25, 2024, 10:45 a.m. UTC
Suggested-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
 qapi/stats.json | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

Comments

Markus Armbruster March 25, 2024, 11:41 a.m. UTC | #1
Paolo Bonzini <pbonzini@redhat.com> writes:

> Suggested-by: Markus Armbruster <armbru@redhat.com>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---
>  qapi/stats.json | 14 +++++++++-----
>  1 file changed, 9 insertions(+), 5 deletions(-)
>
> diff --git a/qapi/stats.json b/qapi/stats.json
> index ce9d8161ecb..578b52c7ef7 100644
> --- a/qapi/stats.json
> +++ b/qapi/stats.json
> @@ -114,13 +114,13 @@
>  #
>  # The arguments to the query-stats command; specifies a target for
>  # which to request statistics and optionally the required subset of
> -# information for that target:
> +# information for that target.
>  #
> -# - which vCPUs to request statistics for
> -# - which providers to request statistics from
> -# - which named values to return within each provider
> +# @target: the kind of objects to query.  Note that each possible
> +#          target may enable additional filtering options
>  #
> -# @target: the kind of objects to query
> +# @providers: which providers to request statistics from, and optionally
> +#             which named values to return within each provider
>  #
>  # Since: 7.1
>  ##
> @@ -136,6 +136,8 @@
>  #
>  # @scalar: single unsigned 64-bit integers.
>  #
> +# @boolean: single boolean value.
> +#
>  # @list: list of unsigned 64-bit integers (used for histograms).
>  #
>  # Since: 7.1
> @@ -254,6 +256,8 @@
>  #
>  # Return the schema for all available runtime-collected statistics.
>  #
> +# @provider: a provider to restrict the query to.
> +#
>  # Note: runtime-collected statistics and their names fall outside
>  #     QEMU's usual deprecation policies.  QEMU will try to keep the
>  #     set of available data stable, together with their names, but

Reviewed-by: Markus Armbruster <armbru@redhat.com>

Queued, thanks!
Markus Armbruster March 25, 2024, 3:50 p.m. UTC | #2
Squashing in

diff --git a/qapi/pragma.json b/qapi/pragma.json
index 1a302981c1..99e4052ab3 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -75,8 +75,6 @@
         'Qcow2OverlapCheckFlags',
         'RbdAuthMode',
         'RbdImageEncryptionFormat',
-        'StatsFilter',
-        'StatsValue',
         'String',
         'StringWrapper',
         'SysEmuTarget',
@@ -91,8 +89,7 @@
         'query-cpu-model-comparison',
         'query-cpu-model-expansion',
         'query-rocker',
-        'query-rocker-ports',
-        'query-stats-schemas' ],
+        'query-rocker-ports' ],
     # Externally visible types whose member names may use uppercase
     'member-name-exceptions': [     # visible in:
         'ACPISlotType',             # query-acpi-ospm-status
diff mbox series

Patch

diff --git a/qapi/stats.json b/qapi/stats.json
index ce9d8161ecb..578b52c7ef7 100644
--- a/qapi/stats.json
+++ b/qapi/stats.json
@@ -114,13 +114,13 @@ 
 #
 # The arguments to the query-stats command; specifies a target for
 # which to request statistics and optionally the required subset of
-# information for that target:
+# information for that target.
 #
-# - which vCPUs to request statistics for
-# - which providers to request statistics from
-# - which named values to return within each provider
+# @target: the kind of objects to query.  Note that each possible
+#          target may enable additional filtering options
 #
-# @target: the kind of objects to query
+# @providers: which providers to request statistics from, and optionally
+#             which named values to return within each provider
 #
 # Since: 7.1
 ##
@@ -136,6 +136,8 @@ 
 #
 # @scalar: single unsigned 64-bit integers.
 #
+# @boolean: single boolean value.
+#
 # @list: list of unsigned 64-bit integers (used for histograms).
 #
 # Since: 7.1
@@ -254,6 +256,8 @@ 
 #
 # Return the schema for all available runtime-collected statistics.
 #
+# @provider: a provider to restrict the query to.
+#
 # Note: runtime-collected statistics and their names fall outside
 #     QEMU's usual deprecation policies.  QEMU will try to keep the
 #     set of available data stable, together with their names, but