mirror of
https://github.com/xemu-project/xemu.git
synced 2024-12-01 07:21:09 +00:00
5072f7b38b
The documentation parser we are going to add expects a section name to end with ':', otherwise the comment is treated as free-form text body. Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Message-Id: <20161117155504.21843-9-marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
134 lines
3.0 KiB
Python
134 lines
3.0 KiB
Python
# -*- Mode: Python -*-
|
|
#
|
|
# QAPI common definitions
|
|
|
|
##
|
|
# @QapiErrorClass:
|
|
#
|
|
# QEMU error classes
|
|
#
|
|
# @GenericError: this is used for errors that don't require a specific error
|
|
# class. This should be the default case for most errors
|
|
#
|
|
# @CommandNotFound: the requested command has not been found
|
|
#
|
|
# @DeviceEncrypted: the requested operation can't be fulfilled because the
|
|
# selected device is encrypted
|
|
#
|
|
# @DeviceNotActive: a device has failed to be become active
|
|
#
|
|
# @DeviceNotFound: the requested device has not been found
|
|
#
|
|
# @KVMMissingCap: the requested operation can't be fulfilled because a
|
|
# required KVM capability is missing
|
|
#
|
|
# Since: 1.2
|
|
##
|
|
{ 'enum': 'QapiErrorClass',
|
|
# Keep this in sync with ErrorClass in error.h
|
|
'data': [ 'GenericError', 'CommandNotFound', 'DeviceEncrypted',
|
|
'DeviceNotActive', 'DeviceNotFound', 'KVMMissingCap' ] }
|
|
|
|
##
|
|
# @VersionTriple:
|
|
#
|
|
# A three-part version number.
|
|
#
|
|
# @major: The major version number.
|
|
#
|
|
# @minor: The minor version number.
|
|
#
|
|
# @micro: The micro version number.
|
|
#
|
|
# Since: 2.4
|
|
##
|
|
{ 'struct': 'VersionTriple',
|
|
'data': {'major': 'int', 'minor': 'int', 'micro': 'int'} }
|
|
|
|
|
|
##
|
|
# @VersionInfo:
|
|
#
|
|
# A description of QEMU's version.
|
|
#
|
|
# @qemu: The version of QEMU. By current convention, a micro
|
|
# version of 50 signifies a development branch. A micro version
|
|
# greater than or equal to 90 signifies a release candidate for
|
|
# the next minor version. A micro version of less than 50
|
|
# signifies a stable release.
|
|
#
|
|
# @package: QEMU will always set this field to an empty string. Downstream
|
|
# versions of QEMU should set this to a non-empty string. The
|
|
# exact format depends on the downstream however it highly
|
|
# recommended that a unique name is used.
|
|
#
|
|
# Since: 0.14.0
|
|
##
|
|
{ 'struct': 'VersionInfo',
|
|
'data': {'qemu': 'VersionTriple', 'package': 'str'} }
|
|
|
|
##
|
|
# @query-version:
|
|
#
|
|
# Returns the current version of QEMU.
|
|
#
|
|
# Returns: A @VersionInfo object describing the current version of QEMU.
|
|
#
|
|
# Since: 0.14.0
|
|
##
|
|
{ 'command': 'query-version', 'returns': 'VersionInfo' }
|
|
|
|
##
|
|
# @CommandInfo:
|
|
#
|
|
# Information about a QMP command
|
|
#
|
|
# @name: The command name
|
|
#
|
|
# Since: 0.14.0
|
|
##
|
|
{ 'struct': 'CommandInfo', 'data': {'name': 'str'} }
|
|
|
|
##
|
|
# @query-commands:
|
|
#
|
|
# Return a list of supported QMP commands by this server
|
|
#
|
|
# Returns: A list of @CommandInfo for all supported commands
|
|
#
|
|
# Since: 0.14.0
|
|
##
|
|
{ 'command': 'query-commands', 'returns': ['CommandInfo'] }
|
|
|
|
##
|
|
# @OnOffAuto:
|
|
#
|
|
# An enumeration of three options: on, off, and auto
|
|
#
|
|
# @auto: QEMU selects the value between on and off
|
|
#
|
|
# @on: Enabled
|
|
#
|
|
# @off: Disabled
|
|
#
|
|
# Since: 2.2
|
|
##
|
|
{ 'enum': 'OnOffAuto',
|
|
'data': [ 'auto', 'on', 'off' ] }
|
|
|
|
##
|
|
# @OnOffSplit:
|
|
#
|
|
# An enumeration of three values: on, off, and split
|
|
#
|
|
# @on: Enabled
|
|
#
|
|
# @off: Disabled
|
|
#
|
|
# @split: Mixed
|
|
#
|
|
# Since: 2.6
|
|
##
|
|
{ 'enum': 'OnOffSplit',
|
|
'data': [ 'on', 'off', 'split' ] }
|