[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v6 11/21] qga/qapi-schema.json: Add some headings
From: |
Peter Maydell |
Subject: |
[PATCH v6 11/21] qga/qapi-schema.json: Add some headings |
Date: |
Fri, 25 Sep 2020 17:23:06 +0100 |
Add some section headings to the QGA json; this is purely so that we
have some H1 headings, as otherwise each command ends up being
visible in the interop/ manual's table of contents. In an ideal
world there might be a proper 'Introduction' section the way there is
in qapi/qapi-schema.json.
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qga/qapi-schema.json | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index d2ea7446db6..cec98c7e065 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -2,14 +2,16 @@
# vim: filetype=python
##
-#
-# General note concerning the use of guest agent interfaces:
+# = General note concerning the use of guest agent interfaces
#
# "unsupported" is a higher-level error than the errors that individual
# commands might document. The caller should always be prepared to receive
# QERR_UNSUPPORTED, even if the given command doesn't specify it, or doesn't
# document any failure mode at all.
-#
+##
+
+##
+# = QEMU guest agent protocol commands and structs
##
{ 'pragma': { 'doc-required': true } }
--
2.20.1
- Re: [PATCH v6 09/21] docs/interop: Convert qemu-qmp-ref to rST, (continued)
[PATCH v6 05/21] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/09/25
[PATCH v6 07/21] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/09/25
[PATCH v6 11/21] qga/qapi-schema.json: Add some headings,
Peter Maydell <=
[PATCH v6 15/21] tests/qapi-schema: Add test of the rST QAPI doc-comment outputn, Peter Maydell, 2020/09/25
[PATCH v6 14/21] meson.build: Make manuals depend on source to Sphinx extensions, Peter Maydell, 2020/09/25
[PATCH v6 10/21] qapi: Use rST markup for literal blocks, Peter Maydell, 2020/09/25
[PATCH v6 20/21] configure: Drop texinfo requirement, Peter Maydell, 2020/09/25