From d3a48372a42c62608c2f773376810e6a9c1851fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Fri, 13 Jan 2017 15:41:23 +0100 Subject: [PATCH] qapi: add some sections in docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add some more section titles to organize the documentation we're going to generate. Signed-off-by: Marc-André Lureau Reviewed-by: Markus Armbruster Message-Id: <20170113144135.5150-10-marcandre.lureau@redhat.com> Signed-off-by: Markus Armbruster --- qapi-schema.json | 4 ++++ qapi/block-core.json | 6 ++++-- qapi/block.json | 10 ++++++++-- qapi/common.json | 6 ++++-- qapi/crypto.json | 5 ++++- qapi/event.json | 6 ++++++ qapi/rocker.json | 4 ++++ qapi/trace.json | 3 +++ 8 files changed, 37 insertions(+), 7 deletions(-) diff --git a/qapi-schema.json b/qapi-schema.json index a1ceb71bbb..8744b1b774 100644 --- 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 fb5034c3a9..7f7f10bb49 100644 --- 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 8e9f59019a..693e234779 100644 --- 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 624a8619c8..d93f159946 100644 --- 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 f4fd93b813..93a04743ea 100644 --- 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 c7689b211d..0cd4b79ad8 100644 --- 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 ace27760f1..1e511cd37a 100644 --- 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 4fd39b7792..3ad7df7fdb 100644 --- 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: