qapi: add some sections in docs

Add some more section titles to organize the documentation we're going
to generate.

Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-Id: <20170113144135.5150-10-marcandre.lureau@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>

diff --git a/qapi-schema.json b/qapi-schema.json
index a1ceb71bbbf095c707a64fc15f77e17e23b87ed0..8744b1b774f666bbc57df180b0895faf12dc9c1c 100644 (file)
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -20,6 +20,10 @@
 # QAPI introspection
 { 'include': 'qapi/introspect.json' }
 
+##
+# = QMP commands
+##
+
 ##
 # @qmp_capabilities:
 #

diff --git a/qapi/block-core.json b/qapi/block-core.json
index fb5034c3a97031b71d1bea5713fc623131ead65e..7f7f10bb49aeacff19cccae7530d4d62b265c6fd 100644 (file)
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -1,6 +1,8 @@
 # -*- Mode: Python -*-
-#
-# QAPI block core definitions (vm unrelated)
+
+##
+# == QAPI block core definitions (vm unrelated)
+##
 
 # QAPI common definitions
 { 'include': 'common.json' }

diff --git a/qapi/block.json b/qapi/block.json
index 8e9f59019a1b53f76ae3284049fae8d26ccdb4ac..693e2347799dc5b87a7d444278d2c8784f74f3ea 100644 (file)
--- a/qapi/block.json
+++ b/qapi/block.json
@@ -1,10 +1,16 @@
 # -*- Mode: Python -*-
-#
-# QAPI block definitions (vm related)
+
+##
+# = QAPI block definitions
+##
 
 # QAPI block core definitions
 { 'include': 'block-core.json' }
 
+##
+# == QAPI block definitions (vm unrelated)
+##
+
 ##
 # @BiosAtaTranslation:
 #

diff --git a/qapi/common.json b/qapi/common.json
index 624a8619c8ebfd52200d2f9a7e57a1860ea81af0..d93f15994630c3453a5de70e9a764f675c0f3427 100644 (file)
--- a/qapi/common.json
+++ b/qapi/common.json
@@ -1,6 +1,8 @@
 # -*- Mode: Python -*-
-#
-# QAPI common definitions
+
+##
+# = QAPI common definitions
+##
 
 ##
 # @QapiErrorClass:

diff --git a/qapi/crypto.json b/qapi/crypto.json
index f4fd93b8139dfb7b213406d72d01208f63c8f847..93a04743ea2f7fcb14109b5ef11b1da100f3ca4e 100644 (file)
--- a/qapi/crypto.json
+++ b/qapi/crypto.json
@@ -1,6 +1,9 @@
 # -*- Mode: Python -*-
 #
-# QAPI crypto definitions
+
+##
+# = QAPI crypto definitions
+##
 
 ##
 # @QCryptoTLSCredsEndpoint:

diff --git a/qapi/event.json b/qapi/event.json
index c7689b211d8edac8a3ce9ffc53c52936636cf1d4..0cd4b79ad8d7943ab774d479cf56c78c83b6d420 100644 (file)
--- a/qapi/event.json
+++ b/qapi/event.json
@@ -1,3 +1,9 @@
+# -*- Mode: Python -*-
+
+##
+# = Other events
+##
+
 ##
 # @SHUTDOWN:
 #

diff --git a/qapi/rocker.json b/qapi/rocker.json
index ace27760f1d621935b84d7316d7bcf5d7289c49b..1e511cd37a1131386e584d4058ff3e66754be20a 100644 (file)
--- a/qapi/rocker.json
+++ b/qapi/rocker.json
@@ -1,3 +1,7 @@
+##
+# = Rocker switch device
+##
+
 ##
 # @RockerSwitch:
 #

diff --git a/qapi/trace.json b/qapi/trace.json
index 4fd39b77925a00638c77f71b6b11e2bc684163af..3ad7df7fdb35d42cbf45445fb70292498442ddb8 100644 (file)
--- a/qapi/trace.json
+++ b/qapi/trace.json
@@ -5,6 +5,9 @@
 # This work is licensed under the terms of the GNU GPL, version 2 or later.
 # See the COPYING file in the top-level directory.
 
+##
+# = Tracing commands
+##
 
 ##
 # @TraceEventState: