mirrors/qemu
0
0
Fork 0
mirror of https://github.com/qemu/qemu.git synced 2024-11-23 10:53:37 +08:00
Code Issues Packages Projects Releases Wiki Activity

qapi: Indent tagged doc comment sections properly

Browse Source 
docs/devel/qapi-code-gen demands that the "second and subsequent lines
of sections other than "Example"/"Examples" should be indented".
Commit a937b6aa73 (qapi: Reformat doc comments to conform to current
conventions) missed a few instances, and a few more have crept in
since.  Indent them.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240120095327.666239-7-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
This commit is contained in:
Markus Armbruster 2024-01-20 10:53:26 +01:00
parent ae7ccd50c3
commit e6ab40fee0
5 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
qapi/char.json
View File

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

24
qapi/machine.json
View File

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

2
qapi/misc-target.json
View File

@ -475,7 +475,7 @@
# @port: The port number
#
# Returns:
# - Nothing on success.
# - Nothing on success.
#
# 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.
#
# Returns:
# - @AddfdInfo on success
# - If file descriptor was not received, GenericError
# - If @fdset-id is a negative value, GenericError
# - @AddfdInfo on success
# - If file descriptor was not received, GenericError
# - If @fdset-id is a negative value, GenericError
#
# 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.
#
# Returns:
# - Nothing on success
# - If @fdset-id or @fd is not found, GenericError
# - Nothing on success
# - If @fdset-id or @fd is not found, GenericError
#
# Since: 1.2
#

4
qapi/yank.json
View File

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