[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v3 10/12] qga/qapi-schema.json: Add some headings
From: |
Peter Maydell |
Subject: |
[PATCH v3 10/12] qga/qapi-schema.json: Add some headings |
Date: |
Tue, 25 Feb 2020 14:04:35 +0000 |
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.
Signed-off-by: Peter Maydell <address@hidden>
---
qga/qapi-schema.json | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index f6fcb59f34b..d026f9478cf 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -1,14 +1,18 @@
# *-*- Mode: 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
- [PATCH v3 00/12] Convert QAPI doc comments to generate rST instead of texinfo, Peter Maydell, 2020/02/25
- [PATCH v3 01/12] qapi/qapi-schema.json: Put headers in their own doc-comment blocks, Peter Maydell, 2020/02/25
- [PATCH v3 02/12] qapi/machine.json: Escape a literal '*' in doc comment, Peter Maydell, 2020/02/25
- [PATCH v3 03/12] tests/qapi/doc-good.json: Clean up markup, Peter Maydell, 2020/02/25
- [PATCH v3 04/12] scripts/qapi: Move doc-comment whitespace stripping to doc.py, Peter Maydell, 2020/02/25
- [PATCH v3 05/12] scripts/qapi/parser.py: improve doc comment indent handling, Peter Maydell, 2020/02/25
- [PATCH v3 09/12] qapi: Use rST markup for literal blocks, Peter Maydell, 2020/02/25
- [PATCH v3 06/12] docs/sphinx: Add new qapi-doc Sphinx extension, Peter Maydell, 2020/02/25
- [PATCH v3 07/12] docs/interop: Convert qemu-ga-ref to rST, Peter Maydell, 2020/02/25
- [PATCH v3 10/12] qga/qapi-schema.json: Add some headings,
Peter Maydell <=
- [PATCH v3 08/12] docs/interop: Convert qemu-qmp-ref to rST, Peter Maydell, 2020/02/25
- [PATCH v3 12/12] docs/devel/qapi-code-gen.txt: Update to new rST backend conventions, Peter Maydell, 2020/02/25
- [PATCH v3 11/12] scripts/qapi: Remove texinfo generation support, Peter Maydell, 2020/02/25
- Re: [PATCH v3 00/12] Convert QAPI doc comments to generate rST instead of texinfo, Markus Armbruster, 2020/02/26