mirror of
https://github.com/izzy2lost/xemu.git
synced 2026-07-06 00:20:22 -07:00
qapi: add cross-references to block layer
Signed-off-by: John Snow <jsnow@redhat.com> Message-ID: <20250711054005.60969-4-jsnow@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> [Two unwanted cross-references dropped] Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
committed by
Markus Armbruster
parent
a724defe32
commit
a3763337ad
+92
-92
File diff suppressed because it is too large
Load Diff
+18
-18
@@ -38,9 +38,9 @@
|
||||
##
|
||||
# @NbdServerOptions:
|
||||
#
|
||||
# Keep this type consistent with the NbdServerOptionsLegacy type. The
|
||||
# only intended difference is using SocketAddress instead of
|
||||
# SocketAddressLegacy.
|
||||
# Keep this type consistent with the `NbdServerOptionsLegacy` type. The
|
||||
# only intended difference is using `SocketAddress` instead of
|
||||
# `SocketAddressLegacy`.
|
||||
#
|
||||
# @addr: Address on which to listen (since 4.2).
|
||||
##
|
||||
@@ -51,9 +51,9 @@
|
||||
##
|
||||
# @NbdServerOptionsLegacy:
|
||||
#
|
||||
# Keep this type consistent with the NbdServerOptions type. The only
|
||||
# intended difference is using SocketAddressLegacy instead of
|
||||
# SocketAddress.
|
||||
# Keep this type consistent with the `NbdServerOptions` type. The only
|
||||
# intended difference is using `SocketAddressLegacy` instead of
|
||||
# `SocketAddress`.
|
||||
#
|
||||
# @addr: Address on which to listen (since 1.3).
|
||||
##
|
||||
@@ -65,7 +65,7 @@
|
||||
# @nbd-server-start:
|
||||
#
|
||||
# Start an NBD server listening on the given host and port. Block
|
||||
# devices can then be exported using @nbd-server-add. The NBD server
|
||||
# devices can then be exported using `nbd-server-add`. The NBD server
|
||||
# will present them as named exports; for example, another QEMU
|
||||
# instance could refer to them as "nbd:HOST:PORT:exportname=NAME".
|
||||
#
|
||||
@@ -81,8 +81,8 @@
|
||||
##
|
||||
# @BlockExportOptionsNbdBase:
|
||||
#
|
||||
# An NBD block export (common options shared between nbd-server-add
|
||||
# and the NBD branch of block-export-add).
|
||||
# An NBD block export (common options shared between `nbd-server-add`
|
||||
# and the NBD branch of `block-export-add`).
|
||||
#
|
||||
# @name: Export name. If unspecified, the @device parameter is used
|
||||
# as the export name. (Since 2.12)
|
||||
@@ -99,7 +99,7 @@
|
||||
# @BlockExportOptionsNbd:
|
||||
#
|
||||
# An NBD block export (distinct options used in the NBD branch of
|
||||
# block-export-add).
|
||||
# `block-export-add`).
|
||||
#
|
||||
# @bitmaps: Also export each of the named dirty bitmaps reachable from
|
||||
# @device, so the NBD client can use NBD_OPT_SET_META_CONTEXT with
|
||||
@@ -125,7 +125,7 @@
|
||||
# A vhost-user-blk block export.
|
||||
#
|
||||
# @addr: The vhost-user socket on which to listen. Both 'unix' and
|
||||
# 'fd' SocketAddress types are supported. Passed fds must be UNIX
|
||||
# 'fd' `SocketAddress` types are supported. Passed fds must be UNIX
|
||||
# domain sockets.
|
||||
#
|
||||
# @logical-block-size: Logical block size in bytes. Defaults to 512
|
||||
@@ -217,7 +217,7 @@
|
||||
##
|
||||
# @NbdServerAddOptions:
|
||||
#
|
||||
# An NBD block export, per legacy nbd-server-add command.
|
||||
# An NBD block export, per legacy `nbd-server-add` command.
|
||||
#
|
||||
# @device: The device name or node name of the node to be exported
|
||||
#
|
||||
@@ -246,7 +246,7 @@
|
||||
#
|
||||
# Features:
|
||||
#
|
||||
# @deprecated: This command is deprecated. Use @block-export-add
|
||||
# @deprecated: This command is deprecated. Use `block-export-add`
|
||||
# instead.
|
||||
#
|
||||
# Errors:
|
||||
@@ -289,12 +289,12 @@
|
||||
#
|
||||
# @name: Block export id.
|
||||
#
|
||||
# @mode: Mode of command operation. See @BlockExportRemoveMode
|
||||
# @mode: Mode of command operation. See `BlockExportRemoveMode`
|
||||
# description. Default is 'safe'.
|
||||
#
|
||||
# Features:
|
||||
#
|
||||
# @deprecated: This command is deprecated. Use @block-export-del
|
||||
# @deprecated: This command is deprecated. Use `block-export-del`
|
||||
# instead.
|
||||
#
|
||||
# Errors:
|
||||
@@ -313,7 +313,7 @@
|
||||
# @nbd-server-stop:
|
||||
#
|
||||
# Stop QEMU's embedded NBD server, and unregister all devices
|
||||
# previously added via @nbd-server-add.
|
||||
# previously added via `nbd-server-add`.
|
||||
#
|
||||
# Since: 1.3
|
||||
##
|
||||
@@ -422,7 +422,7 @@
|
||||
#
|
||||
# @id: Block export id.
|
||||
#
|
||||
# @mode: Mode of command operation. See @BlockExportRemoveMode
|
||||
# @mode: Mode of command operation. See `BlockExportRemoveMode`
|
||||
# description. Default is 'safe'.
|
||||
#
|
||||
# Errors:
|
||||
@@ -460,7 +460,7 @@
|
||||
# @node-name: The node name of the block node that is exported
|
||||
#
|
||||
# @shutting-down: True if the export is shutting down (e.g. after a
|
||||
# block-export-del command, but before the shutdown has completed)
|
||||
# `block-export-del` command, but before the shutdown has completed)
|
||||
#
|
||||
# Since: 5.2
|
||||
##
|
||||
|
||||
+7
-7
@@ -140,7 +140,7 @@
|
||||
#
|
||||
# If the tray was already open before, this will be a no-op.
|
||||
#
|
||||
# Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There
|
||||
# Once the tray opens, a `DEVICE_TRAY_MOVED` event is emitted. There
|
||||
# are cases in which no such event will be generated, these include:
|
||||
#
|
||||
# - if the guest has locked the tray, @force is false and the guest
|
||||
@@ -299,7 +299,7 @@
|
||||
# @BlockdevChangeReadOnlyMode:
|
||||
#
|
||||
# Specifies the new read-only mode of a block device subject to the
|
||||
# @blockdev-change-medium command.
|
||||
# `blockdev-change-medium` command.
|
||||
#
|
||||
# @retain: Retains the current read-only mode
|
||||
#
|
||||
@@ -317,9 +317,9 @@
|
||||
#
|
||||
# Changes the medium inserted into a block device by ejecting the
|
||||
# current medium and loading a new image file which is inserted as the
|
||||
# new medium (this command combines blockdev-open-tray,
|
||||
# blockdev-remove-medium, blockdev-insert-medium and
|
||||
# blockdev-close-tray).
|
||||
# new medium (this command combines `blockdev-open-tray`,
|
||||
# `blockdev-remove-medium`, `blockdev-insert-medium` and
|
||||
# `blockdev-close-tray`).
|
||||
#
|
||||
# @device: Block device name
|
||||
#
|
||||
@@ -334,7 +334,7 @@
|
||||
# to 'retain'
|
||||
#
|
||||
# @force: if false (the default), an eject request through
|
||||
# blockdev-open-tray will be sent to the guest if it has locked
|
||||
# `blockdev-open-tray` will be sent to the guest if it has locked
|
||||
# the tray (and the tray will not be opened immediately); if true,
|
||||
# the tray will be opened regardless of whether it is locked.
|
||||
# (since 7.1)
|
||||
@@ -522,7 +522,7 @@
|
||||
# @id: The name or QOM path of the guest device.
|
||||
#
|
||||
# @boundaries: list of interval boundary values (see description in
|
||||
# BlockLatencyHistogramInfo definition). If specified, all
|
||||
# `BlockLatencyHistogramInfo` definition). If specified, all
|
||||
# latency histograms are removed, and empty ones created for all
|
||||
# io types with intervals corresponding to @boundaries (except for
|
||||
# io types, for which specific boundaries are set through the
|
||||
|
||||
@@ -69,8 +69,8 @@
|
||||
#
|
||||
# Features:
|
||||
#
|
||||
# @deprecated: Member @drive-backup is deprecated. Use member
|
||||
# @blockdev-backup instead.
|
||||
# @deprecated: Member `drive-backup` is deprecated. Use member
|
||||
# `blockdev-backup` instead.
|
||||
#
|
||||
# Since: 1.1
|
||||
##
|
||||
@@ -158,7 +158,7 @@
|
||||
# @TransactionAction:
|
||||
#
|
||||
# A discriminated record of operations that can be performed with
|
||||
# @transaction.
|
||||
# `transaction`.
|
||||
#
|
||||
# @type: the operation to be performed
|
||||
#
|
||||
@@ -189,7 +189,7 @@
|
||||
#
|
||||
# @completion-mode: Controls how jobs launched asynchronously by
|
||||
# Actions will complete or fail as a group. See
|
||||
# @ActionCompletionMode for details.
|
||||
# `ActionCompletionMode` for details.
|
||||
#
|
||||
# Since: 2.5
|
||||
##
|
||||
@@ -229,11 +229,11 @@
|
||||
# in the transaction. When an I/O error occurs during deletion, the
|
||||
# user needs to fix it later with qemu-img or other command.
|
||||
#
|
||||
# @actions: List of @TransactionAction; information needed for the
|
||||
# @actions: List of `TransactionAction`; information needed for the
|
||||
# respective operations.
|
||||
#
|
||||
# @properties: structure of additional options to control the
|
||||
# execution of the transaction. See @TransactionProperties for
|
||||
# execution of the transaction. See `TransactionProperties` for
|
||||
# additional detail.
|
||||
#
|
||||
# Errors:
|
||||
|
||||
Reference in New Issue
Block a user