[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 5/5] qapi/block-core.json: Fix nbd-server-start docs
From: |
Markus Armbruster |
Subject: |
[PULL 5/5] qapi/block-core.json: Fix nbd-server-start docs |
Date: |
Tue, 8 Sep 2020 08:54:17 +0200 |
From: Peter Maydell <peter.maydell@linaro.org>
Commit eed8b6917832 added some new text to the nbd-server-start
documentation in the wrong place. Since this is after the 'Returns:'
line it's parsed as if it were part of the documentation of the
"Returns:' information. Move it up to join the rest of the
"documentation of the type as a whole" doc text.
This doesn't look odd in the current HTML rendering, but the
new QAPI-to-rST handling will complain about the indent level
of the lines not matching up with the 'Returns:' line.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200810195019.25427-4-peter.maydell@linaro.org>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/block-core.json | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 091f826f53..c5ac22d246 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -5211,6 +5211,9 @@
# server will present them as named exports; for example, another
# QEMU instance could refer to them as "nbd:HOST:PORT:exportname=NAME".
#
+# Keep this type consistent with the NbdServerOptions type. The only intended
+# difference is using SocketAddressLegacy instead of SocketAddress.
+#
# @addr: Address on which to listen.
# @tls-creds: ID of the TLS credentials object (since 2.6).
# @tls-authz: ID of the QAuthZ authorization object used to validate
@@ -5221,9 +5224,6 @@
#
# Returns: error if the server is already running.
#
-# Keep this type consistent with the NbdServerOptions type. The only intended
-# difference is using SocketAddressLegacy instead of SocketAddress.
-#
# Since: 1.3.0
##
{ 'command': 'nbd-server-start',
--
2.26.2
- [PULL 0/5] QAPI patches patches for 2020-09-08, Markus Armbruster, 2020/09/08
- [PULL 3/5] qapi/migration.json: Fix indentation, Markus Armbruster, 2020/09/08
- [PULL 5/5] qapi/block-core.json: Fix nbd-server-start docs,
Markus Armbruster <=
- [PULL 1/5] qapi: Reject section markup in definition documentation, Markus Armbruster, 2020/09/08
- [PULL 4/5] qapi: Fix indentation, again, Markus Armbruster, 2020/09/08
- [PULL 2/5] qapi: Make section headings start a new doc comment block, Markus Armbruster, 2020/09/08
- Re: [PULL 0/5] QAPI patches patches for 2020-09-08, Peter Maydell, 2020/09/08