qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Marcel Apfelbaum" <marcel.apfelbaum@gmail.com>,
	"Yanan Wang" <wangyanan55@huawei.com>,
	"Paolo Bonzini" <pbonzini@redhat.com>,
	"Marc-André Lureau" <marcandre.lureau@redhat.com>,
	"Igor Mammedov" <imammedo@redhat.com>,
	"Vladimir Sementsov-Ogievskiy" <vsementsov@yandex-team.ru>,
	"Eric Blake" <eblake@redhat.com>, "Kevin Wolf" <kwolf@redhat.com>,
	"Zhao Liu" <zhao1.liu@intel.com>,
	"Alex Bennée" <alex.bennee@linaro.org>,
	"Lukas Straub" <lukasstraub2@web.de>,
	"Ani Sinha" <anisinha@redhat.com>,
	"Philippe Mathieu-Daudé" <philmd@linaro.org>,
	"Markus Armbruster" <armbru@redhat.com>,
	"Fabiano Rosas" <farosas@suse.de>,
	"Jason Wang" <jasowang@redhat.com>,
	"Michael S. Tsirkin" <mst@redhat.com>,
	"John Snow" <jsnow@redhat.com>, "Hanna Reitz" <hreitz@redhat.com>,
	qemu-block@nongnu.org, "Peter Xu" <peterx@redhat.com>,
	"Daniel P. Berrangé" <berrange@redhat.com>,
	"Eduardo Habkost" <eduardo@habkost.net>
Subject: [PATCH 17/18] qapi: add cross-references to yank.json
Date: Fri, 13 Jun 2025 16:36:19 -0400	[thread overview]
Message-ID: <20250613203620.1283814-18-jsnow@redhat.com> (raw)
In-Reply-To: <20250613203620.1283814-1-jsnow@redhat.com>

Signed-off-by: John Snow <jsnow@redhat.com>
---
 qapi/yank.json | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)

diff --git a/qapi/yank.json b/qapi/yank.json
index 9bd8ecce27f..931d4b22d4b 100644
--- a/qapi/yank.json
+++ b/qapi/yank.json
@@ -9,7 +9,7 @@
 ##
 # @YankInstanceType:
 #
-# An enumeration of yank instance types.  See @YankInstance for more
+# An enumeration of `yank` instance types.  See `YankInstance` for more
 # information.
 #
 # Since: 6.0
@@ -20,7 +20,7 @@
 ##
 # @YankInstanceBlockNode:
 #
-# Specifies which block graph node to yank.  See @YankInstance for
+# Specifies which block graph node to `yank`.  See `YankInstance` for
 # more information.
 #
 # @node-name: the name of the block graph node
@@ -33,7 +33,7 @@
 ##
 # @YankInstanceChardev:
 #
-# Specifies which character device to yank.  See @YankInstance for
+# Specifies which character device to `yank`.  See `YankInstance` for
 # more information.
 #
 # @id: the chardev's ID
@@ -46,20 +46,20 @@
 ##
 # @YankInstance:
 #
-# A yank instance can be yanked with the @yank qmp command to recover
+# A `yank` instance can be yanked with the `yank` qmp command to recover
 # from a hanging QEMU.
 #
-# @type: yank instance type
+# @type: `yank` instance type
 #
-# Currently implemented yank instances:
+# Currently implemented `yank` instances:
 #
 # - nbd block device: Yanking it will shut down the connection to the
 #   nbd server without attempting to reconnect.
 # - socket chardev: Yanking it will shut down the connected socket.
 # - migration: Yanking it will shut down all migration connections.
-#   Unlike @migrate_cancel, it will not notify the migration process,
+#   Unlike `migrate_cancel`, it will not notify the migration process,
 #   so migration will go into @failed state, instead of @cancelled
-#   state.  @yank should be used to recover from hangs.
+#   state.  `yank` should be used to recover from hangs.
 #
 # Since: 6.0
 ##
@@ -74,7 +74,7 @@
 # @yank:
 #
 # Try to recover from hanging QEMU by yanking the specified instances.
-# See @YankInstance for more information.
+# See `YankInstance` for more information.
 #
 # @instances: the instances to be yanked
 #
@@ -100,7 +100,7 @@
 ##
 # @query-yank:
 #
-# Query yank instances.  See @YankInstance for more information.
+# Query `yank` instances.  See `YankInstance` for more information.
 #
 #
 # .. qmp-example::
-- 
2.48.1



  parent reply	other threads:[~2025-06-13 20:40 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-13 20:36 [PATCH 00/18] QAPI: add cross-references to qapi docs John Snow
2025-06-13 20:36 ` [PATCH 01/18] qapi: add cross-references to acpi.json John Snow
2025-06-13 20:36 ` [PATCH 02/18] qapi: add cross-references to authz.json John Snow
2025-06-13 20:36 ` [PATCH 03/18] qapi: add cross-references to block layer John Snow
2025-06-16 16:30   ` Eric Blake
2025-06-16 16:45     ` John Snow
2025-07-02  7:45   ` Markus Armbruster
2025-06-13 20:36 ` [PATCH 04/18] qapi: add cross-references to crypto.json John Snow
2025-06-13 20:36 ` [PATCH 05/18] qapi: add cross-references to dump.json John Snow
2025-06-13 20:36 ` [PATCH 06/18] qapi: add cross-references to job.json John Snow
2025-07-02  7:57   ` Markus Armbruster
2025-06-13 20:36 ` [PATCH 07/18] qapi: add cross-references to Machine core John Snow
2025-07-02  8:00   ` Markus Armbruster
2025-06-13 20:36 ` [PATCH 08/18] qapi: add cross-references to migration.json John Snow
2025-07-02  8:04   ` Markus Armbruster
2025-07-11  5:32     ` John Snow
2025-06-13 20:36 ` [PATCH 09/18] qapi: add cross-references to net.json John Snow
2025-06-13 20:36 ` [PATCH 10/18] qapi: add cross-references to pci.json John Snow
2025-06-13 20:36 ` [PATCH 11/18] qapi: add cross-references to QOM John Snow
2025-06-13 20:36 ` [PATCH 12/18] qapi: add cross-references to replay.json John Snow
2025-06-13 20:36 ` [PATCH 13/18] qapi: add cross-references to run-state.json John Snow
2025-06-13 20:36 ` [PATCH 14/18] qapi: add cross-references to sockets.json John Snow
2025-06-16 17:04   ` Eric Blake
2025-06-13 20:36 ` [PATCH 15/18] qapi: add cross-references to ui.json John Snow
2025-07-02  8:10   ` Markus Armbruster
2025-06-13 20:36 ` [PATCH 16/18] qapi: add cross-references to virtio.json John Snow
2025-06-13 20:36 ` John Snow [this message]
2025-06-16 15:24   ` [PATCH 17/18] qapi: add cross-references to yank.json Lukas Straub
2025-07-02  8:14   ` Markus Armbruster
2025-06-13 20:36 ` [PATCH 18/18] qapi: add cross-references to misc modules John Snow
2025-06-16 17:06   ` Eric Blake

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=20250613203620.1283814-18-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).