mirrors/qemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

qapi: Add blank lines before bulleted lists

Browse Source 
We would like to switch the doc comments to rST format. rST
insists on a blank line before and after a bulleted list, but our
Texinfo doc generator did not. Add some extra blank lines in the doc
comments so they're acceptable rST input.

Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Message-Id: <20200213175647.17628-17-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
This commit is contained in:
Peter Maydell 2020-02-13 17:56:33 +00:00 committed by Markus Armbruster
parent e050e42678
commit 100cc4fe0f
4 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
qapi/block-core.json
View File

@ -4757,6 +4757,7 @@
# #
# Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in # Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
# which no such event will be generated, these include: # which no such event will be generated, these include:
#
# - if the guest has locked the tray, @force is false and the guest does not # - if the guest has locked the tray, @force is false and the guest does not
# respond to the eject request # respond to the eject request
# - if the BlockBackend denoted by @device does not have a guest device attached # - if the BlockBackend denoted by @device does not have a guest device attached

2
qapi/char.json
View File

@ -133,6 +133,7 @@
# @data: data to write # @data: data to write
# #
# @format: data encoding (default 'utf8'). # @format: data encoding (default 'utf8').
#
# - base64: data must be base64 encoded text. Its binary # - base64: data must be base64 encoded text. Its binary
# decoding gets written. # decoding gets written.
# - utf8: data's UTF-8 encoding is written # - utf8: data's UTF-8 encoding is written
@ -167,6 +168,7 @@
# @size: how many bytes to read at most # @size: how many bytes to read at most
# #
# @format: data encoding (default 'utf8'). # @format: data encoding (default 'utf8').
#
# - base64: the data read is returned in base64 encoding. # - base64: the data read is returned in base64 encoding.
# - utf8: the data read is interpreted as UTF-8. # - utf8: the data read is interpreted as UTF-8.
# Bug: can screw up when the buffer contains invalid UTF-8 # Bug: can screw up when the buffer contains invalid UTF-8

1
qapi/trace.json
View File

@ -53,6 +53,7 @@
# Returns: a list of @TraceEventInfo for the matching events # Returns: a list of @TraceEventInfo for the matching events
# #
# An event is returned if: # An event is returned if:
#
# - its name matches the @name pattern, and # - its name matches the @name pattern, and
# - if @vcpu is given, the event has the "vcpu" property. # - if @vcpu is given, the event has the "vcpu" property.
# #

1
qapi/ui.json
View File

@ -934,6 +934,7 @@
# Input event union. # Input event union.
# #
# @type: the input type, one of: # @type: the input type, one of:
#
# - 'key': Input event of Keyboard # - 'key': Input event of Keyboard
# - 'btn': Input event of pointer buttons # - 'btn': Input event of pointer buttons
# - 'rel': Input event of relative pointer motion # - 'rel': Input event of relative pointer motion