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>
This commit is contained in:
John Snow 2025-07-11 01:40:04 -04:00 committed by Markus Armbruster
parent 6e202378d1
commit 13f53cc902

View File

@ -11,7 +11,7 @@
## ##
# @YankInstanceType: # @YankInstanceType:
# #
# An enumeration of yank instance types. See @YankInstance for more # An enumeration of yank instance types. See `YankInstance` for more
# information. # information.
# #
# Since: 6.0 # Since: 6.0
@ -22,7 +22,7 @@
## ##
# @YankInstanceBlockNode: # @YankInstanceBlockNode:
# #
# Specifies which block graph node to yank. See @YankInstance for # Specifies which block graph node to yank. See `YankInstance` for
# more information. # more information.
# #
# @node-name: the name of the block graph node # @node-name: the name of the block graph node
@ -35,7 +35,7 @@
## ##
# @YankInstanceChardev: # @YankInstanceChardev:
# #
# Specifies which character device to yank. See @YankInstance for # Specifies which character device to yank. See `YankInstance` for
# more information. # more information.
# #
# @id: the chardev's ID # @id: the chardev's ID
@ -48,7 +48,7 @@
## ##
# @YankInstance: # @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. # from a hanging QEMU.
# #
# @type: yank instance type # @type: yank instance type
@ -59,9 +59,9 @@
# nbd server without attempting to reconnect. # nbd server without attempting to reconnect.
# - socket chardev: Yanking it will shut down the connected socket. # - socket chardev: Yanking it will shut down the connected socket.
# - migration: Yanking it will shut down all migration connections. # - 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 # 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 # Since: 6.0
## ##
@ -76,7 +76,7 @@
# @yank: # @yank:
# #
# Try to recover from hanging QEMU by yanking the specified instances. # 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 # @instances: the instances to be yanked
# #
@ -102,7 +102,7 @@
## ##
# @query-yank: # @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 # TODO: This line is a hack to separate the example from the body
# #