From: Markus Armbruster <armbru@redhat.com>
To: qemu-devel@nongnu.org
Cc: stefanha@redhat.com, "Daniel P. Berrangé" <berrange@redhat.com>,
"John Snow" <jsnow@redhat.com>
Subject: [PULL 1/5] qapi: Add more cross-references
Date: Tue, 29 Jul 2025 15:11:44 +0200 [thread overview]
Message-ID: <20250729131148.3777401-2-armbru@redhat.com> (raw)
In-Reply-To: <20250729131148.3777401-1-armbru@redhat.com>
We recently (merge commit 504632dcc631) 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>
---
qapi/dump.json | 2 +-
qapi/machine.json | 2 +-
qapi/migration.json | 4 ++--
qapi/misc-i386.json | 2 +-
qapi/run-state.json | 2 +-
qapi/sockets.json | 2 +-
6 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/qapi/dump.json b/qapi/dump.json
index 32c8c1f06e..726b520870 100644
--- a/qapi/dump.json
+++ b/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.
#
diff --git a/qapi/machine.json b/qapi/machine.json
index 6f59f70ca6..038eab281c 100644
--- a/qapi/machine.json
+++ b/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 --).
diff --git a/qapi/migration.json b/qapi/migration.json
index e08a99bb82..2387c21e9c 100644
--- a/qapi/migration.json
+++ b/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).
#
diff --git a/qapi/misc-i386.json b/qapi/misc-i386.json
index c8c91a241c..d1ce8caf25 100644
--- a/qapi/misc-i386.json
+++ b/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
diff --git a/qapi/run-state.json b/qapi/run-state.json
index 54ba5c9a3f..4757947ca6 100644
--- a/qapi/run-state.json
+++ b/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
diff --git a/qapi/sockets.json b/qapi/sockets.json
index 82046b0b3a..32fac51728 100644
--- a/qapi/sockets.json
+++ b/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.
#
--
2.49.0
next prev parent reply other threads:[~2025-07-29 13:13 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-29 13:11 [PULL 0/5] QAPI patches for 2025-07-29 Markus Armbruster
2025-07-29 13:11 ` Markus Armbruster [this message]
2025-07-29 13:11 ` [PULL 2/5] qapi/accelerator: Fix markup of heading Markus Armbruster
2025-07-29 13:11 ` [PULL 3/5] tests/qapi-schema: Bury dead test case doc-non-first-section Markus Armbruster
2025-07-29 13:11 ` [PULL 4/5] docs/qapi-domain: Fix typos Markus Armbruster
2025-07-29 13:11 ` [PULL 5/5] MAINTAINERS: Cover docs/devel/qapi-domain.rst properly Markus Armbruster
2025-07-29 16:59 ` [PULL 0/5] QAPI patches for 2025-07-29 Stefan Hajnoczi
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=20250729131148.3777401-2-armbru@redhat.com \
--to=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=jsnow@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.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).