| Message ID | 20200810195019.25427-4-peter.maydell@linaro.org |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Convert QAPI doc comments to generate rST instead of texinfo | expand |
On 8/10/20 12:50 PM, Peter Maydell wrote: > 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> > --- > qapi/block-core.json | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) Reviewed-by: Richard Henderson <richard.henderson@linaro.org> r~
diff --git a/qapi/block-core.json b/qapi/block-core.json index f04bb3f0dd5..535b2b2e7bf 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -5206,6 +5206,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 @@ -5216,9 +5219,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',
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> --- qapi/block-core.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) -- 2.20.1