[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 09/16] qapi: Fix bullet list markup in documentation
From: |
Markus Armbruster |
Subject: |
[PATCH 09/16] qapi: Fix bullet list markup in documentation |
Date: |
Tue, 4 Apr 2023 13:59:05 +0200 |
Peter Maydell's commit 100cc4fe0f08 explains:
rST insists on a blank line before and after a bulleted list [...]
Add some extra blank lines in the doc comments so they're
acceptable rST input.
It missed one in qapi/trace.json.
Paolo Bonzini later added another instance in qapi/stats.json,
providing further, if unintended, evidence for his quip that rST is
the Perl of ASCII-based markups.
Both are parsed as ordinary paragraph, resulting in garbled output.
Add the blank lines we need to get the bullet lists recognized as
such.
Fixes: 100cc4fe0f0827f8da1a5c05f9c65e2aaa40e03d (qapi: Add blank lines before
bulleted lists)
Fixes: 467ef823d83e (qmp: add filtering of statistics by target vCPU)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/stats.json | 1 +
qapi/trace.json | 1 +
2 files changed, 2 insertions(+)
diff --git a/qapi/stats.json b/qapi/stats.json
index 1f5d3c59ab..f17495ee65 100644
--- a/qapi/stats.json
+++ b/qapi/stats.json
@@ -107,6 +107,7 @@
# 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:
+#
# - which vCPUs to request statistics for
# - which providers to request statistics from
# - which named values to return within each provider
diff --git a/qapi/trace.json b/qapi/trace.json
index 6c6982a587..f425d10764 100644
--- a/qapi/trace.json
+++ b/qapi/trace.json
@@ -87,6 +87,7 @@
# @vcpu: The vCPU to act upon (all by default; since 2.7).
#
# An event's state is modified if:
+#
# - its name matches the @name pattern, and
# - if @vcpu is given, the event has the "vcpu" property.
#
--
2.39.2
- [PATCH 03/16] qapi: Fix misspelled references, (continued)
- [PATCH 03/16] qapi: Fix misspelled references, Markus Armbruster, 2023/04/04
- [PATCH 02/16] qga/qapi-schema: Fix a misspelled reference, Markus Armbruster, 2023/04/04
- [PATCH 01/16] qga/qapi-schema: Tidy up documentation of guest-fsfreeze-status, Markus Armbruster, 2023/04/04
- [PATCH 07/16] qapi: Tidy up examples, Markus Armbruster, 2023/04/04
- [PATCH 08/16] qapi: Delete largely misleading "Stability Considerations", Markus Armbruster, 2023/04/04
- [PATCH 13/16] qapi: Replace ad hoc "since" documentation by member documentation, Markus Armbruster, 2023/04/04
- [PATCH 05/16] qapi/block-core: Clean up after removal of dirty bitmap @status, Markus Armbruster, 2023/04/04
- [PATCH 09/16] qapi: Fix bullet list markup in documentation,
Markus Armbruster <=
- [PATCH 12/16] qapi: Fix argument documentation markup, Markus Armbruster, 2023/04/04
- [PATCH 10/16] qapi: Fix unintended definition lists in documentation, Markus Armbruster, 2023/04/04
- [PATCH 16/16] qapi storage-daemon/qapi: Fix documentation section structure, Markus Armbruster, 2023/04/04
- [PATCH 11/16] qga/qapi-schema: Fix member documentation markup, Markus Armbruster, 2023/04/04
- [PATCH 14/16] qapi: Fix misspelled section tags in doc comments, Markus Armbruster, 2023/04/04
- [PATCH 15/16] qapi: Format since information the conventional way: (since X.Y), Markus Armbruster, 2023/04/04