[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 19/20] qapi/block-core: improve Qcow2OverlapCheckFlags documentati
From: |
Markus Armbruster |
Subject: |
[PULL 19/20] qapi/block-core: improve Qcow2OverlapCheckFlags documentation |
Date: |
Tue, 26 Mar 2024 08:34:19 +0100 |
From: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
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>
---
qapi/block-core.json | 25 +++++++++++++++++++++----
qapi/pragma.json | 1 -
2 files changed, 21 insertions(+), 5 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 7d3fe59f6c..746d1694c2 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -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
##
diff --git a/qapi/pragma.json b/qapi/pragma.json
index 99e4052ab3..9e28de1721 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -72,7 +72,6 @@
'QCryptoAkCipherKeyType',
'QCryptodevBackendServiceType',
'QKeyCode',
- 'Qcow2OverlapCheckFlags',
'RbdAuthMode',
'RbdImageEncryptionFormat',
'String',
--
2.44.0
- [PULL 01/20] qapi: Improve migration TLS documentation, (continued)
- [PULL 01/20] qapi: Improve migration TLS documentation, Markus Armbruster, 2024/03/26
- [PULL 03/20] qapi: Fix bogus documentation of query-migrationthreads, Markus Armbruster, 2024/03/26
- [PULL 02/20] qapi: Resync MigrationParameter and MigrateSetParameters, Markus Armbruster, 2024/03/26
- [PULL 11/20] qapi: Start sentences with a capital letter, end them with a period, Markus Armbruster, 2024/03/26
- [PULL 10/20] qapi: Fix abbreviation punctuation in doc comments, Markus Armbruster, 2024/03/26
- [PULL 05/20] qapi: Expand a few awkward abbreviations in documentation, Markus Armbruster, 2024/03/26
- [PULL 06/20] qapi: Tidy up block-latency-histogram-set documentation some more, Markus Armbruster, 2024/03/26
- [PULL 08/20] qapi: Fix argument markup in drive-mirror documentation, Markus Armbruster, 2024/03/26
- [PULL 09/20] qapi: Fix typo in request-ebpf documentation, Markus Armbruster, 2024/03/26
- [PULL 16/20] qapi: document InputMultiTouchType, Markus Armbruster, 2024/03/26
- [PULL 19/20] qapi/block-core: improve Qcow2OverlapCheckFlags documentation,
Markus Armbruster <=
- [PULL 17/20] qapi: document leftover members in qapi/run-state.json, Markus Armbruster, 2024/03/26
- [PULL 15/20] qga/qapi-schema: Refill doc comments to conform to current conventions, Markus Armbruster, 2024/03/26
- [PULL 18/20] qapi: document leftover members in qapi/stats.json, Markus Armbruster, 2024/03/26
- [PULL 20/20] qapi: document parameters of query-cpu-model-* QAPI commands, Markus Armbruster, 2024/03/26
- [PULL 13/20] qapi: Refill doc comments to conform to current conventions, Markus Armbruster, 2024/03/26
- [PULL 04/20] qapi: Drop stray Arguments: line from qmp_capabilities docs, Markus Armbruster, 2024/03/26
- [PULL 14/20] qapi: Correct documentation indentation and whitespace, Markus Armbruster, 2024/03/26
- [PULL 12/20] qapi: Don't repeat member type in its documentation text, Markus Armbruster, 2024/03/26
- [PULL 07/20] qapi: Tidy up indentation of add_client's example, Markus Armbruster, 2024/03/26
- Re: [PULL 00/20] QAPI patches patches for 2024-03-26, Peter Maydell, 2024/03/26