Marc-André Lureau <marcandre.lur...@redhat.com> writes:
> Signed-off-by: Marc-André Lureau <marcandre.lur...@redhat.com>
> ---
> qapi-schema.json | 4 ++--
> qapi/block-core.json | 4 ++--
> qapi/crypto.json | 36 ++++++++++++++++++------------------
> 3 files changed, 22 insertions(+), 22 deletions(-)
>
> diff --git a/qapi-schema.json b/qapi-schema.json
> index f07ffd7..3091993 100644
> --- a/qapi-schema.json
> +++ b/qapi-schema.json
> @@ -4526,7 +4526,7 @@
> { 'include': 'qapi/rocker.json' }
>
> ##
> -# ReplayMode:
> +# @ReplayMode:
> #
> # Mode of the replay subsystem.
> #
> @@ -4594,7 +4594,7 @@
> { 'command': 'query-gic-capabilities', 'returns': ['GICCapability'] }
>
> ##
> -# CpuInstanceProperties
> +# @CpuInstanceProperties
> #
> # List of properties to be used for hotplugging a CPU instance,
> # it should be passed by management with device_add command when
The example in qapi-code-gen.txt has a colon after the symbol name:
##
# @BlockStats:
The text doesn't mention it. Tne schema uses colons inconsistently, as
visible above. Let's enforce colons.
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index cf8e980..73f4180 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -1149,7 +1149,7 @@
> 'data': 'DriveMirror' }
>
> ##
> -# DriveMirror
> +# @DriveMirror
> #
> # A set of parameters describing drive mirror setup.
> #
> @@ -1373,7 +1373,7 @@
> 'data': 'BlockIOThrottle' }
>
> ##
> -# BlockIOThrottle
> +# @BlockIOThrottle
> #
> # A set of parameters describing block throttling.
> #
> diff --git a/qapi/crypto.json b/qapi/crypto.json
> index 6933b13..4ac3034 100644
> --- a/qapi/crypto.json
> +++ b/qapi/crypto.json
> @@ -3,7 +3,7 @@
> # QAPI crypto definitions
>
> ##
> -# QCryptoTLSCredsEndpoint:
> +# @QCryptoTLSCredsEndpoint:
> #
> # The type of network endpoint that will be using the credentials.
> # Most types of credential require different setup / structures
> @@ -22,7 +22,7 @@
>
>
> ##
> -# QCryptoSecretFormat:
> +# @QCryptoSecretFormat:
> #
> # The data format that the secret is provided in
> #
> @@ -36,7 +36,7 @@
>
>
> ##
> -# QCryptoHashAlgorithm:
> +# @QCryptoHashAlgorithm:
> #
> # The supported algorithms for computing content digests
> #
> @@ -55,7 +55,7 @@
>
>
> ##
> -# QCryptoCipherAlgorithm:
> +# @QCryptoCipherAlgorithm:
> #
> # The supported algorithms for content encryption ciphers
> #
> @@ -82,7 +82,7 @@
>
>
> ##
> -# QCryptoCipherMode:
> +# @QCryptoCipherMode:
> #
> # The supported modes for content encryption ciphers
> #
> @@ -97,7 +97,7 @@
>
>
> ##
> -# QCryptoIVGenAlgorithm:
> +# @QCryptoIVGenAlgorithm:
> #
> # The supported algorithms for generating initialization
> # vectors for full disk encryption. The 'plain' generator
> @@ -115,7 +115,7 @@
> 'data': ['plain', 'plain64', 'essiv']}
>
> ##
> -# QCryptoBlockFormat:
> +# @QCryptoBlockFormat:
> #
> # The supported full disk encryption formats
> #
> @@ -130,7 +130,7 @@
> 'data': ['qcow', 'luks']}
>
> ##
> -# QCryptoBlockOptionsBase:
> +# @QCryptoBlockOptionsBase:
> #
> # The common options that apply to all full disk
> # encryption formats
> @@ -143,7 +143,7 @@
> 'data': { 'format': 'QCryptoBlockFormat' }}
>
> ##
> -# QCryptoBlockOptionsQCow:
> +# @QCryptoBlockOptionsQCow:
> #
> # The options that apply to QCow/QCow2 AES-CBC encryption format
> #
> @@ -157,7 +157,7 @@
> 'data': { '*key-secret': 'str' }}
>
> ##
> -# QCryptoBlockOptionsLUKS:
> +# @QCryptoBlockOptionsLUKS:
> #
> # The options that apply to LUKS encryption format
> #
> @@ -171,7 +171,7 @@
>
>
> ##
> -# QCryptoBlockCreateOptionsLUKS:
> +# @QCryptoBlockCreateOptionsLUKS:
> #
> # The options that apply to LUKS encryption format initialization
> #
> @@ -201,7 +201,7 @@
>
>
> ##
> -# QCryptoBlockOpenOptions:
> +# @QCryptoBlockOpenOptions:
> #
> # The options that are available for all encryption formats
> # when opening an existing volume
> @@ -216,7 +216,7 @@
>
>
> ##
> -# QCryptoBlockCreateOptions:
> +# @QCryptoBlockCreateOptions:
> #
> # The options that are available for all encryption formats
> # when initializing a new volume
> @@ -231,7 +231,7 @@
>
>
> ##
> -# QCryptoBlockInfoBase:
> +# @QCryptoBlockInfoBase:
> #
> # The common information that applies to all full disk
> # encryption formats
> @@ -245,7 +245,7 @@
>
>
> ##
> -# QCryptoBlockInfoLUKSSlot:
> +# @QCryptoBlockInfoLUKSSlot:
> #
> # Information about the LUKS block encryption key
> # slot options
> @@ -265,7 +265,7 @@
>
>
> ##
> -# QCryptoBlockInfoLUKS:
> +# @QCryptoBlockInfoLUKS:
> #
> # Information about the LUKS block encryption options
> #
> @@ -293,7 +293,7 @@
> 'slots': [ 'QCryptoBlockInfoLUKSSlot' ] }}
>
> ##
> -# QCryptoBlockInfoQCow:
> +# @QCryptoBlockInfoQCow:
> #
> # Information about the QCow block encryption options
> #
> @@ -304,7 +304,7 @@
>
>
> ##
> -# QCryptoBlockInfo:
> +# @QCryptoBlockInfo:
> #
> # Information about the block encryption options
> #
Additionally, there are a few lines that don't match the symbol the
symbol being defined:
diff --git a/qapi-schema.json b/qapi-schema.json
index 0cc9ee6..104cc62 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -1079,7 +1079,7 @@
'*service': 'str', '*auth': 'str', '*clients':
['VncClientInfo']} }
##
-# @VncPriAuth:
+# @VncPrimaryAuth:
#
# vnc primary authentication method.
#
@@ -3889,7 +3889,7 @@
'data': { 'passthrough' : 'TPMPassthroughOptions' } }
##
-# @TpmInfo:
+# @TPMInfo:
#
# Information about the TPM
#
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 09c9728..07a449b 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -378,7 +378,7 @@
'data': { 'handle': 'int' } }
##
-# @GuestFsFreezeStatus
+# @GuestFsfreezeStatus
#
# An enumeration of filesystem freeze states
#
The parser should flag such nonsense.
