qapi/block-core: improve Qcow2OverlapCheckFlags documentation

Most of fields have no description at all. Let's fix that. Still, no
reason to place here more detailed descriptions of what these
structures are, as we have public Qcow2 format specification.

Signed-off-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Message-ID: <20240325120054.2693236-1-vsementsov@yandex-team.ru>
Acked-by: Markus Armbruster <armbru@redhat.com>
[Capitalize "QEMU", update qapi/pragma.json]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
Vladimir Sementsov-Ogievskiy 2024-03-25 15:00:54 +03:00 committed by Markus Armbruster
parent 1de759534d
commit 125f973cc2
2 changed files with 21 additions and 5 deletions

View File

@ -3403,14 +3403,31 @@
# @Qcow2OverlapCheckFlags: # @Qcow2OverlapCheckFlags:
# #
# Structure of flags for each metadata structure. Setting a field to # Structure of flags for each metadata structure. Setting a field to
# 'true' makes qemu guard that structure against unintended # 'true' makes QEMU guard that Qcow2 format structure against
# overwriting. The default value is chosen according to the template # unintended overwriting. See Qcow2 format specification for detailed
# given. # information on these structures. The default value is chosen
# according to the template given.
# #
# @template: Specifies a template mode which can be adjusted using the # @template: Specifies a template mode which can be adjusted using the
# other flags, defaults to 'cached' # other flags, defaults to 'cached'
# #
# @bitmap-directory: since 3.0 # @main-header: Qcow2 format header
#
# @active-l1: Qcow2 active L1 table
#
# @active-l2: Qcow2 active L2 table
#
# @refcount-table: Qcow2 refcount table
#
# @refcount-block: Qcow2 refcount blocks
#
# @snapshot-table: Qcow2 snapshot table
#
# @inactive-l1: Qcow2 inactive L1 tables
#
# @inactive-l2: Qcow2 inactive L2 tables
#
# @bitmap-directory: Qcow2 bitmap directory (since 3.0)
# #
# Since: 2.9 # Since: 2.9
## ##

View File

@ -72,7 +72,6 @@
'QCryptoAkCipherKeyType', 'QCryptoAkCipherKeyType',
'QCryptodevBackendServiceType', 'QCryptodevBackendServiceType',
'QKeyCode', 'QKeyCode',
'Qcow2OverlapCheckFlags',
'RbdAuthMode', 'RbdAuthMode',
'RbdImageEncryptionFormat', 'RbdImageEncryptionFormat',
'String', 'String',