From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: qemu-block@nongnu.org, "Kevin Wolf" <kwolf@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@mailo.com>,
"Eric Blake" <eblake@redhat.com>,
"Jonathan Cameron" <jic23@kernel.org>,
"Lukas Straub" <lukasstraub2@web.de>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Zhao Liu" <zhao1.liu@intel.com>,
linux-cxl@vger.kernel.org, "Jason Wang" <jasowangio@gmail.com>,
"Hanna Reitz" <hreitz@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>,
"Fabiano Rosas" <farosas@suse.de>, "Peter Xu" <peterx@redhat.com>,
"John Snow" <jsnow@redhat.com>
Subject: [PATCH 6/6] qapi: convert intro sections followed by notes/examples
Date: Fri, 11 Sep 2026 13:22:00 -0400 [thread overview]
Message-ID: <20260911172200.227914-7-jsnow@redhat.com> (raw)
In-Reply-To: <20260911172200.227914-1-jsnow@redhat.com>
These provide a rather natural cutoff point, but technically this does
introduce a new intro/details split to these documentation blocks.
Signed-off-by: John Snow <jsnow@redhat.com>
---
qapi/machine.json | 5 ++---
qapi/migration.json | 15 +++++++--------
qapi/misc.json | 3 +--
qapi/run-state.json | 7 +++----
4 files changed, 13 insertions(+), 17 deletions(-)
diff --git a/qapi/machine.json b/qapi/machine.json
index 108033b6d64..9a790da9db2 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -1181,9 +1181,8 @@
##
# @HV_BALLOON_STATUS_REPORT:
-#
-# Emitted when the hv-balloon driver receives a "STATUS" message from
-# the guest.
+# Emitted when the hv-balloon driver receives a "STATUS" message
+# from the guest.
#
# .. note:: This event is rate-limited.
#
diff --git a/qapi/migration.json b/qapi/migration.json
index 70a1854fb73..c831e692feb 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -1241,10 +1241,10 @@
##
# @migrate_cancel:
-#
-# Cancel the currently executing migration process. Allows a new
-# migration to be started right after. When postcopy-ram is in use,
-# cancelling is not allowed after the postcopy phase has started.
+# Cancel the currently executing migration process. Allows a new
+# migration to be started right after. When postcopy-ram is in
+# use, cancelling is not allowed after the postcopy phase has
+# started.
#
# .. note:: This command succeeds even if there is no migration
# process running.
@@ -1619,8 +1619,8 @@
##
# @xen-colo-do-checkpoint:
-#
-# Xen uses this command to notify replication to trigger a checkpoint.
+# Xen uses this command to notify replication to trigger a
+# checkpoint.
#
# .. qmp-example::
#
@@ -1687,8 +1687,7 @@
##
# @migrate-pause:
-#
-# Pause a migration. Currently it only supports postcopy.
+# Pause a migration. Currently it only supports postcopy.
#
# .. qmp-example::
#
diff --git a/qapi/misc.json b/qapi/misc.json
index b3c2a1421f3..ec783c067c9 100644
--- a/qapi/misc.json
+++ b/qapi/misc.json
@@ -103,8 +103,7 @@
##
# @query-iothreads:
-#
-# Return a list of information about each iothread.
+# Return a list of information about each iothread.
#
# .. note:: This list excludes the QEMU main loop thread, which is not
# declared using the ``-object iothread`` command-line option. It
diff --git a/qapi/run-state.json b/qapi/run-state.json
index 703ca1bb5b9..8bbd9884087 100644
--- a/qapi/run-state.json
+++ b/qapi/run-state.json
@@ -232,10 +232,9 @@
##
# @SUSPEND_DISK:
-#
-# Emitted when guest enters a hardware suspension state with data
-# saved on disk, for example, S4 state, which is sometimes called
-# hibernate state
+# Emitted when guest enters a hardware suspension state with data
+# saved on disk, for example, S4 state, which is sometimes called
+# hibernate state
#
# .. note:: QEMU shuts down (similar to event `SHUTDOWN`) when
# entering this state.
--
2.55.0
next prev parent reply other threads:[~2026-09-11 17:22 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-11 17:21 [PATCH 0/6] qapi: convert remaining "simple" intro sections John Snow
2026-09-11 17:21 ` [PATCH 1/6] qapi: convert remaining simple intros for block-export.json John Snow
2026-09-12 7:34 ` Markus Armbruster
2026-09-11 17:21 ` [PATCH 2/6] qapi: convert remaining simple intros for cxl.json John Snow
2026-09-11 17:21 ` [PATCH 3/6] qapi: convert remaining simple intros for machine.json John Snow
2026-09-12 7:34 ` Markus Armbruster
2026-09-11 17:21 ` [PATCH 4/6] qapi: convert remaining simple intros for block-core.json John Snow
2026-09-12 7:35 ` Markus Armbruster
2026-09-11 17:21 ` [PATCH 5/6] qapi: convert intro sections with "TODO" markers John Snow
2026-09-12 6:58 ` Markus Armbruster
2026-09-11 17:22 ` John Snow [this message]
2026-09-12 7:36 ` [PATCH 0/6] qapi: convert remaining "simple" intro sections 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=20260911172200.227914-7-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=farosas@suse.de \
--cc=hreitz@redhat.com \
--cc=jasowangio@gmail.com \
--cc=jic23@kernel.org \
--cc=kwolf@redhat.com \
--cc=linux-cxl@vger.kernel.org \
--cc=lukasstraub2@web.de \
--cc=pbonzini@redhat.com \
--cc=peterx@redhat.com \
--cc=philmd@mailo.com \
--cc=qemu-block@nongnu.org \
--cc=qemu-devel@nongnu.org \
--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