diff options
| author | Marc-André Lureau <marcandre.lureau@redhat.com> | 2017-01-13 15:41:23 +0100 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2017-01-16 09:15:25 +0100 |
| commit | d3a48372a42c62608c2f773376810e6a9c1851fb (patch) | |
| tree | 48858a8b8bcd520545848b9e7cf07232b4f587a1 | |
| parent | 7a305384e85388236a2d6f70a290d5c85f3c7ac0 (diff) | |
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>
| -rw-r--r-- | qapi-schema.json | 4 | ||||
| -rw-r--r-- | qapi/block-core.json | 6 | ||||
| -rw-r--r-- | qapi/block.json | 10 | ||||
| -rw-r--r-- | qapi/common.json | 6 | ||||
| -rw-r--r-- | qapi/crypto.json | 5 | ||||
| -rw-r--r-- | qapi/event.json | 6 | ||||
| -rw-r--r-- | qapi/rocker.json | 4 | ||||
| -rw-r--r-- | 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 @@ -21,6 +21,10 @@ { 'include': 'qapi/introspect.json' } ## +# = QMP commands +## + +## # @qmp_capabilities: # # Enable 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,11 +1,17 @@ # -*- Mode: Python -*- -# -# QAPI block definitions (vm related) + +## +# = QAPI block definitions +## # QAPI block core definitions { 'include': 'block-core.json' } ## +# == QAPI block definitions (vm unrelated) +## + +## # @BiosAtaTranslation: # # Policy that BIOS should use to interpret cylinder/head/sector 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,4 +1,8 @@ ## +# = Rocker switch device +## + +## # @RockerSwitch: # # Rocker switch information. 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: |