SYS-OSS/FRET-qemu
4
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

QAPI patches patches for 2024-01-26

Browse Source 
-----BEGIN PGP SIGNATURE-----
 
 iQJGBAABCAAwFiEENUvIs9frKmtoZ05fOHC0AOuRhlMFAmWzT/QSHGFybWJydUBy
 ZWRoYXQuY29tAAoJEDhwtADrkYZTznQQALpsbanZR+gfTDOI/kvFuoLtOdhibtxW
 /5IwAP68Hdj2unHyHRBaNQIwyAfnHlyks1ywNyv0JCAqoyLuoa/ertir3zKc/1xP
 hOer7C76jrWiL2Gg4EMxl1oWussyHLq7XtQQEmL4aLV+EnnoytUfnosUpO0Ee5Pg
 Fz1EwJi74LEfYtrZjfX/YXZrX+3PJpYywtSWlyDluER0xfjh5d3JAsrjpgcPHZKc
 fwD2W7myxnW8IRyHdIgbu6Spv0vcM39PMrIK0ZlnVKgUz+/YcMgeK0eSXd6y+FjX
 Wehd7Ik5YE8el+SvGDPEMSTCkA2CP7dEnKt9Fk1pn+N8YhPGnQxDSBQOIae5Tnbf
 rrlOrCWXqW2a5FtbG/E4SwtXZlOo1BjkSy6+xP86YwXr23DSafVaeJp4CUls+ABZ
 LX6vR0p6bxPxOwVhoYeqxv+TpdA206g0yhN7bknoIp42DG4oj81toD5Ki3fedfwC
 pPl2sxniBm4MaO57YXxFgSN0lrur5vCcPadRppGbrGEO8XaX7F+9c5OWsPh+jt1x
 /l+A7RakrTg39NR2X46D1clPj3NQHwMVNIoSJek4+nCnM7eKVhMSm9YjpQEPupt0
 Aa+5QdiKcgjYEoSljE6ZsYJIrxd0OoaSpP1BWl4P+NcjgyUGcUkQ2X3AEL8Xkm6H
 wLv5U6ob99eL
 =nXml
 -----END PGP SIGNATURE-----

Merge tag 'pull-qapi-2024-01-26' of https://repo.or.cz/qemu/armbru into staging

QAPI patches patches for 2024-01-26

# -----BEGIN PGP SIGNATURE-----
#
# iQJGBAABCAAwFiEENUvIs9frKmtoZ05fOHC0AOuRhlMFAmWzT/QSHGFybWJydUBy
# ZWRoYXQuY29tAAoJEDhwtADrkYZTznQQALpsbanZR+gfTDOI/kvFuoLtOdhibtxW
# /5IwAP68Hdj2unHyHRBaNQIwyAfnHlyks1ywNyv0JCAqoyLuoa/ertir3zKc/1xP
# hOer7C76jrWiL2Gg4EMxl1oWussyHLq7XtQQEmL4aLV+EnnoytUfnosUpO0Ee5Pg
# Fz1EwJi74LEfYtrZjfX/YXZrX+3PJpYywtSWlyDluER0xfjh5d3JAsrjpgcPHZKc
# fwD2W7myxnW8IRyHdIgbu6Spv0vcM39PMrIK0ZlnVKgUz+/YcMgeK0eSXd6y+FjX
# Wehd7Ik5YE8el+SvGDPEMSTCkA2CP7dEnKt9Fk1pn+N8YhPGnQxDSBQOIae5Tnbf
# rrlOrCWXqW2a5FtbG/E4SwtXZlOo1BjkSy6+xP86YwXr23DSafVaeJp4CUls+ABZ
# LX6vR0p6bxPxOwVhoYeqxv+TpdA206g0yhN7bknoIp42DG4oj81toD5Ki3fedfwC
# pPl2sxniBm4MaO57YXxFgSN0lrur5vCcPadRppGbrGEO8XaX7F+9c5OWsPh+jt1x
# /l+A7RakrTg39NR2X46D1clPj3NQHwMVNIoSJek4+nCnM7eKVhMSm9YjpQEPupt0
# Aa+5QdiKcgjYEoSljE6ZsYJIrxd0OoaSpP1BWl4P+NcjgyUGcUkQ2X3AEL8Xkm6H
# wLv5U6ob99eL
# =nXml
# -----END PGP SIGNATURE-----
# gpg: Signature made Fri 26 Jan 2024 06:23:48 GMT
# gpg:                using RSA key 354BC8B3D7EB2A6B68674E5F3870B400EB918653
# gpg:                issuer "armbru@redhat.com"
# gpg: Good signature from "Markus Armbruster <armbru@redhat.com>" [full]
# gpg:                 aka "Markus Armbruster <armbru@pond.sub.org>" [full]
# Primary key fingerprint: 354B C8B3 D7EB 2A6B 6867  4E5F 3870 B400 EB91 8653

* tag 'pull-qapi-2024-01-26' of https://repo.or.cz/qemu/armbru:
  qapi: Fix malformed "Since:" section tags (again)
  qapi: Indent tagged doc comment sections properly
  qapi: Fix mangled "Returns" sections in documentation
  docs/interop/bitmaps: Clean up a reference to qemu-qmp-ref
  qapi: Fix dangling references to docs/devel/qapi-code-gen.txt
  docs: Replace dangling references to docs/interop/qmp-intro.txt
  docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs
  docs/devel/qapi-code-gen: Don't reserve types ending with 'Kind'

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
This commit is contained in:
Peter Maydell 2024-01-26 10:21:27 +00:00
commit e029fe22ca
19 changed files with 64 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/devel/qapi-code-gen.rst
View File

@ -737,9 +737,8 @@ Types, commands, and events share a common namespace. Therefore,
generally speaking, type definitions should always use CamelCase for generally speaking, type definitions should always use CamelCase for
user-defined type names, while built-in types are lowercase. user-defined type names, while built-in types are lowercase.
Type names ending with ``Kind`` or ``List`` are reserved for the Type names ending with ``List`` are reserved for the generator, which
generator, which uses them for implicit union enums and array types, uses them for array types.
respectively.
Command names, member names within a type, and feature names should be Command names, member names within a type, and feature names should be
all lower case with words separated by a hyphen. However, some all lower case with words separated by a hyphen. However, some
@ -990,8 +989,8 @@ this::
# @feature: Description text # @feature: Description text
A tagged section starts with one of the following words: A tagged section starts with one of the following words:
"Note:"/"Notes:", "Since:", "Example"/"Examples", "Returns:", "TODO:". "Note:"/"Notes:", "Since:", "Example:"/"Examples:", "Returns:",
The section ends with the start of a new section. "TODO:". The section ends with the start of a new section.
The second and subsequent lines of sections other than The second and subsequent lines of sections other than
"Example"/"Examples" should be indented like this:: "Example"/"Examples" should be indented like this::

4
docs/devel/writing-monitor-commands.rst
View File

@ -8,8 +8,8 @@ This document doesn't discuss QMP protocol level details, nor does it dive
into the QAPI framework implementation. into the QAPI framework implementation.
For an in-depth introduction to the QAPI framework, please refer to For an in-depth introduction to the QAPI framework, please refer to
docs/devel/qapi-code-gen.txt. For documentation about the QMP protocol, :doc:`qapi-code-gen`. For the QMP protocol, see the
start with docs/interop/qmp-intro.txt. :doc:`/interop/qmp-spec`.
New commands may be implemented in QMP only. New HMP commands should be New commands may be implemented in QMP only. New HMP commands should be
implemented on top of QMP. The typical HMP command wraps around an implemented on top of QMP. The typical HMP command wraps around an

6
docs/interop/bitmaps.rst
View File

@ -166,9 +166,9 @@ Basic QMP Usage
--------------- ---------------
The primary interface to manipulating bitmap objects is via the QMP The primary interface to manipulating bitmap objects is via the QMP
interface. If you are not familiar, see docs/interop/qmp-intro.txt for a broad interface. If you are not familiar, see the :doc:`qmp-spec` for the
overview, and `qemu-qmp-ref <qemu-qmp-ref.html>`_ for a full reference of all protocol, and :doc:`qemu-qmp-ref` for a full reference of all QMP
QMP commands. commands.
Supported Commands Supported Commands
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~

2
include/qapi/visitor.h
View File

@ -39,7 +39,7 @@
* limitations; see the documentation for each visitor for more * limitations; see the documentation for each visitor for more
* details on what it supports. Also, see visitor-impl.h for the * details on what it supports. Also, see visitor-impl.h for the
* callback contracts implemented by each visitor, and * callback contracts implemented by each visitor, and
* docs/devel/qapi-code-gen.txt for more about the QAPI code * docs/devel/qapi-code-gen.rst for more about the QAPI code
* generator. * generator.
* *
* All of the visitors are created via: * All of the visitors are created via:

2
include/qemu/yank.h
View File

@ -45,7 +45,7 @@ void yank_unregister_instance(const YankInstance *instance);
* yank_register_function: Register a yank function * yank_register_function: Register a yank function
* *
* This registers a yank function. All limitations of qmp oob commands apply * This registers a yank function. All limitations of qmp oob commands apply
* to the yank function as well. See docs/devel/qapi-code-gen.txt under * to the yank function as well. See docs/devel/qapi-code-gen.rst under
* "An OOB-capable command handler must satisfy the following conditions". * "An OOB-capable command handler must satisfy the following conditions".
* *
* This function is thread-safe. * This function is thread-safe.

4
qapi/block-core.json
View File

@ -1361,7 +1361,7 @@
# target, i.e. same data and new writes are done synchronously to # target, i.e. same data and new writes are done synchronously to
# both. # both.
# #
# Since 8.2 # Since: 8.2
## ##
{ 'struct': 'BlockJobInfoMirror', { 'struct': 'BlockJobInfoMirror',
'data': { 'actively-synced': 'bool' } } 'data': { 'actively-synced': 'bool' } }
@ -3080,7 +3080,7 @@
# #
# @type: The job type # @type: The job type
# #
# Since 8.2 # Since: 8.2
## ##
{ 'union': 'BlockJobChangeOptions', { 'union': 'BlockJobChangeOptions',
'base': { 'id': 'str', 'type': 'JobType' }, 'base': { 'id': 'str', 'type': 'JobType' },

4
qapi/char.json
View File

@ -391,8 +391,8 @@
# @rows: console height, in chars # @rows: console height, in chars
# #
# Note: the options are only effective when the VNC or SDL graphical # Note: the options are only effective when the VNC or SDL graphical
# display backend is active. They are ignored with the GTK, Spice, VNC # display backend is active. They are ignored with the GTK,
# and D-Bus display backends. # Spice, VNC and D-Bus display backends.
# #
# Since: 1.5 # Since: 1.5
## ##

2
qapi/introspect.json
View File

@ -261,7 +261,7 @@
# #
# @members: the alternate type's members, in no particular order. The # @members: the alternate type's members, in no particular order. The
# members' wire encoding is distinct, see # members' wire encoding is distinct, see
# docs/devel/qapi-code-gen.txt section Alternate types. # :doc:`/devel/qapi-code-gen` section Alternate types.
# #
# On the wire, this can be any of the members. # On the wire, this can be any of the members.
# #

24
qapi/machine.json
View File

@ -1059,10 +1059,10 @@
# From it we have: balloon_size = vm_ram_size - @value # From it we have: balloon_size = vm_ram_size - @value
# #
# Returns: # Returns:
# - Nothing on success # - Nothing on success
# - If the balloon driver is enabled but not functional because the # - If the balloon driver is enabled but not functional because
# KVM kernel module cannot support it, KVMMissingCap # the KVM kernel module cannot support it, KVMMissingCap
# - If no balloon device is present, DeviceNotActive # - If no balloon device is present, DeviceNotActive
# #
# Notes: This command just issues a request to the guest. When it # Notes: This command just issues a request to the guest. When it
# returns, the balloon size may not have changed. A guest can # returns, the balloon size may not have changed. A guest can
@ -1097,10 +1097,10 @@
# Return information about the balloon device. # Return information about the balloon device.
# #
# Returns: # Returns:
# - @BalloonInfo on success # - @BalloonInfo on success
# - If the balloon driver is enabled but not functional because the # - If the balloon driver is enabled but not functional because
# KVM kernel module cannot support it, KVMMissingCap # the KVM kernel module cannot support it, KVMMissingCap
# - If no balloon device is present, DeviceNotActive # - If no balloon device is present, DeviceNotActive
# #
# Since: 0.14 # Since: 0.14
# #
@ -1161,10 +1161,10 @@
# message from the guest. # message from the guest.
# #
# Returns: # Returns:
# - @HvBalloonInfo on success # - @HvBalloonInfo on success
# - If no hv-balloon device is present, guest memory status reporting # - If no hv-balloon device is present, guest memory status
# is not enabled or no guest memory status report received yet, # reporting is not enabled or no guest memory status report
# GenericError # received yet, GenericError
# #
# Since: 8.2 # Since: 8.2
# #

14
qapi/migration.json
View File

@ -1597,7 +1597,7 @@
# #
# @file: Direct the migration stream to a file. # @file: Direct the migration stream to a file.
# #
# Since 8.2 # Since: 8.2
## ##
{ 'enum': 'MigrationAddressType', { 'enum': 'MigrationAddressType',
'data': [ 'socket', 'exec', 'rdma', 'file' ] } 'data': [ 'socket', 'exec', 'rdma', 'file' ] }
@ -1609,7 +1609,7 @@
# #
# @offset: The file offset where the migration stream will start # @offset: The file offset where the migration stream will start
# #
# Since 8.2 # Since: 8.2
## ##
{ 'struct': 'FileMigrationArgs', { 'struct': 'FileMigrationArgs',
'data': { 'filename': 'str', 'data': { 'filename': 'str',
@ -1620,7 +1620,7 @@
# #
# @args: command (list head) and arguments to execute. # @args: command (list head) and arguments to execute.
# #
# Since 8.2 # Since: 8.2
## ##
{ 'struct': 'MigrationExecCommand', { 'struct': 'MigrationExecCommand',
'data': {'args': [ 'str' ] } } 'data': {'args': [ 'str' ] } }
@ -1630,7 +1630,7 @@
# #
# Migration endpoint configuration. # Migration endpoint configuration.
# #
# Since 8.2 # Since: 8.2
## ##
{ 'union': 'MigrationAddress', { 'union': 'MigrationAddress',
'base': { 'transport' : 'MigrationAddressType'}, 'base': { 'transport' : 'MigrationAddressType'},
@ -1648,7 +1648,7 @@
# #
# @main: Main outbound migration channel. # @main: Main outbound migration channel.
# #
# Since 8.1 # Since: 8.1
## ##
{ 'enum': 'MigrationChannelType', { 'enum': 'MigrationChannelType',
'data': [ 'main' ] } 'data': [ 'main' ] }
@ -1662,7 +1662,7 @@
# #
# @addr: Migration endpoint configuration on destination interface. # @addr: Migration endpoint configuration on destination interface.
# #
# Since 8.1 # Since: 8.1
## ##
{ 'struct': 'MigrationChannel', { 'struct': 'MigrationChannel',
'data': { 'data': {
@ -2126,7 +2126,7 @@
# #
# @millisecond: value is in milliseconds # @millisecond: value is in milliseconds
# #
# Since 8.2 # Since: 8.2
# #
## ##
{ 'enum': 'TimeUnit', { 'enum': 'TimeUnit',

2
qapi/misc-target.json
View File

@ -475,7 +475,7 @@
# @port: The port number # @port: The port number
# #
# Returns: # Returns:
# - Nothing on success. # - Nothing on success.
# #
# Since: 8.0 # Since: 8.0
# #

10
qapi/misc.json
View File

@ -344,9 +344,9 @@
# @opaque: A free-form string that can be used to describe the fd. # @opaque: A free-form string that can be used to describe the fd.
# #
# Returns: # Returns:
# - @AddfdInfo on success # - @AddfdInfo on success
# - If file descriptor was not received, GenericError # - If file descriptor was not received, GenericError
# - If @fdset-id is a negative value, GenericError # - If @fdset-id is a negative value, GenericError
# #
# Notes: The list of fd sets is shared by all monitor connections. # Notes: The list of fd sets is shared by all monitor connections.
# #
@ -374,8 +374,8 @@
# @fd: The file descriptor that is to be removed. # @fd: The file descriptor that is to be removed.
# #
# Returns: # Returns:
# - Nothing on success # - Nothing on success
# - If @fdset-id or @fd is not found, GenericError # - If @fdset-id or @fd is not found, GenericError
# #
# Since: 1.2 # Since: 1.2
# #

15
qapi/net.json
View File

@ -18,8 +18,9 @@
# #
# @up: true to set the link status to be up # @up: true to set the link status to be up
# #
# Returns: Nothing on success If @name is not a valid network device, # Returns:
# DeviceNotFound # - Nothing on success
# - If @name is not a valid network device, DeviceNotFound
# #
# Since: 0.14 # Since: 0.14
# #
@ -44,8 +45,9 @@
# #
# Since: 0.14 # Since: 0.14
# #
# Returns: Nothing on success If @type is not a valid network backend, # Returns:
# DeviceNotFound # - Nothing on success
# - If @type is not a valid network backend, DeviceNotFound
# #
# Example: # Example:
# #
@ -64,8 +66,9 @@
# #
# @id: the name of the network backend to remove # @id: the name of the network backend to remove
# #
# Returns: Nothing on success If @id is not a valid network backend, # Returns:
# DeviceNotFound # - Nothing on success
# - If @id is not a valid network backend, DeviceNotFound
# #
# Since: 0.14 # Since: 0.14
# #

2
qapi/qapi-util.c
View File

@ -112,7 +112,7 @@ bool qapi_bool_parse(const char *name, const char *value, bool *obj, Error **err
* It may be prefixed by __RFQDN_ (downstream extension), where RFQDN * It may be prefixed by __RFQDN_ (downstream extension), where RFQDN
* may contain only letters, digits, hyphen and period. * may contain only letters, digits, hyphen and period.
* The special exception for enumeration names is not implemented. * The special exception for enumeration names is not implemented.
* See docs/devel/qapi-code-gen.txt for more on QAPI naming rules. * See docs/devel/qapi-code-gen.rst for more on QAPI naming rules.
* Keep this consistent with scripts/qapi-gen.py! * Keep this consistent with scripts/qapi-gen.py!
* If @complete, the parse fails unless it consumes @str completely. * If @complete, the parse fails unless it consumes @str completely.
* Return its length on success, -1 on failure. * Return its length on success, -1 on failure.

5
qapi/qdev.json
View File

@ -89,8 +89,9 @@
# #
# @id: the device's ID or QOM path # @id: the device's ID or QOM path
# #
# Returns: Nothing on success If @id is not a valid device, # Returns:
# DeviceNotFound # - Nothing on success
# - If @id is not a valid device, DeviceNotFound
# #
# Notes: When this command completes, the device may not be removed # Notes: When this command completes, the device may not be removed
# from the guest. Hot removal is an operation that requires guest # from the guest. Hot removal is an operation that requires guest

10
qapi/qom.json
View File

@ -1056,8 +1056,9 @@
# #
# Create a QOM object. # Create a QOM object.
# #
# Returns: Nothing on success Error if @qom-type is not a valid class # Returns:
# name # - Nothing on success
# - Error if @qom-type is not a valid class name
# #
# Since: 2.0 # Since: 2.0
# #
@ -1078,8 +1079,9 @@
# #
# @id: the name of the QOM object to remove # @id: the name of the QOM object to remove
# #
# Returns: Nothing on success Error if @id is not a valid id for a QOM # Returns:
# object # - Nothing on success
# - Error if @id is not a valid id for a QOM object
# #
# Since: 2.0 # Since: 2.0
# #

4
qapi/yank.json
View File

@ -77,8 +77,8 @@
# Takes a list of @YankInstance as argument. # Takes a list of @YankInstance as argument.
# #
# Returns: # Returns:
# - Nothing on success # - Nothing on success
# - @DeviceNotFound error, if any of the YankInstances doesn't exist # - @DeviceNotFound error, if any of the YankInstances doesn't exist
# #
# Example: # Example:
# #

2
scripts/qapi/parser.py
View File

@ -71,7 +71,7 @@ class QAPISchemaParser:
Parse QAPI schema source. Parse QAPI schema source.
Parse a JSON-esque schema file and process directives. See Parse a JSON-esque schema file and process directives. See
qapi-code-gen.txt section "Schema Syntax" for the exact syntax. qapi-code-gen.rst section "Schema Syntax" for the exact syntax.
Grammatical validation is handled later by `expr.check_exprs()`. Grammatical validation is handled later by `expr.check_exprs()`.
:param fname: Source file name. :param fname: Source file name.

2
util/yank.c
View File

@ -35,7 +35,7 @@ typedef struct YankInstanceEntry YankInstanceEntry;
/* /*
* This lock protects the yank_instance_list below. Because it's taken by * This lock protects the yank_instance_list below. Because it's taken by
* OOB-capable commands, it must be "fast", i.e. it may only be held for a * OOB-capable commands, it must be "fast", i.e. it may only be held for a
* bounded, short time. See docs/devel/qapi-code-gen.txt for additional * bounded, short time. See docs/devel/qapi-code-gen.rst for additional
* information. * information.
*/ */
static QemuMutex yank_lock; static QemuMutex yank_lock;