[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v2 16/30] qapi: Add blank lines before bulleted lists
From: |
Peter Maydell |
Subject: |
[PATCH v2 16/30] qapi: Add blank lines before bulleted lists |
Date: |
Thu, 13 Feb 2020 17:56:33 +0000 |
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 <address@hidden>
Reviewed-by: Philippe Mathieu-Daudé <address@hidden>
---
qapi/block-core.json | 1 +
qapi/char.json | 2 ++
qapi/trace.json | 1 +
qapi/ui.json | 1 +
4 files changed, 5 insertions(+)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 082aca3f699..13dad62f441 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 8a9f1e75097..6907b2bfdba 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 4955e5a7503..47c68f04da7 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 e4bd3d8ea76..89126da395b 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
--
2.20.1
- Re: [PATCH v2 06/30] qga/qapi-schema.json: minor format fixups for rST, (continued)
- [PATCH v2 08/30] qapi: Use ':' after @argument in doc comments, Peter Maydell, 2020/02/13
- [PATCH v2 11/30] qapi/ui.json: Put input-send-event body text in the right place, Peter Maydell, 2020/02/13
- [PATCH v2 12/30] qapi/ui.json: Avoid `...' texinfo style quoting, Peter Maydell, 2020/02/13
- [PATCH v2 13/30] qapi/block-core.json: Use explicit bulleted lists, Peter Maydell, 2020/02/13
- [PATCH v2 14/30] qapi/ui.json: Use explicit bulleted lists, Peter Maydell, 2020/02/13
- [PATCH v2 16/30] qapi: Add blank lines before bulleted lists,
Peter Maydell <=
[PATCH v2 18/30] qapi: Delete all the "foo: dropped in n.n" notes, Peter Maydell, 2020/02/13
[PATCH v2 15/30] qapi/{block, misc, tmp, net}.json: Use explicit bulleted lists, Peter Maydell, 2020/02/13