Browse Source

qapi: Add more cross-references

We recently (merge commit 504632dcc6) enclosed command and type
names in `backquotes`, so they become links in generated HTML.  Take
care of a few we missed.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20250717115751.3832597-1-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Reviewed-by: John Snow <jsnow@redhat.com>
pull/304/head
Markus Armbruster 1 year ago
parent
commit
d4d91ed42e
  1. 2
      qapi/dump.json
  2. 2
      qapi/machine.json
  3. 4
      qapi/migration.json
  4. 2
      qapi/misc-i386.json
  5. 2
      qapi/run-state.json
  6. 2
      qapi/sockets.json

2
qapi/dump.json

@ -79,7 +79,7 @@
#
# @detach: if true, QMP will return immediately rather than waiting
# for the dump to finish. The user can track progress using
# "query-dump". (since 2.6).
# `query-dump`. (since 2.6).
#
# @begin: if specified, the starting physical address.
#

2
qapi/machine.json

@ -2087,7 +2087,7 @@
#
# @deprecated-props: an optional list of properties that are flagged as
# deprecated by the CPU vendor. The list depends on the
# CpuModelExpansionType: "static" properties are a subset of the
# `CpuModelExpansionType`: "static" properties are a subset of the
# enabled-properties for the expanded model; "full" properties are
# a set of properties that are deprecated across all models for
# the architecture. (since: 10.1 -- since 9.1 on s390x --).

4
qapi/migration.json

@ -641,7 +641,7 @@
#
# This mode supports VFIO devices provided the user first puts the
# guest in the suspended runstate, such as by issuing
# guest-suspend-ram to the QEMU guest agent.
# `guest-suspend-ram` to the QEMU guest agent.
#
# Best performance is achieved when the memory backend is shared
# and the @x-ignore-shared migration capability is set, but this
@ -1704,7 +1704,7 @@
#
# .. admonition:: Notes
#
# 1. The 'query-migrate' command should be used to check
# 1. The `query-migrate` command should be used to check
# migration's progress and final result (this information is
# provided by the 'status' member).
#

2
qapi/misc-i386.json

@ -8,7 +8,7 @@
#
# Reset the RTC interrupt reinjection backlog. Can be used if another
# mechanism to synchronize guest time is in effect, for example QEMU
# guest agent's guest-set-time command.
# guest agent's `guest-set-time` command.
#
# Use of this command is only applicable for x86 machines with an RTC,
# and on other machines will silently return without performing any

2
qapi/run-state.json

@ -20,7 +20,7 @@
# @inmigrate: guest is paused waiting for an incoming migration. Note
# that this state does not tell whether the machine will start at
# the end of the migration. This depends on the command-line -S
# option and any invocation of 'stop' or 'cont' that has happened
# option and any invocation of `stop` or `cont` that has happened
# since QEMU was started.
#
# @internal-error: An internal error that prevents further guest

2
qapi/sockets.json

@ -143,7 +143,7 @@
#
# @str: decimal is for file descriptor number, otherwise it's a file
# descriptor name. Named file descriptors are permitted in
# monitor commands, in combination with the 'getfd' command.
# monitor commands, in combination with the `getfd` command.
# Decimal file descriptors are permitted at startup or other
# contexts where no monitor context is active.
#

Loading…
Cancel
Save