From 4d5c8bc42f0c935f002639d8f340e8b9fa980ec4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Thu, 17 Nov 2016 19:54:53 +0400 Subject: [PATCH] qapi: fix various symbols mismatch in documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Message-Id: <20161117155504.21843-7-marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster Signed-off-by: Markus Armbruster --- 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 824d205a98..9c0b46aa36 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -695,8 +695,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, @@ -1173,7 +1171,7 @@ '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} } ## -# @VncPriAuth: +# @VncPrimaryAuth: # # vnc primary authentication method. # @@ -3176,7 +3174,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) @@ -3729,7 +3727,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 ## @@ -3994,7 +3991,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 ## @@ -4002,7 +3999,7 @@ 'data': { 'passthrough' : 'TPMPassthroughOptions' } } ## -# @TpmInfo: +# @TPMInfo: # # Information about the TPM # @@ -4346,10 +4343,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 ## diff --git a/qapi/block-core.json b/qapi/block-core.json index d98fe73ff1..33bc93aca1 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. diff --git a/qapi/common.json b/qapi/common.json index 9353a7b377..6987100343 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 2fe7fdfa66..ace27760f1 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 7a352672fa..ad0a31d011 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 # @@ -770,7 +770,7 @@ # @GuestDiskAddress: # # @pci-controller: controller's PCI address -# @type: bus type +# @bus-type: bus type # @bus: bus id # @target: target id # @unit: unit id