ShuriZma
/
xemu
mirror of https://github.com/xemu-project/xemu.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

qapi: convert "Note" sections to plain rST 

We do not need a dedicated section for notes. By eliminating a specially
parsed section, these notes can be treated as normal rST paragraphs in
the new QMP reference manual, and can be placed and styled much more
flexibly.

Convert all existing "Note" and "Notes" sections to pure rST. As part of
the conversion, capitalize the first letter of each sentence and add
trailing punctuation where appropriate to ensure notes look sensible and
consistent in rendered HTML documentation. Markup is also re-aligned to
the de-facto standard of 3 spaces for directives.

Update docs/devel/qapi-code-gen.rst to reflect the new paradigm, and
update the QAPI parser to prohibit "Note" sections while suggesting a
new syntax. The exact formatting to use is a matter of taste, but a good
candidate is simply:

.. note:: lorem ipsum ...
   ... dolor sit amet ...
   ... consectetur adipiscing elit ...

... but there are other choices, too. The Sphinx readthedocs theme
offers theming for the following forms (capitalization unimportant); all
are adorned with a (!) symbol () in the title bar for rendered HTML
docs.

See
https://sphinx-rtd-theme.readthedocs.io/en/stable/demo/demo.html#admonitions
for examples of each directive/admonition in use.

These are rendered in orange:

.. Attention:: ...
.. Caution:: ...
.. WARNING:: ...

These are rendered in red:

.. DANGER:: ...
.. Error:: ...

These are rendered in green:

.. Hint:: ...
.. Important:: ...
.. Tip:: ...

These are rendered in blue:

.. Note:: ...
.. admonition:: custom title

   admonition body text

This patch uses ".. note::" almost everywhere, with just two "caution"
directives. Several instances of "Notes:" have been converted to
merely ".. note::", or multiple ".. note::" where appropriate.
".. admonition:: notes" is used in a few places where we had an
ordered list of multiple notes that would not make sense as
standalone/separate admonitions.  Two "Note:" following "Example:"
have been turned into ordinary paragraphs within the example.

NOTE: Because qapidoc.py does not attempt to preserve source ordering of
sections, the conversion of Notes from a "tagged section" to an
"untagged section" means that rendering order for some notes *may
change* as a result of this patch. The forthcoming qapidoc.py rewrite
strictly preserves source ordering in the rendered documentation, so
this issue will be rectified in the new generator.

Signed-off-by: John Snow <jsnow@redhat.com>
Acked-by: Stefan Hajnoczi <stefanha@redhat.com> [for block*.json]
Message-ID: <20240626222128.406106-11-jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Commit message clarified slightly, period added to one more note]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
John Snow 2024-06-26 18:21:16 -04:00 committed by Markus Armbruster
parent b32a6b62a8
commit d461c27973
30 changed files with 261 additions and 253 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -995,14 +995,13 @@ line "Features:", like this::
# @feature: Description text # @feature: Description text
A tagged section begins with a paragraph that starts with one of the A tagged section begins with a paragraph that starts with one of the
following words: "Note:"/"Notes:", "Since:", "Example:"/"Examples:", following words: "Since:", "Example:"/"Examples:", "Returns:",
"Returns:", "Errors:", "TODO:". It ends with the start of a new "Errors:", "TODO:". It ends with the start of a new section.
section.
The second and subsequent lines of tagged sections must be indented The second and subsequent lines of tagged sections must be indented
like this:: like this::
# Note: Ut enim ad minim veniam, quis nostrud exercitation ullamco # TODO: Ut enim ad minim veniam, quis nostrud exercitation ullamco
# laboris nisi ut aliquip ex ea commodo consequat. # laboris nisi ut aliquip ex ea commodo consequat.
# #
# Duis aute irure dolor in reprehenderit in voluptate velit esse # Duis aute irure dolor in reprehenderit in voluptate velit esse

28
qapi/block-core.json
View File

@ -1619,9 +1619,9 @@
# #
# @unstable: Member @x-perf is experimental. # @unstable: Member @x-perf is experimental.
# #
# Note: @on-source-error and @on-target-error only affect background # .. note:: @on-source-error and @on-target-error only affect background
# I/O. If an error occurs during a guest write request, the # I/O. If an error occurs during a guest write request, the device's
# device's rerror/werror actions will be used. # rerror/werror actions will be used.
# #
# Since: 4.2 # Since: 4.2
## ##
@ -5545,8 +5545,8 @@
# after this event and must be repaired (Since 2.2; before, every # after this event and must be repaired (Since 2.2; before, every
# BLOCK_IMAGE_CORRUPTED event was fatal) # BLOCK_IMAGE_CORRUPTED event was fatal)
# #
# Note: If action is "stop", a STOP event will eventually follow the # .. note:: If action is "stop", a STOP event will eventually follow the
# BLOCK_IO_ERROR event. # BLOCK_IO_ERROR event.
# #
# Example: # Example:
# #
@ -5592,8 +5592,8 @@
# field is a debugging aid for humans, it should not be parsed by # field is a debugging aid for humans, it should not be parsed by
# applications) (since: 2.2) # applications) (since: 2.2)
# #
# Note: If action is "stop", a STOP event will eventually follow the # .. note:: If action is "stop", a STOP event will eventually follow the
# BLOCK_IO_ERROR event # BLOCK_IO_ERROR event.
# #
# Since: 0.13 # Since: 0.13
# #
@ -5731,8 +5731,8 @@
# #
# @speed: rate limit, bytes per second # @speed: rate limit, bytes per second
# #
# Note: The "ready to complete" status is always reset by a # .. note:: The "ready to complete" status is always reset by a
# @BLOCK_JOB_ERROR event # @BLOCK_JOB_ERROR event.
# #
# Since: 1.3 # Since: 1.3
# #
@ -5985,7 +5985,7 @@
# #
# @sectors-count: failed read operation sector count # @sectors-count: failed read operation sector count
# #
# Note: This event is rate-limited. # .. note:: This event is rate-limited.
# #
# Since: 2.0 # Since: 2.0
# #
@ -6016,7 +6016,7 @@
# #
# @sectors-count: failed read operation sector count # @sectors-count: failed read operation sector count
# #
# Note: This event is rate-limited. # .. note:: This event is rate-limited.
# #
# Since: 2.0 # Since: 2.0
# #
@ -6048,9 +6048,9 @@
# #
# @name: the name of the internal snapshot to be created # @name: the name of the internal snapshot to be created
# #
# Notes: In transaction, if @name is empty, or any snapshot matching # .. note:: In transaction, if @name is empty, or any snapshot matching
# @name exists, the operation will fail. Only some image formats # @name exists, the operation will fail. Only some image formats
# support it, for example, qcow2, and rbd. # support it, for example, qcow2, and rbd.
# #
# Since: 1.7 # Since: 1.7
## ##

2
qapi/block.json
View File

@ -113,7 +113,7 @@
# Errors: # Errors:
# - If @device is not a valid block device, DeviceNotFound # - If @device is not a valid block device, DeviceNotFound
# #
# Notes: Ejecting a device with no media results in success # .. note:: Ejecting a device with no media results in success.
# #
# Since: 0.14 # Since: 0.14
# #

12
qapi/char.json
View File

@ -21,8 +21,8 @@
# backend (e.g. with the chardev=... option) is in open or closed # backend (e.g. with the chardev=... option) is in open or closed
# state (since 2.1) # state (since 2.1)
# #
# Notes: @filename is encoded using the QEMU command line character # .. note:: @filename is encoded using the QEMU command line character
# device encoding. See the QEMU man page for details. # device encoding. See the QEMU man page for details.
# #
# Since: 0.14 # Since: 0.14
## ##
@ -388,9 +388,9 @@
# #
# @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, # display backend is active. They are ignored with the GTK, Spice,
# Spice, VNC and D-Bus display backends. # VNC and D-Bus display backends.
# #
# Since: 1.5 # Since: 1.5
## ##
@ -806,7 +806,7 @@
# #
# @open: true if the guest has opened the virtio-serial port # @open: true if the guest has opened the virtio-serial port
# #
# Note: This event is rate-limited. # .. note:: This event is rate-limited.
# #
# Since: 2.1 # Since: 2.1
# #

17
qapi/control.json
View File

@ -22,14 +22,13 @@
# "arguments": { "enable": [ "oob" ] } } # "arguments": { "enable": [ "oob" ] } }
# <- { "return": {} } # <- { "return": {} }
# #
# Notes: This command is valid exactly when first connecting: it must # .. note:: This command is valid exactly when first connecting: it must
# be issued before any other command will be accepted, and will # be issued before any other command will be accepted, and will fail
# fail once the monitor is accepting other commands. (see qemu # once the monitor is accepting other commands. (see qemu
# docs/interop/qmp-spec.rst) # docs/interop/qmp-spec.rst)
# #
# The QMP client needs to explicitly enable QMP capabilities, # .. note:: The QMP client needs to explicitly enable QMP capabilities,
# otherwise all the QMP capabilities will be turned off by # otherwise all the QMP capabilities will be turned off by default.
# default.
# #
# Since: 0.13 # Since: 0.13
## ##
@ -150,8 +149,8 @@
# ] # ]
# } # }
# #
# Note: This example has been shortened as the real response is too # This example has been shortened as the real response is too long.
# long. #
## ##
{ 'command': 'query-commands', 'returns': ['CommandInfo'], { 'command': 'query-commands', 'returns': ['CommandInfo'],
'allow-preconfig': true } 'allow-preconfig': true }

2
qapi/dump.json
View File

@ -90,7 +90,7 @@
# and @length is not allowed to be specified with non-elf @format # and @length is not allowed to be specified with non-elf @format
# at the same time (since 2.0) # at the same time (since 2.0)
# #
# Note: All boolean arguments default to false # .. note:: All boolean arguments default to false.
# #
# Since: 1.2 # Since: 1.2
# #

6
qapi/introspect.json
View File

@ -41,9 +41,9 @@
# names are guaranteed to be unique (no name will be duplicated # names are guaranteed to be unique (no name will be duplicated
# with different meta-types). # with different meta-types).
# #
# Note: the QAPI schema is also used to help define *internal* # .. note:: The QAPI schema is also used to help define *internal*
# interfaces, by defining QAPI types. These are not part of the # interfaces, by defining QAPI types. These are not part of the QMP
# QMP wire ABI, and therefore not returned by this command. # wire ABI, and therefore not returned by this command.
# #
# Since: 2.5 # Since: 2.5
## ##

26
qapi/machine-target.json
View File

@ -49,15 +49,15 @@
# to be migration-safe, but allows tooling to get an insight and # to be migration-safe, but allows tooling to get an insight and
# work with model details. # work with model details.
# #
# Note: When a non-migration-safe CPU model is expanded in static # .. note:: When a non-migration-safe CPU model is expanded in static
# mode, some features enabled by the CPU model may be omitted, # mode, some features enabled by the CPU model may be omitted,
# because they can't be implemented by a static CPU model # because they can't be implemented by a static CPU model definition
# definition (e.g. cache info passthrough and PMU passthrough in # (e.g. cache info passthrough and PMU passthrough in x86). If you
# x86). If you need an accurate representation of the features # need an accurate representation of the features enabled by a
# enabled by a non-migration-safe CPU model, use @full. If you # non-migration-safe CPU model, use @full. If you need a static
# need a static representation that will keep ABI compatibility # representation that will keep ABI compatibility even when changing
# even when changing QEMU version or machine-type, use @static # QEMU version or machine-type, use @static (but keep in mind that
# (but keep in mind that some features may be omitted). # some features may be omitted).
# #
# Since: 2.8 # Since: 2.8
## ##
@ -175,8 +175,8 @@
# - if a model contains an unknown cpu definition name, unknown # - if a model contains an unknown cpu definition name, unknown
# properties or properties with wrong types. # properties or properties with wrong types.
# #
# Note: this command isn't specific to s390x, but is only implemented # .. note:: This command isn't specific to s390x, but is only
# on this architecture currently. # implemented on this architecture currently.
# #
# Since: 2.8 # Since: 2.8
## ##
@ -229,8 +229,8 @@
# - if a model contains an unknown cpu definition name, unknown # - if a model contains an unknown cpu definition name, unknown
# properties or properties with wrong types. # properties or properties with wrong types.
# #
# Note: this command isn't specific to s390x, but is only implemented # .. note:: This command isn't specific to s390x, but is only
# on this architecture currently. # implemented on this architecture currently.
# #
# Since: 2.8 # Since: 2.8
## ##

47
qapi/machine.json
View File

@ -24,9 +24,9 @@
# #
# @avr: since 5.1 # @avr: since 5.1
# #
# Notes: The resulting QMP strings can be appended to the # .. note:: The resulting QMP strings can be appended to the
# "qemu-system-" prefix to produce the corresponding QEMU # "qemu-system-" prefix to produce the corresponding QEMU executable
# executable name. This is true even for "qemu-system-x86_64". # name. This is true even for "qemu-system-x86_64".
# #
# Since: 3.0 # Since: 3.0
## ##
@ -305,8 +305,9 @@
# #
# Since: 0.14 # Since: 0.14
# #
# Notes: If no UUID was specified for the guest, a null UUID is # .. note:: If no UUID was specified for the guest, a null UUID is
# returned. # returned.
#
## ##
{ 'struct': 'UuidInfo', 'data': {'UUID': 'str'} } { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} }
@ -367,10 +368,10 @@
# #
# Since: 0.14 # Since: 0.14
# #
# Notes: A guest may or may not respond to this command. This command # .. note:: A guest may or may not respond to this command. This
# returning does not indicate that a guest has accepted the # command returning does not indicate that a guest has accepted the
# request or that it has shut down. Many guests will respond to # request or that it has shut down. Many guests will respond to this
# this command by prompting the user in some way. # command by prompting the user in some way.
# #
# Example: # Example:
# #
@ -389,8 +390,8 @@
# #
# Since: 1.1 # Since: 1.1
# #
# Note: prior to 4.0, this command does nothing in case the guest # .. note:: Prior to 4.0, this command does nothing in case the guest
# isn't suspended. # isn't suspended.
# #
# Example: # Example:
# #
@ -440,8 +441,8 @@
# #
# Since: 0.14 # Since: 0.14
# #
# Note: prior to 2.1, this command was only supported for x86 and s390 # .. note:: Prior to 2.1, this command was only supported for x86 and
# VMs # s390 VMs.
# #
# Example: # Example:
# #
@ -839,7 +840,7 @@
# #
# Since: 0.14 # Since: 0.14
# #
# Notes: Errors were not reliably returned until 1.1 # .. caution:: Errors were not reliably returned until 1.1.
# #
# Example: # Example:
# #
@ -865,7 +866,7 @@
# #
# Since: 0.14 # Since: 0.14
# #
# Notes: Errors were not reliably returned until 1.1 # .. caution:: Errors were not reliably returned until 1.1.
# #
# Example: # Example:
# #
@ -995,8 +996,8 @@
# #
# @thread-id: thread number within the core the CPU belongs to # @thread-id: thread number within the core the CPU belongs to
# #
# Note: management should be prepared to pass through additional # .. note:: Management should be prepared to pass through additional
# properties with device_add. # properties with device_add.
# #
# Since: 2.7 # Since: 2.7
## ##
@ -1123,9 +1124,9 @@
# the 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 # .. note:: 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 change
# change the balloon size independent of this command. # the balloon size independent of this command.
# #
# Since: 0.14 # Since: 0.14
# #
@ -1185,7 +1186,7 @@
# @actual: the logical size of the VM in bytes Formula used: # @actual: the logical size of the VM in bytes Formula used:
# logical_vm_size = vm_ram_size - balloon_size # logical_vm_size = vm_ram_size - balloon_size
# #
# Note: this event is rate-limited. # .. note:: This event is rate-limited.
# #
# Since: 1.2 # Since: 1.2
# #
@ -1248,7 +1249,7 @@
# Emitted when the hv-balloon driver receives a "STATUS" message from # Emitted when the hv-balloon driver receives a "STATUS" message from
# the guest. # the guest.
# #
# Note: this event is rate-limited. # .. note:: This event is rate-limited.
# #
# Since: 8.2 # Since: 8.2
# #
@ -1593,7 +1594,7 @@
# #
# @qom-path: path to the device object in the QOM tree (since 6.2) # @qom-path: path to the device object in the QOM tree (since 6.2)
# #
# Note: this event is rate-limited. # .. note:: This event is rate-limited.
# #
# Since: 5.1 # Since: 5.1
# #

14
qapi/migration.json
View File

@ -1456,8 +1456,8 @@
# #
# Cancel the current executing migration process. # Cancel the current executing migration process.
# #
# Notes: This command succeeds even if there is no migration process # .. note:: This command succeeds even if there is no migration process
# running. # running.
# #
# Since: 0.14 # Since: 0.14
# #
@ -1589,16 +1589,16 @@
# #
# Since: 0.14 # Since: 0.14
# #
# Notes: # .. admonition:: Notes
# #
# 1. The 'query-migrate' command should be used to check # 1. The 'query-migrate' command should be used to check
# migration's progress and final result (this information is # migration's progress and final result (this information is
# provided by the 'status' member) # provided by the 'status' member).
# #
# 2. All boolean arguments default to false # 2. All boolean arguments default to false.
# #
# 3. The user Monitor's "detach" argument is invalid in QMP and # 3. The user Monitor's "detach" argument is invalid in QMP and
# should not be used # should not be used.
# #
# 4. The uri argument should have the Uniform Resource Identifier # 4. The uri argument should have the Uniform Resource Identifier
# of default destination VM. This connection will be bound to # of default destination VM. This connection will be bound to
@ -1672,7 +1672,7 @@
# #
# Since: 2.3 # Since: 2.3
# #
# Notes: # .. admonition:: Notes
# #
# 1. It's a bad idea to use a string for the uri, but it needs to # 1. It's a bad idea to use a string for the uri, but it needs to
# stay compatible with -incoming and the format of the uri is # stay compatible with -incoming and the format of the uri is

88
qapi/misc.json
View File

@ -103,9 +103,9 @@
# #
# Returns a list of information about each iothread. # Returns a list of information about each iothread.
# #
# Note: this list excludes the QEMU main loop thread, which is not # .. note:: This list excludes the QEMU main loop thread, which is not
# declared using the -object iothread command-line option. It is # declared using the -object iothread command-line option. It is
# always the main thread of the process. # always the main thread of the process.
# #
# Returns: a list of @IOThreadInfo for each iothread # Returns: a list of @IOThreadInfo for each iothread
# #
@ -136,13 +136,13 @@
# #
# Since: 0.14 # Since: 0.14
# #
# Notes: This function will succeed even if the guest is already in # .. note:: This function will succeed even if the guest is already in
# the stopped state. In "inmigrate" state, it will ensure that # the stopped state. In "inmigrate" state, it will ensure that the
# the guest remains paused once migration finishes, as if the -S # guest remains paused once migration finishes, as if the -S option
# option was passed on the command line. # was passed on the command line.
# #
# In the "suspended" state, it will completely stop the VM and # In the "suspended" state, it will completely stop the VM and cause
# cause a transition to the "paused" state. (Since 9.0) # a transition to the "paused" state. (Since 9.0)
# #
# Example: # Example:
# #
@ -158,15 +158,15 @@
# #
# Since: 0.14 # Since: 0.14
# #
# Notes: This command will succeed if the guest is currently running. # .. note:: This command will succeed if the guest is currently running.
# It will also succeed if the guest is in the "inmigrate" state; # It will also succeed if the guest is in the "inmigrate" state; in
# in this case, the effect of the command is to make sure the # this case, the effect of the command is to make sure the guest
# guest starts once migration finishes, removing the effect of the # starts once migration finishes, removing the effect of the -S
# -S command line option if it was passed. # command line option if it was passed.
# #
# If the VM was previously suspended, and not been reset or woken, # If the VM was previously suspended, and not been reset or woken,
# this command will transition back to the "suspended" state. # this command will transition back to the "suspended" state. (Since
# (Since 9.0) # 9.0)
# #
# Example: # Example:
# #
@ -219,18 +219,18 @@
# #
# Since: 0.14 # Since: 0.14
# #
# Notes: This command only exists as a stop-gap. Its use is highly # .. note:: This command only exists as a stop-gap. Its use is highly
# discouraged. The semantics of this command are not guaranteed: # discouraged. The semantics of this command are not guaranteed:
# this means that command names, arguments and responses can # this means that command names, arguments and responses can change
# change or be removed at ANY time. Applications that rely on # or be removed at ANY time. Applications that rely on long term
# long term stability guarantees should NOT use this command. # stability guarantees should NOT use this command.
# #
# Known limitations: # Known limitations:
# #
# * This command is stateless, this means that commands that # * This command is stateless, this means that commands that
# depend on state information (such as getfd) might not work # depend on state information (such as getfd) might not work.
# #
# * Commands that prompt the user for data don't currently work # * Commands that prompt the user for data don't currently work.
# #
# Example: # Example:
# #
@ -252,11 +252,11 @@
# #
# Since: 0.14 # Since: 0.14
# #
# Notes: If @fdname already exists, the file descriptor assigned to it # .. note:: If @fdname already exists, the file descriptor assigned to
# will be closed and replaced by the received file descriptor. # it will be closed and replaced by the received file descriptor.
# #
# The 'closefd' command can be used to explicitly close the file # The 'closefd' command can be used to explicitly close the file
# descriptor when it is no longer needed. # descriptor when it is no longer needed.
# #
# Example: # Example:
# #
@ -279,11 +279,11 @@
# #
# Since: 8.0 # Since: 8.0
# #
# Notes: If @fdname already exists, the file descriptor assigned to it # .. note:: If @fdname already exists, the file descriptor assigned to
# will be closed and replaced by the received file descriptor. # it will be closed and replaced by the received file descriptor.
# #
# The 'closefd' command can be used to explicitly close the file # The 'closefd' command can be used to explicitly close the file
# descriptor when it is no longer needed. # descriptor when it is no longer needed.
# #
# Example: # Example:
# #
@ -339,10 +339,9 @@
# - 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: # .. note:: The list of fd sets is shared by all monitor connections.
# The list of fd sets is shared by all monitor connections.
# #
# If @fdset-id is not specified, a new fd set will be created. # .. note:: If @fdset-id is not specified, a new fd set will be created.
# #
# Since: 1.2 # Since: 1.2
# #
@ -370,11 +369,10 @@
# #
# Since: 1.2 # Since: 1.2
# #
# Notes: # .. note:: The list of fd sets is shared by all monitor connections.
# The list of fd sets is shared by all monitor connections.
# #
# If @fd is not specified, all file descriptors in @fdset-id will # .. note:: If @fd is not specified, all file descriptors in @fdset-id
# be removed. # will be removed.
# #
# Example: # Example:
# #
@ -420,7 +418,7 @@
# #
# Since: 1.2 # Since: 1.2
# #
# Note: The list of fd sets is shared by all monitor connections. # .. note:: The list of fd sets is shared by all monitor connections.
# #
# Example: # Example:
# #
@ -561,9 +559,9 @@
# #
# @qom-path: path to the RTC object in the QOM tree # @qom-path: path to the RTC object in the QOM tree
# #
# Note: This event is rate-limited. It is not guaranteed that the RTC # .. note:: This event is rate-limited. It is not guaranteed that the
# in the system implements this event, or even that the system has # RTC in the system implements this event, or even that the system
# an RTC at all. # has an RTC at all.
# #
# Since: 0.13 # Since: 0.13
# #

6
qapi/net.json
View File

@ -22,9 +22,9 @@
# #
# Since: 0.14 # Since: 0.14
# #
# Notes: Not all network adapters support setting link status. This # .. note:: Not all network adapters support setting link status. This
# command will succeed even if the network adapter does not # command will succeed even if the network adapter does not support
# support link status notification. # link status notification.
# #
# Example: # Example:
# #

8
qapi/pci.json
View File

@ -146,8 +146,8 @@
# #
# @regions: a list of the PCI I/O regions associated with the device # @regions: a list of the PCI I/O regions associated with the device
# #
# Notes: the contents of @class_info.desc are not stable and should # .. note:: The contents of @class_info.desc are not stable and should
# only be treated as informational. # only be treated as informational.
# #
# Since: 0.14 # Since: 0.14
## ##
@ -311,7 +311,7 @@
# ] # ]
# } # }
# #
# Note: This example has been shortened as the real response is too # This example has been shortened as the real response is too long.
# long. #
## ##
{ 'command': 'query-pci', 'returns': ['PciInfo'] } { 'command': 'query-pci', 'returns': ['PciInfo'] }

28
qapi/qdev.json
View File

@ -20,9 +20,9 @@
# Returns: a list of ObjectPropertyInfo describing a devices # Returns: a list of ObjectPropertyInfo describing a devices
# properties # properties
# #
# Note: objects can create properties at runtime, for example to # .. note:: Objects can create properties at runtime, for example to
# describe links between different devices and/or objects. These # describe links between different devices and/or objects. These
# properties are not included in the output of this command. # properties are not included in the output of this command.
# #
# Since: 1.2 # Since: 1.2
## ##
@ -51,7 +51,7 @@
# supports JSON syntax without the reference counting leak that # supports JSON syntax without the reference counting leak that
# broke hot-unplug # broke hot-unplug
# #
# Notes: # .. admonition:: Notes
# #
# 1. Additional arguments depend on the type. # 1. Additional arguments depend on the type.
# #
@ -60,7 +60,7 @@
# #
# 3. It's possible to list device properties by running QEMU with # 3. It's possible to list device properties by running QEMU with
# the "-device DEVICE,help" command-line argument, where DEVICE # the "-device DEVICE,help" command-line argument, where DEVICE
# is the device's name # is the device's name.
# #
# Example: # Example:
# #
@ -92,15 +92,15 @@
# Errors: # Errors:
# - If @id is not a valid device, DeviceNotFound # - If @id is not a valid device, DeviceNotFound
# #
# Notes: When this command completes, the device may not be removed # .. note:: 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
# cooperation. This command merely requests that the guest begin # cooperation. This command merely requests that the guest begin the
# the hot removal process. Completion of the device removal # hot removal process. Completion of the device removal process is
# process is signaled with a DEVICE_DELETED event. Guest reset # signaled with a DEVICE_DELETED event. Guest reset will
# will automatically complete removal for all devices. If a # automatically complete removal for all devices. If a guest-side
# guest-side error in the hot removal process is detected, the # error in the hot removal process is detected, the device will not
# device will not be removed and a DEVICE_UNPLUG_GUEST_ERROR event # be removed and a DEVICE_UNPLUG_GUEST_ERROR event is sent. Some
# is sent. Some errors cannot be detected. # errors cannot be detected.
# #
# Since: 0.14 # Since: 0.14
# #

17
qapi/qom.json
View File

@ -195,9 +195,9 @@
# #
# @typename: the type name of an object # @typename: the type name of an object
# #
# Note: objects can create properties at runtime, for example to # .. note:: Objects can create properties at runtime, for example to
# describe links between different devices and/or objects. These # describe links between different devices and/or objects. These
# properties are not included in the output of this command. # properties are not included in the output of this command.
# #
# Returns: a list of ObjectPropertyInfo describing object properties # Returns: a list of ObjectPropertyInfo describing object properties
# #
@ -614,12 +614,11 @@
# older to allow migration with newer QEMU versions. # older to allow migration with newer QEMU versions.
# (default: false generally, but true for machine types <= 4.0) # (default: false generally, but true for machine types <= 4.0)
# #
# Note: prealloc=true and reserve=false cannot be set at the same # .. note:: prealloc=true and reserve=false cannot be set at the same
# time. With reserve=true, the behavior depends on the operating # time. With reserve=true, the behavior depends on the operating
# system: for example, Linux will not reserve swap space for # system: for example, Linux will not reserve swap space for shared
# shared file mappings -- "not applicable". In contrast, # file mappings -- "not applicable". In contrast, reserve=false will
# reserve=false will bail out if it cannot be configured # bail out if it cannot be configured accordingly.
# accordingly.
# #
# Since: 2.1 # Since: 2.1
## ##

16
qapi/rocker.json
View File

@ -138,8 +138,8 @@
# #
# @ip-dst: IP header destination address # @ip-dst: IP header destination address
# #
# Note: optional members may or may not appear in the flow key # .. note:: Optional members may or may not appear in the flow key
# depending if they're relevant to the flow key. # depending if they're relevant to the flow key.
# #
# Since: 2.4 # Since: 2.4
## ##
@ -168,8 +168,8 @@
# #
# @ip-tos: IP header TOS field # @ip-tos: IP header TOS field
# #
# Note: optional members may or may not appear in the flow mask # .. note:: Optional members may or may not appear in the flow mask
# depending if they're relevant to the flow mask. # depending if they're relevant to the flow mask.
# #
# Since: 2.4 # Since: 2.4
## ##
@ -195,8 +195,8 @@
# #
# @out-pport: physical output port # @out-pport: physical output port
# #
# Note: optional members may or may not appear in the flow action # .. note:: Optional members may or may not appear in the flow action
# depending if they're relevant to the flow action. # depending if they're relevant to the flow action.
# #
# Since: 2.4 # Since: 2.4
## ##
@ -288,8 +288,8 @@
# #
# @ttl-check: perform TTL check # @ttl-check: perform TTL check
# #
# Note: optional members may or may not appear in the group depending # .. note:: Optional members may or may not appear in the group depending
# if they're relevant to the group type. # if they're relevant to the group type.
# #
# Since: 2.4 # Since: 2.4
## ##

18
qapi/run-state.json
View File

@ -146,9 +146,9 @@
# @reason: The @ShutdownCause which resulted in the SHUTDOWN. # @reason: The @ShutdownCause which resulted in the SHUTDOWN.
# (since 4.0) # (since 4.0)
# #
# Note: If the command-line option "-no-shutdown" has been specified, # .. note:: If the command-line option "-no-shutdown" has been
# qemu will not exit, and a STOP event will eventually follow the # specified, qemu will not exit, and a STOP event will eventually
# SHUTDOWN event # follow the SHUTDOWN event.
# #
# Since: 0.12 # Since: 0.12
# #
@ -247,8 +247,8 @@
# saved on disk, for example, S4 state, which is sometimes called # saved on disk, for example, S4 state, which is sometimes called
# hibernate state # hibernate state
# #
# Note: QEMU shuts down (similar to event @SHUTDOWN) when entering # .. note:: QEMU shuts down (similar to event @SHUTDOWN) when entering
# this state # this state.
# #
# Since: 1.2 # Since: 1.2
# #
@ -281,11 +281,11 @@
# #
# @action: action that has been taken # @action: action that has been taken
# #
# Note: If action is "reset", "shutdown", or "pause" the WATCHDOG # .. note:: If action is "reset", "shutdown", or "pause" the WATCHDOG
# event is followed respectively by the RESET, SHUTDOWN, or STOP # event is followed respectively by the RESET, SHUTDOWN, or STOP
# events # events.
# #
# Note: This event is rate-limited. # .. note:: This event is rate-limited.
# #
# Since: 0.13 # Since: 0.13
# #

10
qapi/sockets.json
View File

@ -104,8 +104,8 @@
# #
# @port: port # @port: port
# #
# Note: string types are used to allow for possible future hostname or # .. note:: String types are used to allow for possible future hostname
# service resolution support. # or service resolution support.
# #
# Since: 2.8 # Since: 2.8
## ##
@ -179,9 +179,9 @@
# #
# @type: Transport type # @type: Transport type
# #
# Note: This type is deprecated in favor of SocketAddress. The # .. note:: This type is deprecated in favor of SocketAddress. The
# difference between SocketAddressLegacy and SocketAddress is that # difference between SocketAddressLegacy and SocketAddress is that
# the latter has fewer {} on the wire. # the latter has fewer {} on the wire.
# #
# Since: 1.3 # Since: 1.3
## ##

22
qapi/stats.json
View File

@ -258,17 +258,17 @@
# #
# @provider: a provider to restrict the query to. # @provider: a provider to restrict the query to.
# #
# Note: runtime-collected statistics and their names fall outside # .. note:: Runtime-collected statistics and their names fall outside
# QEMU's usual deprecation policies. QEMU will try to keep the # QEMU's usual deprecation policies. QEMU will try to keep the set
# set of available data stable, together with their names, but # of available data stable, together with their names, but will not
# will not guarantee stability at all costs; the same is true of # guarantee stability at all costs; the same is true of providers
# providers that source statistics externally, e.g. from Linux. # that source statistics externally, e.g. from Linux. For example,
# For example, if the same value is being tracked with different # if the same value is being tracked with different names on
# names on different architectures or by different providers, one # different architectures or by different providers, one of them
# of them might be renamed. A statistic might go away if an # might be renamed. A statistic might go away if an algorithm is
# algorithm is changed or some code is removed; changing a default # changed or some code is removed; changing a default might cause
# might cause previously useful statistics to always report 0. # previously useful statistics to always report 0. Such changes,
# Such changes, however, are expected to be rare. # however, are expected to be rare.
# #
# Since: 7.1 # Since: 7.1
## ##

8
qapi/transaction.json
View File

@ -237,10 +237,10 @@
# Errors: # Errors:
# - Any errors from commands in the transaction # - Any errors from commands in the transaction
# #
# Note: The transaction aborts on the first failure. Therefore, there # .. note:: The transaction aborts on the first failure. Therefore,
# will be information on only one failed operation returned in an # there will be information on only one failed operation returned in
# error condition, and subsequent actions will not have been # an error condition, and subsequent actions will not have been
# attempted. # attempted.
# #
# Since: 1.1 # Since: 1.1
# #

29
qapi/ui.json
View File

@ -107,11 +107,10 @@
# - '+INT' where INT is the number of seconds from now (integer) # - '+INT' where INT is the number of seconds from now (integer)
# - 'INT' where INT is the absolute time in seconds # - 'INT' where INT is the absolute time in seconds
# #
# Notes: Time is relative to the server and currently there is no way # .. note:: Time is relative to the server and currently there is no way
# to coordinate server time with client time. It is not # to coordinate server time with client time. It is not recommended
# recommended to use the absolute time version of the @time # to use the absolute time version of the @time parameter unless
# parameter unless you're sure you are on the same machine as the # you're sure you are on the same machine as the QEMU instance.
# QEMU instance.
# #
# Since: 7.0 # Since: 7.0
## ##
@ -274,7 +273,7 @@
# @unknown: No information is available about mouse mode used by the # @unknown: No information is available about mouse mode used by the
# spice server. # spice server.
# #
# Note: spice/enums.h has a SpiceMouseMode already, hence the name. # .. note:: spice/enums.h has a SpiceMouseMode already, hence the name.
# #
# Since: 1.1 # Since: 1.1
## ##
@ -705,9 +704,9 @@
# #
# Since: 1.1 # Since: 1.1
# #
# Notes: An empty password in this command will set the password to # .. note:: An empty password in this command will set the password to
# the empty string. Existing clients are unaffected by executing # the empty string. Existing clients are unaffected by executing
# this command. # this command.
## ##
{ 'command': 'change-vnc-password', { 'command': 'change-vnc-password',
'data': { 'password': 'str' }, 'data': { 'password': 'str' },
@ -722,8 +721,8 @@
# #
# @client: client information # @client: client information
# #
# Note: This event is emitted before any authentication takes place, # .. note:: This event is emitted before any authentication takes place,
# thus the authentication ID is not provided # thus the authentication ID is not provided.
# #
# Since: 0.13 # Since: 0.13
# #
@ -1268,10 +1267,10 @@
# #
# Since: 2.6 # Since: 2.6
# #
# Note: The consoles are visible in the qom tree, under # .. note:: The consoles are visible in the qom tree, under
# /backend/console[$index]. They have a device link and head # /backend/console[$index]. They have a device link and head
# property, so it is possible to map which console belongs to # property, so it is possible to map which console belongs to which
# which device and display. # device and display.
# #
# Examples: # Examples:
# #

12
qapi/virtio.json
View File

@ -559,12 +559,12 @@
# #
# Returns: VirtQueueStatus of the VirtQueue # Returns: VirtQueueStatus of the VirtQueue
# #
# Notes: last_avail_idx will not be displayed in the case where the # .. note:: last_avail_idx will not be displayed in the case where the
# selected VirtIODevice has a running vhost device and the # selected VirtIODevice has a running vhost device and the
# VirtIODevice VirtQueue index (queue) does not exist for the # VirtIODevice VirtQueue index (queue) does not exist for the
# corresponding vhost device vhost_virtqueue. Also, # corresponding vhost device vhost_virtqueue. Also, shadow_avail_idx
# shadow_avail_idx will not be displayed in the case where the # will not be displayed in the case where the selected VirtIODevice
# selected VirtIODevice has a running vhost device. # has a running vhost device.
# #
# Since: 7.2 # Since: 7.2
# #

48
qga/qapi-schema.json
View File

@ -422,8 +422,9 @@
# Returns: GuestFsfreezeStatus ("thawed", "frozen", etc., as defined # Returns: GuestFsfreezeStatus ("thawed", "frozen", etc., as defined
# below) # below)
# #
# Note: This may fail to properly report the current state as a result # .. note:: This may fail to properly report the current state as a
# of some other guest processes having issued an fs freeze/thaw. # result of some other guest processes having issued an fs
# freeze/thaw.
# #
# Since: 0.15.0 # Since: 0.15.0
## ##
@ -443,9 +444,9 @@
# #
# Returns: Number of file systems currently frozen. # Returns: Number of file systems currently frozen.
# #
# Note: On Windows, the command is implemented with the help of a # .. note:: On Windows, the command is implemented with the help of a
# Volume Shadow-copy Service DLL helper. The frozen state is # Volume Shadow-copy Service DLL helper. The frozen state is limited
# limited for up to 10 seconds by VSS. # for up to 10 seconds by VSS.
# #
# Since: 0.15.0 # Since: 0.15.0
## ##
@ -479,10 +480,10 @@
# #
# Returns: Number of file systems thawed by this call # Returns: Number of file systems thawed by this call
# #
# Note: if return value does not match the previous call to # .. note:: If return value does not match the previous call to
# guest-fsfreeze-freeze, this likely means some freezable # guest-fsfreeze-freeze, this likely means some freezable filesystems
# filesystems were unfrozen before this call, and that the # were unfrozen before this call, and that the filesystem state may
# filesystem state may have changed before issuing this command. # have changed before issuing this command.
# #
# Since: 0.15.0 # Since: 0.15.0
## ##
@ -560,8 +561,8 @@
# Errors: # Errors:
# - If suspend to disk is not supported, Unsupported # - If suspend to disk is not supported, Unsupported
# #
# Notes: It's strongly recommended to issue the guest-sync command # .. note:: It's strongly recommended to issue the guest-sync command
# before sending commands when the guest resumes # before sending commands when the guest resumes.
# #
# Since: 1.1 # Since: 1.1
## ##
@ -596,8 +597,8 @@
# Errors: # Errors:
# - If suspend to ram is not supported, Unsupported # - If suspend to ram is not supported, Unsupported
# #
# Notes: It's strongly recommended to issue the guest-sync command # .. note:: It's strongly recommended to issue the guest-sync command
# before sending commands when the guest resumes # before sending commands when the guest resumes.
# #
# Since: 1.1 # Since: 1.1
## ##
@ -631,8 +632,8 @@
# Errors: # Errors:
# - If hybrid suspend is not supported, Unsupported # - If hybrid suspend is not supported, Unsupported
# #
# Notes: It's strongly recommended to issue the guest-sync command # .. note:: It's strongly recommended to issue the guest-sync command
# before sending commands when the guest resumes # before sending commands when the guest resumes.
# #
# Since: 1.1 # Since: 1.1
## ##
@ -1461,16 +1462,15 @@
# * POSIX: as defined by os-release(5) # * POSIX: as defined by os-release(5)
# * Windows: contains string "server" or "client" # * Windows: contains string "server" or "client"
# #
# Notes: On POSIX systems the fields @id, @name, @pretty-name, # .. note:: On POSIX systems the fields @id, @name, @pretty-name,
# @version, @version-id, @variant and @variant-id follow the # @version, @version-id, @variant and @variant-id follow the
# definition specified in os-release(5). Refer to the manual page # definition specified in os-release(5). Refer to the manual page for
# for exact description of the fields. Their values are taken # exact description of the fields. Their values are taken from the
# from the os-release file. If the file is not present in the # os-release file. If the file is not present in the system, or the
# system, or the values are not present in the file, the fields # values are not present in the file, the fields are not included.
# are not included.
# #
# On Windows the values are filled from information gathered from # On Windows the values are filled from information gathered from
# the system. # the system.
# #
# Since: 2.10 # Since: 2.10
## ##

15
scripts/qapi/parser.py
View File

@ -547,6 +547,21 @@ class QAPISchemaParser:
r'(Returns|Errors|Since|Notes?|Examples?|TODO): *', r'(Returns|Errors|Since|Notes?|Examples?|TODO): *',
line): line):
# tagged section # tagged section
# TODO: Remove this error sometime in 2025 or so
# after we've fully transitioned to the new qapidoc
# generator.
# See commit message for more markup suggestions O:-)
if 'Note' in match.group(1):
emsg = (
f"The '{match.group(1)}' section is no longer "
"supported. Please use rST's '.. note::' or "
"'.. admonition:: notes' directives, or another "
"suitable admonition instead."
)
raise QAPIParseError(self, emsg)
doc.new_tagged_section(self.info, match.group(1)) doc.new_tagged_section(self.info, match.group(1))
text = line[match.end():] text = line[match.end():]
if text: if text:

2
tests/qapi-schema/doc-empty-section.err
View File

@ -1 +1 @@
doc-empty-section.json:6: text required after 'Note:' doc-empty-section.json:6: text required after 'Errors:'

2
tests/qapi-schema/doc-empty-section.json
View File

@ -3,6 +3,6 @@
## ##
# @foo: # @foo:
# #
# Note: # Errors:
## ##
{ 'command': 'foo', 'data': {'a': 'int'} } { 'command': 'foo', 'data': {'a': 'int'} }

4
tests/qapi-schema/doc-good.json
View File

@ -157,7 +157,7 @@
# @cmd-feat1: a feature # @cmd-feat1: a feature
# @cmd-feat2: another feature # @cmd-feat2: another feature
# #
# Note: @arg3 is undocumented # .. note:: @arg3 is undocumented
# #
# Returns: @Object # Returns: @Object
# #
@ -165,7 +165,7 @@
# #
# TODO: frobnicate # TODO: frobnicate
# #
# Notes: # .. admonition:: Notes
# #
# - Lorem ipsum dolor sit amet # - Lorem ipsum dolor sit amet
# - Ut enim ad minim veniam # - Ut enim ad minim veniam

8
tests/qapi-schema/doc-good.out
View File

@ -169,15 +169,17 @@ description starts on the same line
a feature a feature
feature=cmd-feat2 feature=cmd-feat2
another feature another feature
section=Note section=None
@arg3 is undocumented .. note:: @arg3 is undocumented
section=Returns section=Returns
@Object @Object
section=Errors section=Errors
some some
section=TODO section=TODO
frobnicate frobnicate
section=Notes section=None
.. admonition:: Notes
- Lorem ipsum dolor sit amet - Lorem ipsum dolor sit amet
- Ut enim ad minim veniam - Ut enim ad minim veniam

10
tests/qapi-schema/doc-good.txt
View File

@ -193,11 +193,9 @@ Features
"cmd-feat2" "cmd-feat2"
another feature another feature
Note:
Note "arg3" is undocumented
~~~~
"arg3" is undocumented
Returns Returns
@ -211,9 +209,7 @@ Errors
some some
Notes:
Notes
~~~~~
* Lorem ipsum dolor sit amet * Lorem ipsum dolor sit amet

2
tests/qapi-schema/doc-interleaved-section.json
View File

@ -10,7 +10,7 @@
# #
# bao # bao
# #
# Note: a section. # TODO: a section.
# #
# @foobar: catch this # @foobar: catch this
# #