diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2020-02-13 17:56:33 +0000 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2020-02-15 11:41:50 +0100 |
| commit | 100cc4fe0f0827f8da1a5c05f9c65e2aaa40e03d (patch) | |
| tree | 75db75f3625cd9339078a15ff8ac4d31d7bc88b4 /qapi | |
| parent | e050e426782ec4ae6bf84e5ec75ca502187f69cb (diff) | |
qapi: Add blank lines before bulleted lists
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>
Diffstat (limited to 'qapi')
| -rw-r--r-- | qapi/block-core.json | 1 | ||||
| -rw-r--r-- | qapi/char.json | 2 | ||||
| -rw-r--r-- | qapi/trace.json | 1 | ||||
| -rw-r--r-- | qapi/ui.json | 1 |
4 files changed, 5 insertions, 0 deletions
diff --git a/qapi/block-core.json b/qapi/block-core.json index 082aca3f69..13dad62f44 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -4757,6 +4757,7 @@ # # Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in # which no such event will be generated, these include: +# # - if the guest has locked the tray, @force is false and the guest does not # respond to the eject request # - if the BlockBackend denoted by @device does not have a guest device attached diff --git a/qapi/char.json b/qapi/char.json index 8a9f1e7509..6907b2bfdb 100644 --- a/qapi/char.json +++ b/qapi/char.json @@ -133,6 +133,7 @@ # @data: data to write # # @format: data encoding (default 'utf8'). +# # - base64: data must be base64 encoded text. Its binary # decoding gets written. # - utf8: data's UTF-8 encoding is written @@ -167,6 +168,7 @@ # @size: how many bytes to read at most # # @format: data encoding (default 'utf8'). +# # - base64: the data read is returned in base64 encoding. # - utf8: the data read is interpreted as UTF-8. # Bug: can screw up when the buffer contains invalid UTF-8 diff --git a/qapi/trace.json b/qapi/trace.json index 4955e5a750..47c68f04da 100644 --- a/qapi/trace.json +++ b/qapi/trace.json @@ -53,6 +53,7 @@ # Returns: a list of @TraceEventInfo for the matching events # # An event is returned if: +# # - its name matches the @name pattern, and # - if @vcpu is given, the event has the "vcpu" property. # diff --git a/qapi/ui.json b/qapi/ui.json index e4bd3d8ea7..89126da395 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -934,6 +934,7 @@ # Input event union. # # @type: the input type, one of: +# # - 'key': Input event of Keyboard # - 'btn': Input event of pointer buttons # - 'rel': Input event of relative pointer motion |