Skip to content

Commit

Permalink
qapi/block-core: improve Qcow2OverlapCheckFlags documentation
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Vladimir Sementsov-Ogievskiy authored and Markus Armbruster committed Mar 26, 2024
1 parent 1de7595 commit 125f973
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
25 changes: 21 additions & 4 deletions qapi/block-core.json
Original file line number Diff line number Diff line change
Expand Up @@ -3403,14 +3403,31 @@
# @Qcow2OverlapCheckFlags:
#
# Structure of flags for each metadata structure. Setting a field to
# 'true' makes qemu guard that structure against unintended
# overwriting. The default value is chosen according to the template
# given.
# 'true' makes QEMU guard that Qcow2 format structure against
# unintended overwriting. See Qcow2 format specification for detailed
# 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
# 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
##
Expand Down
1 change: 0 additions & 1 deletion qapi/pragma.json
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@
'QCryptoAkCipherKeyType',
'QCryptodevBackendServiceType',
'QKeyCode',
'Qcow2OverlapCheckFlags',
'RbdAuthMode',
'RbdImageEncryptionFormat',
'String',
Expand Down

0 comments on commit 125f973

Please sign in to comment.