Marc-André Lureau <marcandre.lur...@redhat.com> writes:
> There are various mismatch:
> - invalid symbols
> - section and member symbols mismatch
> - enum or union values vs 'type'
>
> The documentation parser catches all these cases.
>
> Signed-off-by: Marc-André Lureau <marcandre.lur...@redhat.com>
> ---
> qapi-schema.json | 20 +++++++++-----------
> qapi/block-core.json | 4 ----
> qapi/common.json | 6 +++---
> qapi/rocker.json | 2 +-
> qga/qapi-schema.json | 6 +++---
> 5 files changed, 16 insertions(+), 22 deletions(-)
>
> diff --git a/qapi-schema.json b/qapi-schema.json
> index 5f377fa..0c9a293 100644
> --- a/qapi-schema.json
> +++ b/qapi-schema.json
> @@ -693,8 +693,6 @@
> #
> # Set various migration parameters. See MigrationParameters for details.
> #
> -# @x-checkpoint-delay: the delay time between two checkpoints. (Since 2.8)
> -#
> # Since: 2.4
> ##
> { 'command': 'migrate-set-parameters', 'boxed': true,
> @@ -1171,7 +1169,7 @@
> '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']}
> }
>
> ##
> -# @VncPriAuth:
> +# @VncPrimaryAuth:
> #
> # vnc primary authentication method.
> #
> @@ -3174,7 +3172,7 @@
> #
> # @alias: #optional an alias for the machine name
> #
> -# @default: #optional whether the machine is default
> +# @is-default: #optional whether the machine is default
> #
> # @cpu-max: maximum number of CPUs supported by the machine type
> # (since 1.5.0)
> @@ -3727,7 +3725,6 @@
> #
> # @device: The name of the special file for the device,
> # i.e. /dev/ttyS0 on Unix or COM1: on Windows
> -# @type: What kind of device this is.
> #
> # Since: 1.4
> ##
> @@ -3992,7 +3989,7 @@
> #
> # A union referencing different TPM backend types' configuration options
> #
> -# @passthrough: The configuration options for the TPM passthrough type
> +# @type: 'passthrough' The configuration options for the TPM passthrough type
> #
> # Since: 1.5
> ##
> @@ -4000,7 +3997,7 @@
> 'data': { 'passthrough' : 'TPMPassthroughOptions' } }
>
> ##
> -# @TpmInfo:
> +# @TPMInfo:
> #
> # Information about the TPM
> #
> @@ -4344,10 +4341,11 @@
> #
> # Input event union.
> #
> -# @key: Input event of Keyboard
> -# @btn: Input event of pointer buttons
> -# @rel: Input event of relative pointer motion
> -# @abs: Input event of absolute pointer motion
> +# @type: the input type, one of:
> +# - 'key': Input event of Keyboard
> +# - 'btn': Input event of pointer buttons
> +# - 'rel': Input event of relative pointer motion
> +# - 'abs': Input event of absolute pointer motion
> #
> # Since: 2.0
> ##
This will do for now, but we need to figure out how to document unions
properly.
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 372889c..c64a48c 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -2160,10 +2160,6 @@
> #
> # @type: Transport type used for gluster connection
> #
> -# @unix: socket file
> -#
> -# @tcp: host address and port number
> -#
> # This is similar to SocketAddress, only distinction:
> #
> # 1. GlusterServer is a flat union, SocketAddress is a simple union.
Unions again. We lose a bit of information here, but it's almost
worthless information.
> diff --git a/qapi/common.json b/qapi/common.json
> index 9353a7b..6987100 100644
> --- a/qapi/common.json
> +++ b/qapi/common.json
> @@ -34,11 +34,11 @@
> #
> # A three-part version number.
> #
> -# @qemu.major: The major version number.
> +# @major: The major version number.
> #
> -# @qemu.minor: The minor version number.
> +# @minor: The minor version number.
> #
> -# @qemu.micro: The micro version number.
> +# @micro: The micro version number.
> #
> # Since: 2.4
> ##
> diff --git a/qapi/rocker.json b/qapi/rocker.json
> index 2fe7fdf..ace2776 100644
> --- a/qapi/rocker.json
> +++ b/qapi/rocker.json
> @@ -1,5 +1,5 @@
> ##
> -# @Rocker:
> +# @RockerSwitch:
> #
> # Rocker switch information.
> #
> diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
> index 5173c4a..2e6cc91 100644
> --- a/qga/qapi-schema.json
> +++ b/qga/qapi-schema.json
> @@ -203,7 +203,7 @@
> #
> # Open a file in the guest and retrieve a file handle for it
> #
> -# @filepath: Full path to the file in the guest to open.
> +# @path: Full path to the file in the guest to open.
> #
> # @mode: #optional open mode, as per fopen(), "r" is the default.
> #
> @@ -378,7 +378,7 @@
> 'data': { 'handle': 'int' } }
>
> ##
> -# @GuestFsFreezeStatus
> +# @GuestFsfreezeStatus
> #
> # An enumeration of filesystem freeze states
> #
> @@ -766,7 +766,7 @@
> # @GuestDiskAddress:
> #
> # @pci-controller: controller's PCI address
> -# @type: bus type
> +# @bus-type: bus type
> # @bus: bus id
> # @target: target id
> # @unit: unit id
Lovely doc fixes :)
