From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Michael S. Tsirkin" <mst@redhat.com>,
"Marcel Apfelbaum" <marcel.apfelbaum@gmail.com>,
"John Snow" <jsnow@redhat.com>, "Eric Blake" <eblake@redhat.com>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Ani Sinha" <anisinha@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
qemu-block@nongnu.org, "Kevin Wolf" <kwolf@redhat.com>,
"Hanna Reitz" <hreitz@redhat.com>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Lukas Straub" <lukasstraub2@web.de>,
"Vladimir Sementsov-Ogievskiy" <vsementsov@yandex-team.ru>,
"Zhao Liu" <zhao1.liu@intel.com>,
"Eduardo Habkost" <eduardo@habkost.net>,
"Peter Xu" <peterx@redhat.com>,
"Yanan Wang" <wangyanan55@huawei.com>,
"Alex Bennée" <alex.bennee@linaro.org>,
"Jason Wang" <jasowang@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>,
"Igor Mammedov" <imammedo@redhat.com>,
"Fabiano Rosas" <farosas@suse.de>
Subject: [PATCH v2 18/18] qapi: add cross-references to misc modules
Date: Fri, 11 Jul 2025 01:40:05 -0400 [thread overview]
Message-ID: <20250711054005.60969-19-jsnow@redhat.com> (raw)
In-Reply-To: <20250711054005.60969-1-jsnow@redhat.com>
These modules don't have specific maintainers, so they're lumped in
together here as miscellaneous.
Signed-off-by: John Snow <jsnow@redhat.com>
---
qapi/control.json | 2 +-
qapi/ebpf.json | 2 +-
qapi/introspect.json | 24 ++++++++++++------------
qapi/misc-arm.json | 4 ++--
qapi/misc-i386.json | 2 +-
qapi/misc.json | 12 ++++++------
qapi/stats.json | 8 ++++----
7 files changed, 27 insertions(+), 27 deletions(-)
diff --git a/qapi/control.json b/qapi/control.json
index 3aeb8f4f6fb..91de9fcd3b6 100644
--- a/qapi/control.json
+++ b/qapi/control.json
@@ -11,7 +11,7 @@
#
# Enable QMP capabilities.
#
-# @enable: An optional list of QMPCapability values to enable. The
+# @enable: An optional list of `QMPCapability` values to enable. The
# client must not enable any capability that is not mentioned in
# the QMP greeting message. If the field is not provided, it
# means no QMP capabilities will be enabled. (since 2.12)
diff --git a/qapi/ebpf.json b/qapi/ebpf.json
index db19ae850fc..834e28d1aba 100644
--- a/qapi/ebpf.json
+++ b/qapi/ebpf.json
@@ -32,7 +32,7 @@
##
# @EbpfProgramID:
#
-# The eBPF programs that can be gotten with request-ebpf.
+# The eBPF programs that can be gotten with `request-ebpf`.
#
# @rss: Receive side scaling, technology that allows steering traffic
# between queues by calculation hash. Users may set up
diff --git a/qapi/introspect.json b/qapi/introspect.json
index a5340268d13..4ccce77483e 100644
--- a/qapi/introspect.json
+++ b/qapi/introspect.json
@@ -16,11 +16,11 @@
##
# @query-qmp-schema:
#
-# Command query-qmp-schema exposes the QMP wire ABI as an array of
-# SchemaInfo. This lets QMP clients figure out what commands and
+# Command `query-qmp-schema` exposes the QMP wire ABI as an array of
+# `SchemaInfo`. This lets QMP clients figure out what commands and
# events are available in this QEMU, and their parameters and results.
#
-# However, the SchemaInfo can't reflect all the rules and restrictions
+# However, the `SchemaInfo` can't reflect all the rules and restrictions
# that apply to QMP. It's interface introspection (figuring out
# what's there), not interface specification. The specification is in
# the QAPI schema.
@@ -54,7 +54,7 @@
##
# @SchemaMetaType:
#
-# This is a @SchemaInfo's meta type, i.e. the kind of entity it
+# This is a `SchemaInfo`'s meta type, i.e. the kind of entity it
# describes.
#
# @builtin: a predefined type such as 'int' or 'bool'.
@@ -80,7 +80,7 @@
##
# @SchemaInfo:
#
-# @name: the entity's name, inherited from @base. The SchemaInfo is
+# @name: the entity's name, inherited from @base. The `SchemaInfo` is
# always referenced by this name. Commands and events have the
# name defined in the QAPI schema. Unlike command and event
# names, type names are not part of the wire ABI. Consequently,
@@ -111,7 +111,7 @@
##
# @SchemaInfoBuiltin:
#
-# Additional SchemaInfo members for meta-type 'builtin'.
+# Additional `SchemaInfo` members for meta-type 'builtin'.
#
# @json-type: the JSON type used for this type on the wire.
#
@@ -152,7 +152,7 @@
##
# @SchemaInfoEnum:
#
-# Additional SchemaInfo members for meta-type 'enum'.
+# Additional `SchemaInfo` members for meta-type 'enum'.
#
# @members: the enum type's members, in no particular order.
# (since 6.2)
@@ -192,7 +192,7 @@
##
# @SchemaInfoArray:
#
-# Additional SchemaInfo members for meta-type 'array'.
+# Additional `SchemaInfo` members for meta-type 'array'.
#
# @element-type: the array type's element type.
#
@@ -206,7 +206,7 @@
##
# @SchemaInfoObject:
#
-# Additional SchemaInfo members for meta-type 'object'.
+# Additional `SchemaInfo` members for meta-type 'object'.
#
# @members: the object type's (non-variant) members, in no particular
# order.
@@ -271,7 +271,7 @@
##
# @SchemaInfoAlternate:
#
-# Additional SchemaInfo members for meta-type 'alternate'.
+# Additional `SchemaInfo` members for meta-type 'alternate'.
#
# @members: the alternate type's members, in no particular order. The
# members' wire encoding is distinct, see
@@ -299,7 +299,7 @@
##
# @SchemaInfoCommand:
#
-# Additional SchemaInfo members for meta-type 'command'.
+# Additional `SchemaInfo` members for meta-type 'command'.
#
# @arg-type: the name of the object type that provides the command's
# parameters.
@@ -321,7 +321,7 @@
##
# @SchemaInfoEvent:
#
-# Additional SchemaInfo members for meta-type 'event'.
+# Additional `SchemaInfo` members for meta-type 'event'.
#
# @arg-type: the name of the object type that provides the event's
# parameters.
diff --git a/qapi/misc-arm.json b/qapi/misc-arm.json
index f5341372f5a..7f16ecf5390 100644
--- a/qapi/misc-arm.json
+++ b/qapi/misc-arm.json
@@ -30,13 +30,13 @@
##
# @query-gic-capabilities:
#
-# It will return a list of GICCapability objects that describe its
+# It will return a list of `GICCapability` objects that describe its
# capability bits.
#
# On non-ARM targets this command will report an error as the GIC
# technology is not applicable.
#
-# Returns: a list of GICCapability objects.
+# Returns: a list of `GICCapability` objects.
#
# Since: 2.6
#
diff --git a/qapi/misc-i386.json b/qapi/misc-i386.json
index c0c57f9ab25..24ba3bc8690 100644
--- a/qapi/misc-i386.json
+++ b/qapi/misc-i386.json
@@ -26,7 +26,7 @@
##
# @SevState:
#
-# An enumeration of SEV state information used during @query-sev.
+# An enumeration of SEV state information used during `query-sev`.
#
# @uninit: The guest is uninitialized.
#
diff --git a/qapi/misc.json b/qapi/misc.json
index 70dbcb0aecf..5ac41dc55f2 100644
--- a/qapi/misc.json
+++ b/qapi/misc.json
@@ -21,7 +21,7 @@
# "@dbus-display" or the name of a character device (e.g. from
# -chardev id=XXXX)
#
-# @fdname: file descriptor name previously passed via 'getfd' command
+# @fdname: file descriptor name previously passed via `getfd` command
#
# @skipauth: whether to skip authentication. Only applies to "vnc"
# and "spice" protocols
@@ -226,7 +226,7 @@
# Known limitations:
#
# * This command is stateless, this means that commands that depend
-# on state information (such as getfd) might not work.
+# on state information (such as `getfd`) might not work.
#
# * Commands that prompt the user for data don't currently work.
#
@@ -253,7 +253,7 @@
# .. note:: If @fdname already exists, the file descriptor assigned to
# it will be closed and replaced by the received file descriptor.
#
-# The 'closefd' command can be used to explicitly close the file
+# The `closefd` command can be used to explicitly close the file
# descriptor when it is no longer needed.
#
# .. qmp-example::
@@ -280,7 +280,7 @@
# .. note:: If @fdname already exists, the file descriptor assigned to
# it will be closed and replaced by the received file descriptor.
#
-# The 'closefd' command can be used to explicitly close the file
+# The `closefd` command can be used to explicitly close the file
# descriptor when it is no longer needed.
#
# .. qmp-example::
@@ -473,7 +473,7 @@
#
# @name: parameter name
#
-# @type: parameter @CommandLineParameterType
+# @type: parameter `CommandLineParameterType`
#
# @help: human readable text string, not suitable for parsing.
#
@@ -495,7 +495,7 @@
#
# @option: option name
#
-# @parameters: an array of @CommandLineParameterInfo
+# @parameters: an array of `CommandLineParameterInfo`
#
# Since: 1.5
##
diff --git a/qapi/stats.json b/qapi/stats.json
index 7e7f1dabbc3..f00785879d6 100644
--- a/qapi/stats.json
+++ b/qapi/stats.json
@@ -87,7 +87,7 @@
# @StatsRequest:
#
# Indicates a set of statistics that should be returned by
-# query-stats.
+# `query-stats`.
#
# @provider: provider for which to return statistics.
#
@@ -112,7 +112,7 @@
##
# @StatsFilter:
#
-# The arguments to the query-stats command; specifies a target for
+# 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.
#
@@ -183,7 +183,7 @@
# Return runtime-collected statistics for objects such as the VM or
# its vCPUs.
#
-# The arguments are a StatsFilter and specify the provider and objects
+# The arguments are a `StatsFilter` and specify the provider and objects
# to return statistics about.
#
# Returns: a list of statistics, one for each provider and object
@@ -203,7 +203,7 @@
#
# @name: name of the statistic; each element of the schema is uniquely
# identified by a target, a provider (both available in
-# @StatsSchema) and the name.
+# `StatsSchema`) and the name.
#
# @type: kind of statistic.
#
--
2.50.0
next prev parent reply other threads:[~2025-07-11 5:44 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-11 5:39 [PATCH v2 00/18] QAPI: add cross-references to qapi docs John Snow
2025-07-11 5:39 ` [PATCH v2 01/18] qapi: add cross-references to acpi.json John Snow
2025-07-11 5:39 ` [PATCH v2 02/18] qapi: add cross-references to authz.json John Snow
2025-07-11 5:39 ` [PATCH v2 03/18] qapi: add cross-references to block layer John Snow
2025-07-11 8:48 ` Markus Armbruster
2025-07-11 5:39 ` [PATCH v2 04/18] qapi: add cross-references to crypto.json John Snow
2025-07-11 9:15 ` Markus Armbruster
2025-07-11 5:39 ` [PATCH v2 05/18] qapi: add cross-references to dump.json John Snow
2025-07-11 5:39 ` [PATCH v2 06/18] qapi: add cross-references to job.json John Snow
2025-07-11 8:33 ` Markus Armbruster
2025-07-11 5:39 ` [PATCH v2 07/18] qapi: add cross-references to Machine core John Snow
2025-07-11 5:39 ` [PATCH v2 08/18] qapi: add cross-references to migration.json John Snow
2025-07-11 8:55 ` Markus Armbruster
2025-07-11 14:29 ` John Snow
2025-07-11 5:39 ` [PATCH v2 09/18] qapi: add cross-references to net.json John Snow
2025-07-11 5:39 ` [PATCH v2 10/18] qapi: add cross-references to pci.json John Snow
2025-07-11 5:39 ` [PATCH v2 11/18] qapi: add cross-references to QOM John Snow
2025-07-11 5:39 ` [PATCH v2 12/18] qapi: add cross-references to replay.json John Snow
2025-07-11 5:40 ` [PATCH v2 13/18] qapi: add cross-references to run-state.json John Snow
2025-07-11 5:40 ` [PATCH v2 14/18] qapi: add cross-references to sockets.json John Snow
2025-07-11 5:40 ` [PATCH v2 15/18] qapi: add cross-references to ui.json John Snow
2025-07-11 5:40 ` [PATCH v2 16/18] qapi: add cross-references to virtio.json John Snow
2025-07-11 5:40 ` [PATCH v2 17/18] qapi: add cross-references to yank.json John Snow
2025-07-11 5:40 ` John Snow [this message]
2025-07-11 9:04 ` [PATCH v2 00/18] QAPI: add cross-references to qapi docs Markus Armbruster
2025-07-11 9:26 ` Markus Armbruster
2025-07-11 15:13 ` John Snow
2025-07-14 13:41 ` Markus Armbruster
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250711054005.60969-19-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=anisinha@redhat.com \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=eblake@redhat.com \
--cc=eduardo@habkost.net \
--cc=farosas@suse.de \
--cc=hreitz@redhat.com \
--cc=imammedo@redhat.com \
--cc=jasowang@redhat.com \
--cc=kwolf@redhat.com \
--cc=lukasstraub2@web.de \
--cc=marcandre.lureau@redhat.com \
--cc=marcel.apfelbaum@gmail.com \
--cc=mst@redhat.com \
--cc=pbonzini@redhat.com \
--cc=peterx@redhat.com \
--cc=philmd@linaro.org \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--cc=vsementsov@yandex-team.ru \
--cc=wangyanan55@huawei.com \
--cc=zhao1.liu@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).