| Message ID | 20240325120054.2693236-1-vsementsov@yandex-team.ru |
|---|---|
| State | New |
| Headers | show |
| Series | qapi/block-core: improve Qcow2OverlapCheckFlags documentation | expand |
Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru> writes: > 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> > --- > qapi/block-core.json | 25 +++++++++++++++++++++---- > 1 file changed, 21 insertions(+), 4 deletions(-) > > diff --git a/qapi/block-core.json b/qapi/block-core.json > index 1874f880a8..b9fb994a66 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 Mind if I use the occasion to correct the spelling of QEMU? > +# 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 > ## Acked-by: Markus Armbruster <armbru@redhat.com>
Squashing in
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',
On 25.03.24 16:04, Markus Armbruster wrote: > Vladimir Sementsov-Ogievskiy<vsementsov@yandex-team.ru> writes: > >> 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> >> --- >> qapi/block-core.json | 25 +++++++++++++++++++++---- >> 1 file changed, 21 insertions(+), 4 deletions(-) >> >> diff --git a/qapi/block-core.json b/qapi/block-core.json >> index 1874f880a8..b9fb994a66 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 > Mind if I use the occasion to correct the spelling of QEMU? No problem, thanks for fixing
diff --git a/qapi/block-core.json b/qapi/block-core.json index 1874f880a8..b9fb994a66 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 ##
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> --- qapi/block-core.json | 25 +++++++++++++++++++++---- 1 file changed, 21 insertions(+), 4 deletions(-)