qapi: fix various symbols mismatch in documentation

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.lureau@redhat.com>
Message-Id: <20161117155504.21843-7-marcandre.lureau@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
Marc-André Lureau 2016-11-17 19:54:53 +04:00 committed by Markus Armbruster
parent c5927e7abf
commit 4d5c8bc42f
5 changed files with 16 additions and 22 deletions

View File

@ -695,8 +695,6 @@
# #
# Set various migration parameters. See MigrationParameters for details. # Set various migration parameters. See MigrationParameters for details.
# #
# @x-checkpoint-delay: the delay time between two checkpoints. (Since 2.8)
#
# Since: 2.4 # Since: 2.4
## ##
{ 'command': 'migrate-set-parameters', 'boxed': true, { 'command': 'migrate-set-parameters', 'boxed': true,
@ -1173,7 +1171,7 @@
'*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} } '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
## ##
# @VncPriAuth: # @VncPrimaryAuth:
# #
# vnc primary authentication method. # vnc primary authentication method.
# #
@ -3176,7 +3174,7 @@
# #
# @alias: #optional an alias for the machine name # @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 # @cpu-max: maximum number of CPUs supported by the machine type
# (since 1.5.0) # (since 1.5.0)
@ -3729,7 +3727,6 @@
# #
# @device: The name of the special file for the device, # @device: The name of the special file for the device,
# i.e. /dev/ttyS0 on Unix or COM1: on Windows # i.e. /dev/ttyS0 on Unix or COM1: on Windows
# @type: What kind of device this is.
# #
# Since: 1.4 # Since: 1.4
## ##
@ -3994,7 +3991,7 @@
# #
# A union referencing different TPM backend types' configuration options # 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 # Since: 1.5
## ##
@ -4002,7 +3999,7 @@
'data': { 'passthrough' : 'TPMPassthroughOptions' } } 'data': { 'passthrough' : 'TPMPassthroughOptions' } }
## ##
# @TpmInfo: # @TPMInfo:
# #
# Information about the TPM # Information about the TPM
# #
@ -4346,10 +4343,11 @@
# #
# Input event union. # Input event union.
# #
# @key: Input event of Keyboard # @type: the input type, one of:
# @btn: Input event of pointer buttons # - 'key': Input event of Keyboard
# @rel: Input event of relative pointer motion # - 'btn': Input event of pointer buttons
# @abs: Input event of absolute pointer motion # - 'rel': Input event of relative pointer motion
# - 'abs': Input event of absolute pointer motion
# #
# Since: 2.0 # Since: 2.0
## ##

View File

@ -2160,10 +2160,6 @@
# #
# @type: Transport type used for gluster connection # @type: Transport type used for gluster connection
# #
# @unix: socket file
#
# @tcp: host address and port number
#
# This is similar to SocketAddress, only distinction: # This is similar to SocketAddress, only distinction:
# #
# 1. GlusterServer is a flat union, SocketAddress is a simple union. # 1. GlusterServer is a flat union, SocketAddress is a simple union.

View File

@ -34,11 +34,11 @@
# #
# A three-part version number. # 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 # Since: 2.4
## ##

View File

@ -1,5 +1,5 @@
## ##
# @Rocker: # @RockerSwitch:
# #
# Rocker switch information. # Rocker switch information.
# #

View File

@ -203,7 +203,7 @@
# #
# Open a file in the guest and retrieve a file handle for it # 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. # @mode: #optional open mode, as per fopen(), "r" is the default.
# #
@ -378,7 +378,7 @@
'data': { 'handle': 'int' } } 'data': { 'handle': 'int' } }
## ##
# @GuestFsFreezeStatus # @GuestFsfreezeStatus
# #
# An enumeration of filesystem freeze states # An enumeration of filesystem freeze states
# #
@ -770,7 +770,7 @@
# @GuestDiskAddress: # @GuestDiskAddress:
# #
# @pci-controller: controller's PCI address # @pci-controller: controller's PCI address
# @type: bus type # @bus-type: bus type
# @bus: bus id # @bus: bus id
# @target: target id # @target: target id
# @unit: unit id # @unit: unit id