[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 16/20] qapi: rewrite StatsFilter comment
From: |
John Snow |
Subject: |
[PATCH 16/20] qapi: rewrite StatsFilter comment |
Date: |
Tue, 14 May 2024 17:57:35 -0400 |
Rewrite the StatsFilter intro paragraph to be more meaningful to
end-users when it is inlined in generated documentation.
Signed-off-by: John Snow <jsnow@redhat.com>
---
qapi/stats.json | 8 ++------
1 file changed, 2 insertions(+), 6 deletions(-)
diff --git a/qapi/stats.json b/qapi/stats.json
index 578b52c7ef7..c4a9f3ff70e 100644
--- a/qapi/stats.json
+++ b/qapi/stats.json
@@ -112,10 +112,6 @@
##
# @StatsFilter:
#
-# 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.
-#
# @target: the kind of objects to query. Note that each possible
# target may enable additional filtering options
#
@@ -183,8 +179,8 @@
# Return runtime-collected statistics for objects such as the VM or
# its vCPUs.
#
-# The arguments are a StatsFilter and specify the provider and objects
-# to return statistics about.
+# The arguments specify a target for which to request statistics and
+# optionally the required subset of information for that target.
#
# Returns: a list of StatsResult, one for each provider and object
# (e.g., for each vCPU).
--
2.44.0
- Re: [PATCH 08/20] qapi/parser: differentiate intro and outro paragraphs, (continued)
- [PATCH 11/20] qapi/schema: add doc_visible property to QAPISchemaDefinition, John Snow, 2024/05/14
- [PATCH 15/20] qapi: remove developer factoring comments from QAPI doc blocks, John Snow, 2024/05/14
- [PATCH 12/20] qapi/source: allow multi-line QAPISourceInfo advancing, John Snow, 2024/05/14
- [PATCH 16/20] qapi: rewrite StatsFilter comment,
John Snow <=
- [PATCH 14/20] qapi: fix non-compliant JSON examples, John Snow, 2024/05/14
- [PATCH 17/20] qapi: rewrite BlockExportOptions doc block, John Snow, 2024/05/14
- [PATCH 18/20] qapi: ensure all errors sections are uniformly typset, John Snow, 2024/05/14
- [PATCH 19/20] qapi: convert "Note" sections to plain rST, John Snow, 2024/05/14
- [PATCH 20/20] qapi: convert "Example" sections to rST, John Snow, 2024/05/14
- Re: [PATCH 00/20] qapi: new sphinx qapi domain pre-requisites, Stefan Hajnoczi, 2024/05/16