fridtjof/qemu-cr16
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

qapi: add cross-references to misc modules

Browse source 
These modules don't have specific maintainers, so they're lumped in
together here as miscellaneous.

Signed-off-by: John Snow <jsnow@redhat.com>
Message-ID: <20250711054005.60969-19-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow 2025-07-11 01:40:05 -04:00 • committed by Markus Armbruster
parent 13f53cc902
commit 68c0156de2
7 changed files with 26 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

2
qapi/control.json
View file

@ -13,7 +13,7 @@
# #
# Enable QMP capabilities. # 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 # client must not enable any capability that is not mentioned in
# the QMP greeting message. If the field is not provided, it # the QMP greeting message. If the field is not provided, it
# means no QMP capabilities will be enabled. (since 2.12) # means no QMP capabilities will be enabled. (since 2.12)

2
qapi/ebpf.json
View file

@ -34,7 +34,7 @@
## ##
# @EbpfProgramID: # @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 # @rss: Receive side scaling, technology that allows steering traffic
# between queues by calculation hash. Users may set up # between queues by calculation hash. Users may set up

24
qapi/introspect.json
View file

@ -18,11 +18,11 @@
## ##
# @query-qmp-schema: # @query-qmp-schema:
# #
# Command query-qmp-schema exposes the QMP wire ABI as an array of # Command `query-qmp-schema` exposes the QMP wire ABI as an array of
# SchemaInfo. This lets QMP clients figure out what commands and # `SchemaInfo`. This lets QMP clients figure out what commands and
# events are available in this QEMU, and their parameters and results. # 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 # that apply to QMP. It's interface introspection (figuring out
# what's there), not interface specification. The specification is in # what's there), not interface specification. The specification is in
# the QAPI schema. # the QAPI schema.
@ -56,7 +56,7 @@
## ##
# @SchemaMetaType: # @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. # describes.
# #
# @builtin: a predefined type such as 'int' or 'bool'. # @builtin: a predefined type such as 'int' or 'bool'.
@ -82,7 +82,7 @@
## ##
# @SchemaInfo: # @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 # always referenced by this name. Commands and events have the
# name defined in the QAPI schema. Unlike command and event # name defined in the QAPI schema. Unlike command and event
# names, type names are not part of the wire ABI. Consequently, # names, type names are not part of the wire ABI. Consequently,
@ -113,7 +113,7 @@
## ##
# @SchemaInfoBuiltin: # @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. # @json-type: the JSON type used for this type on the wire.
# #
@ -154,7 +154,7 @@
## ##
# @SchemaInfoEnum: # @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. # @members: the enum type's members, in no particular order.
# (since 6.2) # (since 6.2)
@ -194,7 +194,7 @@
## ##
# @SchemaInfoArray: # @SchemaInfoArray:
# #
# Additional SchemaInfo members for meta-type 'array'. # Additional `SchemaInfo` members for meta-type 'array'.
# #
# @element-type: the array type's element type. # @element-type: the array type's element type.
# #
@ -208,7 +208,7 @@
## ##
# @SchemaInfoObject: # @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 # @members: the object type's (non-variant) members, in no particular
# order. # order.
@ -273,7 +273,7 @@
## ##
# @SchemaInfoAlternate: # @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: the alternate type's members, in no particular order. The
# members' wire encoding is distinct, see # members' wire encoding is distinct, see
@ -301,7 +301,7 @@
## ##
# @SchemaInfoCommand: # @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 # @arg-type: the name of the object type that provides the command's
# parameters. # parameters.
@ -323,7 +323,7 @@
## ##
# @SchemaInfoEvent: # @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 # @arg-type: the name of the object type that provides the event's
# parameters. # parameters.

2
qapi/misc-arm.json
View file

@ -30,7 +30,7 @@
## ##
# @query-gic-capabilities: # @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. # capability bits.
# #
# On non-ARM targets this command will report an error as the GIC # On non-ARM targets this command will report an error as the GIC

2
qapi/misc-i386.json
View file

@ -26,7 +26,7 @@
## ##
# @SevState: # @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. # @uninit: The guest is uninitialized.
# #

12
qapi/misc.json
View file

@ -23,7 +23,7 @@
# "@dbus-display" or the name of a character device (e.g. from # "@dbus-display" or the name of a character device (e.g. from
# -chardev id=XXXX) # -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" # @skipauth: whether to skip authentication. Only applies to "vnc"
# and "spice" protocols # and "spice" protocols
@ -228,7 +228,7 @@
# Known limitations: # Known limitations:
# #
# * This command is stateless, this means that commands that depend # * 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. # * Commands that prompt the user for data don't currently work.
# #
@ -255,7 +255,7 @@
# .. note:: If @fdname already exists, the file descriptor assigned to # .. note:: If @fdname already exists, the file descriptor assigned to
# it will be closed and replaced by the received file descriptor. # 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. # descriptor when it is no longer needed.
# #
# .. qmp-example:: # .. qmp-example::
@ -282,7 +282,7 @@
# .. note:: If @fdname already exists, the file descriptor assigned to # .. note:: If @fdname already exists, the file descriptor assigned to
# it will be closed and replaced by the received file descriptor. # 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. # descriptor when it is no longer needed.
# #
# .. qmp-example:: # .. qmp-example::
@ -475,7 +475,7 @@
# #
# @name: parameter name # @name: parameter name
# #
# @type: parameter @CommandLineParameterType # @type: parameter `CommandLineParameterType`
# #
# @help: human readable text string, not suitable for parsing. # @help: human readable text string, not suitable for parsing.
# #
@ -497,7 +497,7 @@
# #
# @option: option name # @option: option name
# #
# @parameters: an array of @CommandLineParameterInfo # @parameters: an array of `CommandLineParameterInfo`
# #
# Since: 1.5 # Since: 1.5
## ##

8
qapi/stats.json
View file

@ -89,7 +89,7 @@
# @StatsRequest: # @StatsRequest:
# #
# Indicates a set of statistics that should be returned by # Indicates a set of statistics that should be returned by
# query-stats. # `query-stats`.
# #
# @provider: provider for which to return statistics. # @provider: provider for which to return statistics.
# #
@ -114,7 +114,7 @@
## ##
# @StatsFilter: # @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 # which to request statistics and optionally the required subset of
# information for that target. # information for that target.
# #
@ -185,7 +185,7 @@
# Return runtime-collected statistics for objects such as the VM or # Return runtime-collected statistics for objects such as the VM or
# its vCPUs. # 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. # to return statistics about.
# #
# Returns: a list of statistics, one for each provider and object # Returns: a list of statistics, one for each provider and object
@ -205,7 +205,7 @@
# #
# @name: name of the statistic; each element of the schema is uniquely # @name: name of the statistic; each element of the schema is uniquely
# identified by a target, a provider (both available in # identified by a target, a provider (both available in
# @StatsSchema) and the name. # `StatsSchema`) and the name.
# #
# @type: kind of statistic. # @type: kind of statistic.
# #