QAPI patches patches for 2021-11-10

-----BEGIN PGP SIGNATURE-----
 
 iQJGBAABCAAwFiEENUvIs9frKmtoZ05fOHC0AOuRhlMFAmGLVtMSHGFybWJydUBy
 ZWRoYXQuY29tAAoJEDhwtADrkYZTww4QAIEIs/gKYzSgPRzBPEFGRGcTQ/WI9TVz
 nmh+/g/8uANQX7yF1a+4K0Ig0e/ocndGsbSCJt50bxlFERMovAVe+Hr9U26KF2Tn
 UgTgqaKq4he7jBsh6Tkcseih3RE2vFymUnYlpsmQJ1ROah17jQplWujGJkU3/8GS
 lO5Z5O9tWvv95McjxJIx1KG8YtkmMiHOShn46k8ywOG/1o1aIgRdplB4FS3jen3f
 pPI2+/yF7UhzI+wtUBjb9uvyzEecsDMArGCRotsTtjw4LIAv6d6CmNsy4yamDMFk
 7+v+BITBD+UGLdQLfU4NKMKdQesLY0DCfYIlAsIQNffpqFWLSc2LS67fdHD0+OO/
 oGhnHNkaCo9KkyJaSJjmbiiicrrMLVR9xwk6TB5WHJohJHvbxJnTWNeYW5c8mvhN
 aT3h1lZ+kbZ7p1qM3tqLkQBF+VU+1SmWBfEhxOlZXHIN9izr5nKaycW9L2zLG3Zv
 n4ocyPOEuvzNpFa3Vs7nOyFjjHQNZS+C3rXrz8rM+bWX4sbvCDlwfu4lYl8cLin/
 QrKZtLqFrhiwoWE6othBYp/d1g7LXoXeO2Vk+rosWrbuT1MGBB7luxP3XGp78Bwh
 SzS4vUNpOdUN3clkT4I/J7tJkixA9wsJi7HZpkxhU6irstGMfUnEH4q8Fmboj7Yg
 O4MgmqT+5+iv
 =bkIX
 -----END PGP SIGNATURE-----

Merge tag 'pull-qapi-2021-11-10' of git://repo.or.cz/qemu/armbru into staging

QAPI patches patches for 2021-11-10

# gpg: Signature made Wed 10 Nov 2021 06:21:23 AM CET
# 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]

* tag 'pull-qapi-2021-11-10' of git://repo.or.cz/qemu/armbru:
  qapi: Belatedly mark unstable QMP parts with feature 'unstable'
  docs/devel/qapi-code-gen: Belatedly document feature documentation
  docs/devel/qapi-code-gen: Drop a duplicate paragraph

Signed-off-by: Richard Henderson <richard.henderson@linaro.org>
staging
Richard Henderson 2021-11-10 11:25:03 +01:00
commit b30187ef02
2 changed files with 60 additions and 23 deletions

View File

@ -956,15 +956,16 @@ definition must have documentation.
Definition documentation starts with a line naming the definition,
followed by an optional overview, a description of each argument (for
commands and events), member (for structs and unions), branch (for
alternates), or value (for enums), and finally optional tagged
sections.
alternates), or value (for enums), a description of each feature (if
any), and finally optional tagged sections.
Descriptions of arguments can span multiple lines. The description
text can start on the line following the '\@argname:', in which case it
must not be indented at all. It can also start on the same line as
the '\@argname:'. In this case if it spans multiple lines then second
and subsequent lines must be indented to line up with the first
character of the first line of the description::
The description of an argument or feature 'name' starts with
'\@name:'. The description text can start on the line following the
'\@name:', in which case it must not be indented at all. It can also
start on the same line as the '\@name:'. In this case if it spans
multiple lines then second and subsequent lines must be indented to
line up with the first character of the first line of the
description::
# @argone:
# This is a two line description
@ -986,6 +987,12 @@ The number of spaces between the ':' and the text is not significant.
Extensions added after the definition was first released carry a
'(since x.y.z)' comment.
The feature descriptions must be preceded by a line "Features:", like
this::
# Features:
# @feature: Description text
A tagged section starts with one of the following words:
"Note:"/"Notes:", "Since:", "Example"/"Examples", "Returns:", "TODO:".
The section ends with the start of a new section.
@ -1000,12 +1007,6 @@ multiline argument descriptions.
A 'Since: x.y.z' tagged section lists the release that introduced the
definition.
The text of a section can start on a new line, in
which case it must not be indented at all. It can also start
on the same line as the 'Note:', 'Returns:', etc tag. In this
case if it spans multiple lines then second and subsequent
lines must be indented to match the first.
An 'Example' or 'Examples' section is automatically rendered
entirely as literal fixed-width text. In other sections,
the text is formatted, and rST markup can be used.

View File

@ -1417,107 +1417,143 @@
#
# Query interrupt statistics
#
# Features:
# @unstable: This command is meant for debugging.
#
# Returns: interrupt statistics
#
# Since: 6.2
##
{ 'command': 'x-query-irq',
'returns': 'HumanReadableText' }
'returns': 'HumanReadableText',
'features': [ 'unstable' ] }
##
# @x-query-jit:
#
# Query TCG compiler statistics
#
# Features:
# @unstable: This command is meant for debugging.
#
# Returns: TCG compiler statistics
#
# Since: 6.2
##
{ 'command': 'x-query-jit',
'returns': 'HumanReadableText',
'if': 'CONFIG_TCG' }
'if': 'CONFIG_TCG',
'features': [ 'unstable' ] }
##
# @x-query-numa:
#
# Query NUMA topology information
#
# Features:
# @unstable: This command is meant for debugging.
#
# Returns: topology information
#
# Since: 6.2
##
{ 'command': 'x-query-numa',
'returns': 'HumanReadableText' }
'returns': 'HumanReadableText',
'features': [ 'unstable' ] }
##
# @x-query-opcount:
#
# Query TCG opcode counters
#
# Features:
# @unstable: This command is meant for debugging.
#
# Returns: TCG opcode counters
#
# Since: 6.2
##
{ 'command': 'x-query-opcount',
'returns': 'HumanReadableText',
'if': 'CONFIG_TCG' }
'if': 'CONFIG_TCG',
'features': [ 'unstable' ] }
##
# @x-query-profile:
#
# Query TCG profiling information
#
# Features:
# @unstable: This command is meant for debugging.
#
# Returns: profile information
#
# Since: 6.2
##
{ 'command': 'x-query-profile',
'returns': 'HumanReadableText' }
'returns': 'HumanReadableText',
'features': [ 'unstable' ] }
##
# @x-query-ramblock:
#
# Query system ramblock information
#
# Features:
# @unstable: This command is meant for debugging.
#
# Returns: system ramblock information
#
# Since: 6.2
##
{ 'command': 'x-query-ramblock',
'returns': 'HumanReadableText' }
'returns': 'HumanReadableText',
'features': [ 'unstable' ] }
##
# @x-query-rdma:
#
# Query RDMA state
#
# Features:
# @unstable: This command is meant for debugging.
#
# Returns: RDMA state
#
# Since: 6.2
##
{ 'command': 'x-query-rdma',
'returns': 'HumanReadableText' }
'returns': 'HumanReadableText',
'features': [ 'unstable' ] }
##
# @x-query-roms:
#
# Query information on the registered ROMS
#
# Features:
# @unstable: This command is meant for debugging.
#
# Returns: registered ROMs
#
# Since: 6.2
##
{ 'command': 'x-query-roms',
'returns': 'HumanReadableText' }
'returns': 'HumanReadableText',
'features': [ 'unstable' ] }
##
# @x-query-usb:
#
# Query information on the USB devices
#
# Features:
# @unstable: This command is meant for debugging.
#
# Returns: USB device information
#
# Since: 6.2
##
{ 'command': 'x-query-usb',
'returns': 'HumanReadableText' }
'returns': 'HumanReadableText',
'features': [ 'unstable' ] }