[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 18/20] qapi: document leftover members in qapi/stats.json
From: |
Markus Armbruster |
Subject: |
[PULL 18/20] qapi: document leftover members in qapi/stats.json |
Date: |
Tue, 26 Mar 2024 08:34:18 +0100 |
From: Paolo Bonzini <pbonzini@redhat.com>
Suggested-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Message-ID: <20240325104504.1358734-1-pbonzini@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Update qapi/pragma.json]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/pragma.json | 5 +----
qapi/stats.json | 14 +++++++++-----
2 files changed, 10 insertions(+), 9 deletions(-)
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 --git a/qapi/stats.json b/qapi/stats.json
index ce9d8161ec..578b52c7ef 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
--
2.44.0
- [PULL 11/20] qapi: Start sentences with a capital letter, end them with a period, (continued)
- [PULL 11/20] qapi: Start sentences with a capital letter, end them with a period, Markus Armbruster, 2024/03/26
- [PULL 10/20] qapi: Fix abbreviation punctuation in doc comments, Markus Armbruster, 2024/03/26
- [PULL 05/20] qapi: Expand a few awkward abbreviations in documentation, Markus Armbruster, 2024/03/26
- [PULL 06/20] qapi: Tidy up block-latency-histogram-set documentation some more, Markus Armbruster, 2024/03/26
- [PULL 08/20] qapi: Fix argument markup in drive-mirror documentation, Markus Armbruster, 2024/03/26
- [PULL 09/20] qapi: Fix typo in request-ebpf documentation, Markus Armbruster, 2024/03/26
- [PULL 16/20] qapi: document InputMultiTouchType, Markus Armbruster, 2024/03/26
- [PULL 19/20] qapi/block-core: improve Qcow2OverlapCheckFlags documentation, Markus Armbruster, 2024/03/26
- [PULL 17/20] qapi: document leftover members in qapi/run-state.json, Markus Armbruster, 2024/03/26
- [PULL 15/20] qga/qapi-schema: Refill doc comments to conform to current conventions, Markus Armbruster, 2024/03/26
- [PULL 18/20] qapi: document leftover members in qapi/stats.json,
Markus Armbruster <=
- [PULL 20/20] qapi: document parameters of query-cpu-model-* QAPI commands, Markus Armbruster, 2024/03/26
- [PULL 13/20] qapi: Refill doc comments to conform to current conventions, Markus Armbruster, 2024/03/26
- [PULL 04/20] qapi: Drop stray Arguments: line from qmp_capabilities docs, Markus Armbruster, 2024/03/26
- [PULL 14/20] qapi: Correct documentation indentation and whitespace, Markus Armbruster, 2024/03/26
- [PULL 12/20] qapi: Don't repeat member type in its documentation text, Markus Armbruster, 2024/03/26
- [PULL 07/20] qapi: Tidy up indentation of add_client's example, Markus Armbruster, 2024/03/26
- Re: [PULL 00/20] QAPI patches patches for 2024-03-26, Peter Maydell, 2024/03/26