qapi: Add missing union tag documentation

Low-hanging fruit, and except for StatsFilter, the only members of
these unions lacking documentation.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240205074709.3613229-16-armbru@redhat.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Markus Armbruster 2024-02-05 08:47:09 +01:00
parent 8bf69544b5
commit 89a2273b9d
12 changed files with 34 additions and 16 deletions

View File

@ -252,6 +252,8 @@
# A discriminated record of image format specific information
# structures.
#
# @type: block driver name
#
# Since: 1.7
##
{ 'union': 'ImageInfoSpecific',
@ -1102,6 +1104,8 @@
#
# Block driver specific statistics
#
# @driver: block driver name
#
# Since: 4.2
##
{ 'union': 'BlockStatsSpecific',
@ -3472,6 +3476,8 @@
##
# @BlockdevQcowEncryption:
#
# @format: encryption format
#
# Since: 2.10
##
{ 'union': 'BlockdevQcowEncryption',
@ -3506,6 +3512,8 @@
##
# @BlockdevQcow2Encryption:
#
# @format: encryption format
#
# Since: 2.10
##
{ 'union': 'BlockdevQcow2Encryption',
@ -3656,6 +3664,8 @@
##
# @SshHostKeyCheck:
#
# @mode: How to check the host key
#
# Since: 2.12
##
{ 'union': 'SshHostKeyCheck',
@ -4225,6 +4235,8 @@
##
# @RbdEncryptionCreateOptions:
#
# @format: Encryption format.
#
# Since: 6.1
##
{ 'union': 'RbdEncryptionCreateOptions',

View File

@ -346,6 +346,8 @@
# Describes a block export, i.e. how single node should be exported on
# an external interface.
#
# @type: Block export type
#
# @id: A unique identifier for the block export (across all export
# types)
#

View File

@ -634,6 +634,8 @@
#
# Configuration info for the new chardev backend.
#
# @type: backend type
#
# Since: 1.4
##
{ 'union': 'ChardevBackend',

View File

@ -645,6 +645,8 @@
# The options that are available for all asymmetric key algorithms
# when creating a new QCryptoAkCipher.
#
# @alg: encryption cipher algorithm
#
# Since: 7.1
##
{ 'union': 'QCryptoAkCipherOptions',

View File

@ -443,6 +443,8 @@
#
# A discriminated record of NUMA options. (for OptsVisitor)
#
# @type: NUMA option type
#
# Since: 2.1
##
{ 'union': 'NumaOptions',
@ -1448,6 +1450,8 @@
#
# Union containing information about a memory device
#
# @type: memory device type
#
# Since: 2.1
##
{ 'union': 'MemoryDeviceInfo',

View File

@ -1630,6 +1630,8 @@
#
# Migration endpoint configuration.
#
# @transport: The migration stream transport mechanism
#
# Since: 8.2
##
{ 'union': 'MigrationAddress',

View File

@ -39,18 +39,13 @@
'BlockDirtyBitmapAddWrapper',
'BlockDirtyBitmapMergeWrapper',
'BlockDirtyBitmapWrapper',
'BlockExportOptions',
'BlockStatsSpecific',
'BlockdevBackupWrapper',
'BlockdevDriver',
'BlockdevQcow2Encryption',
'BlockdevQcow2EncryptionFormat',
'BlockdevQcowEncryption',
'BlockdevSnapshotInternalWrapper',
'BlockdevSnapshotSyncWrapper',
'BlockdevSnapshotWrapper',
'BlockdevVmdkAdapterType',
'ChardevBackend',
'ChardevBackendKind',
'CpuS390Entitlement',
'CpuS390Polarization',
@ -64,7 +59,6 @@
'GrabToggleKeys',
'GuestPanicInformationHyperV',
'HotKeyMod',
'ImageInfoSpecific',
'ImageInfoSpecificKind',
'InputAxis',
'InputButton',
@ -73,38 +67,28 @@
'IscsiHeaderDigest',
'IscsiTransport',
'JSONType',
'KeyValue',
'KeyValueKind',
'MemoryDeviceInfo',
'MemoryDeviceInfoKind',
'MigrateSetParameters',
'MigrationAddress',
'NetClientDriver',
'NumaOptions',
'ObjectType',
'PciMemoryRegion',
'QCryptoAkCipherKeyType',
'QCryptoAkCipherOptions',
'QCryptodevBackendServiceType',
'QKeyCode',
'Qcow2OverlapCheckFlags',
'RbdAuthMode',
'RbdEncryptionCreateOptions',
'RbdImageEncryptionFormat',
'SocketAddressLegacy',
'SshHostKeyCheck',
'StatsFilter',
'StatsValue',
'String',
'StringWrapper',
'SysEmuTarget',
'ThrottleGroupProperties',
'TransactionAction',
'VncPrimaryAuth',
'VncVencryptSubAuth',
'X86CPURegister32',
'XDbgBlockGraph',
'YankInstance',
'YankInstanceType',
'blockdev-reopen',
'query-cpu-model-baseline',

View File

@ -178,6 +178,8 @@
# Captures the address of a socket, which could also be a named file
# descriptor
#
# @type: Transport type
#
# Note: This type is deprecated in favor of SocketAddress. The
# difference between SocketAddressLegacy and SocketAddress is that
# the latter has fewer {} on the wire.

View File

@ -120,6 +120,8 @@
# - which providers to request statistics from
# - which named values to return within each provider
#
# @target: the kind of objects to query
#
# Since: 7.1
##
{ 'union': 'StatsFilter',

View File

@ -158,6 +158,8 @@
# A discriminated record of operations that can be performed with
# @transaction.
#
# @type: the operation to be performed
#
# Since: 1.1
##
{ 'union': 'TransactionAction',

View File

@ -1012,6 +1012,8 @@
#
# Represents a keyboard key.
#
# @type: key encoding
#
# Since: 1.3
##
{ 'union': 'KeyValue',

View File

@ -49,6 +49,8 @@
# A yank instance can be yanked with the @yank qmp command to recover
# from a hanging QEMU.
#
# @type: yank instance type
#
# Currently implemented yank instances:
#
# - nbd block device: Yanking it will shut down the connection to the