aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2025-07-11 01:40:04 -0400
committerMarkus Armbruster <armbru@redhat.com>2025-07-14 12:58:13 +0200
commit13f53cc902b7fa6d1864f7c13c3b3c755d1001a5 (patch)
tree500a8171846eff0ad2fe75140f6c98375b819222
parent6e202378d1533d87f77c73ffb22fbb784d08f545 (diff)
downloadqemu-13f53cc902b7fa6d1864f7c13c3b3c755d1001a5.zip
qemu-13f53cc902b7fa6d1864f7c13c3b3c755d1001a5.tar.gz
qemu-13f53cc902b7fa6d1864f7c13c3b3c755d1001a5.tar.bz2
qapi: add cross-references to yank.json
Signed-off-by: John Snow <jsnow@redhat.com> Acked-by: Lukas Straub <lukasstraub2@web.de> Message-ID: <20250711054005.60969-18-jsnow@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
-rw-r--r--qapi/yank.json16
1 files changed, 8 insertions, 8 deletions
diff --git a/qapi/yank.json b/qapi/yank.json
index c14de52..f3cd5c1 100644
--- a/qapi/yank.json
+++ b/qapi/yank.json
@@ -11,7 +11,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
@@ -22,7 +22,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
@@ -35,7 +35,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
@@ -48,7 +48,7 @@
##
# @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
@@ -59,9 +59,9 @@
# 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
##
@@ -76,7 +76,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
#
@@ -102,7 +102,7 @@
##
# @query-yank:
#
-# Query yank instances. See @YankInstance for more information.
+# Query yank instances. See `YankInstance` for more information.
#
# TODO: This line is a hack to separate the example from the body
#