From: "Marc-André Lureau" <marcandre.lureau@redhat.com>
To: qemu-devel@nongnu.org
Cc: eblake@redhat.com, armbru@redhat.com,
"Marc-André Lureau" <marcandre.lureau@redhat.com>
Subject: [Qemu-devel] [PATCH v8 09/21] qapi: add some sections in docs
Date: Fri, 13 Jan 2017 15:41:23 +0100 [thread overview]
Message-ID: <20170113144135.5150-10-marcandre.lureau@redhat.com> (raw)
In-Reply-To: <20170113144135.5150-1-marcandre.lureau@redhat.com>
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>
---
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 c1af70057d..54c3e48ba9 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:
--
2.11.0
next prev parent reply other threads:[~2017-01-13 14:41 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-01-13 14:41 [Qemu-devel] [PATCH v8 00/21] qapi doc generation (whole version, squashed) Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 01/21] qapi: replace 'o' for list items Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 02/21] qapi: move QKeyCode doc body at the top Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 03/21] qapi: make TODOs named-sections Marc-André Lureau
2017-01-13 16:03 ` Markus Armbruster
2017-01-13 16:07 ` Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 04/21] qapi: improve device_add schema Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 05/21] qapi: improve TransactionAction doc Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 06/21] qga/schema: improve guest-set-vcpus Returns: section Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 07/21] qapi: avoid interleaving sections and parameters Marc-André Lureau
2017-01-13 16:14 ` Markus Armbruster
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 08/21] qapi: move experimental note down Marc-André Lureau
2017-01-13 16:14 ` Markus Armbruster
2017-01-13 14:41 ` Marc-André Lureau [this message]
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 10/21] docs: add master qapi texi files Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 11/21] qapi: rework qapi Exception Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 12/21] qapi.py: fix line break before binary operator pep8 Marc-André Lureau
2017-01-13 16:15 ` Markus Armbruster
2017-01-13 16:26 ` Marc-André Lureau
2017-01-13 16:46 ` Markus Armbruster
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 13/21] texi2pod: learn quotation, deftp and deftypefn Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 14/21] (SQUASHED) move doc to schema Marc-André Lureau
2017-05-22 21:31 ` Eric Blake
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 15/21] qapi: add qapi2texi script Marc-André Lureau
2017-01-16 9:37 ` Markus Armbruster
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 16/21] docs: add qemu logo to pdf Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 17/21] build-sys: use --no-split for info Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 18/21] build-sys: remove dvi doc generation Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 19/21] build-sys: use a generic TEXI2MAN rule Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 20/21] build-sys: add txt documentation rules Marc-André Lureau
2017-01-13 14:41 ` [Qemu-devel] [PATCH v8 21/21] build-sys: add qapi doc generation targets Marc-André Lureau
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170113144135.5150-10-marcandre.lureau@redhat.com \
--to=marcandre.lureau@redhat.com \
--cc=armbru@redhat.com \
--cc=eblake@redhat.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).