[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 16/18] qapi: Add blank lines before bulleted lists
From: |
Markus Armbruster |
Subject: |
[PULL 16/18] qapi: Add blank lines before bulleted lists |
Date: |
Sat, 15 Feb 2020 12:41:31 +0100 |
From: Peter Maydell <address@hidden>
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 <address@hidden>
Reviewed-by: Philippe Mathieu-Daudé <address@hidden>
Message-Id: <address@hidden>
Reviewed-by: Markus Armbruster <address@hidden>
[Commit message tweaked]
Signed-off-by: Markus Armbruster <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 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
--
2.21.1
- [PULL 01/18] qapi: Expand documentation for LostTickPolicy, (continued)
- [PULL 01/18] qapi: Expand documentation for LostTickPolicy, Markus Armbruster, 2020/02/15
- [PULL 06/18] qga/qapi-schema.json: Fix missing '-' in GuestDiskBusType doc comment, Markus Armbruster, 2020/02/15
- [PULL 07/18] qga/qapi-schema.json: Fix indent level on doc comments, Markus Armbruster, 2020/02/15
- [PULL 05/18] Makefile: Fix typo in dependency list for interop manpages, Markus Armbruster, 2020/02/15
- [PULL 13/18] qapi/ui.json: Put input-send-event body text in the right place, Markus Armbruster, 2020/02/15
- [PULL 03/18] configure: Pick sphinx-build-3 when available, Markus Armbruster, 2020/02/15
- [PULL 18/18] qapi: Delete all the "foo: dropped in n.n" notes, Markus Armbruster, 2020/02/15
- [PULL 10/18] qapi: Fix incorrect "Not documented" claims in QMP documentation, Markus Armbruster, 2020/02/15
- [PULL 14/18] qapi/ui.json: Avoid `...' Texinfo style quoting, Markus Armbruster, 2020/02/15
- [PULL 02/18] configure: Allow user to specify sphinx-build binary, Markus Armbruster, 2020/02/15
- [PULL 16/18] qapi: Add blank lines before bulleted lists,
Markus Armbruster <=
- [PULL 09/18] qapi/block-core.json: Use literal block for ascii art, Markus Armbruster, 2020/02/15
- [PULL 08/18] qga/qapi-schema.json: minor format fixups for rST, Markus Armbruster, 2020/02/15
- [PULL 15/18] qapi: Use explicit bulleted lists, Markus Armbruster, 2020/02/15
- [PULL 17/18] qapi/migration.json: Replace _this_ with *this*, Markus Armbruster, 2020/02/15
- [PULL 12/18] qapi: Remove hardcoded tabs, Markus Armbruster, 2020/02/15
- [PULL 04/18] configure: Check that sphinx-build is using Python 3, Markus Armbruster, 2020/02/15
- [PULL 11/18] qapi: Fix indent level on doc comments in json files, Markus Armbruster, 2020/02/15
- Re: [PULL 00/18] QAPI patches for 2020-02-15, Peter Maydell, 2020/02/17