[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH v6 04/17] qapi: add some sections in docs
From: |
Marc-André Lureau |
Subject: |
[Qemu-devel] [PATCH v6 04/17] qapi: add some sections in docs |
Date: |
Tue, 6 Dec 2016 17:13:30 +0300 |
Add some more section titles to organize the documentation we're going
to generate.
Signed-off-by: Marc-André Lureau <address@hidden>
Reviewed-by: Markus Armbruster <address@hidden>
---
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 e29d47ded3..fbea3b18d9 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 ec1da2a29a..05cedc3f23 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 937df05830..e4ad74bcb2 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 15d296e3c1..1e517b0841 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 37bf34ed6d..683666848a 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:
--
2.11.0
- [Qemu-devel] [PATCH v6 00/17] qapi doc generation (whole version, squashed), Marc-André Lureau, 2016/12/06
- [Qemu-devel] [PATCH v6 01/17] qapi: improve device_add schema, Marc-André Lureau, 2016/12/06
- [Qemu-devel] [PATCH v6 02/17] qapi: improve TransactionAction doc, Marc-André Lureau, 2016/12/06
- [Qemu-devel] [PATCH v6 03/17] qga/schema: improve guest-set-vcpus Returns: section, Marc-André Lureau, 2016/12/06
- [Qemu-devel] [PATCH v6 04/17] qapi: add some sections in docs,
Marc-André Lureau <=
- [Qemu-devel] [PATCH v6 05/17] docs: add master qapi texi files, Marc-André Lureau, 2016/12/06
- [Qemu-devel] [PATCH v6 06/17] qapi: rework qapi Exception, Marc-André Lureau, 2016/12/06
- [Qemu-devel] [PATCH v6 07/17] qapi: use a QAPIParseError in parser, Marc-André Lureau, 2016/12/06
- [Qemu-devel] [PATCH v6 09/17] texi2pod: learn quotation, deftp and deftypefn, Marc-André Lureau, 2016/12/06
- [Qemu-devel] [PATCH v6 10/17] json: reorder documentation body, Marc-André Lureau, 2016/12/06