[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 31/47] qapi-schema: Improve section headings
From: |
Markus Armbruster |
Subject: |
[Qemu-devel] [PULL 31/47] qapi-schema: Improve section headings |
Date: |
Fri, 1 Sep 2017 14:55:55 +0200 |
The generated QEMU QMP reference is now structured as follows:
1.1 Introduction
1.2 Stability Considerations
1.3 Common data types
1.4 Socket data types
1.5 VM run state
1.6 Cryptography
1.7 Block devices
1.7.1 Block core (VM unrelated)
1.7.2 QAPI block definitions (vm unrelated)
1.8 Character devices
1.9 Net devices
1.10 Rocker switch device
1.11 TPM (trusted platform module) devices
1.12 Remote desktop
1.12.1 Spice
1.12.2 VNC
1.13 Input
1.14 Migration
1.15 Transactions
1.16 Tracing
1.17 QMP introspection
1.18 Miscellanea
Section "1.18 Miscellanea" is still too big: it documents 134 symbols.
Section "1.7.1 Block core (VM unrelated)" is also rather big: 128
symbols. All the others are of reasonable size.
Signed-off-by: Markus Armbruster <address@hidden>
Message-Id: <address@hidden>
Reviewed-by: Marc-André Lureau <address@hidden>
---
qapi-schema.json | 2 +-
qapi/block-core.json | 2 +-
qapi/block.json | 5 ++---
qapi/common.json | 2 +-
qapi/crypto.json | 2 +-
qapi/trace.json | 2 +-
6 files changed, 7 insertions(+), 8 deletions(-)
diff --git a/qapi-schema.json b/qapi-schema.json
index 7a393ec3e9..f3af2cb851 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -94,7 +94,7 @@
{ 'include': 'qapi/introspect.json' }
##
-# = QMP commands
+# = Miscellanea
##
##
diff --git a/qapi/block-core.json b/qapi/block-core.json
index f4caa5c21b..28abb9e6cf 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -1,7 +1,7 @@
# -*- Mode: Python -*-
##
-# == QAPI block core definitions (vm unrelated)
+# == Block core (VM unrelated)
##
{ 'include': 'common.json' }
diff --git a/qapi/block.json b/qapi/block.json
index 8ce335739f..f093fa3f27 100644
--- a/qapi/block.json
+++ b/qapi/block.json
@@ -1,14 +1,13 @@
# -*- Mode: Python -*-
##
-# = QAPI block definitions
+# = Block devices
##
-# QAPI block core definitions
{ 'include': 'block-core.json' }
##
-# == QAPI block definitions (vm unrelated)
+# == Additional block stuff (VM related)
##
##
diff --git a/qapi/common.json b/qapi/common.json
index 0c67e4acf5..6eb01821ef 100644
--- a/qapi/common.json
+++ b/qapi/common.json
@@ -1,7 +1,7 @@
# -*- Mode: Python -*-
##
-# = QAPI common definitions
+# = Common data types
##
##
diff --git a/qapi/crypto.json b/qapi/crypto.json
index 6b6fde367a..288bc056ef 100644
--- a/qapi/crypto.json
+++ b/qapi/crypto.json
@@ -2,7 +2,7 @@
#
##
-# = QAPI crypto definitions
+# = Cryptography
##
##
diff --git a/qapi/trace.json b/qapi/trace.json
index de6588d9f7..799b254a18 100644
--- a/qapi/trace.json
+++ b/qapi/trace.json
@@ -6,7 +6,7 @@
# See the COPYING file in the top-level directory.
##
-# = Tracing commands
+# = Tracing
##
##
--
2.13.5
- [Qemu-devel] [PULL 16/47] qapi-schema: Document how generated documentation is ordered, (continued)
- [Qemu-devel] [PULL 16/47] qapi-schema: Document how generated documentation is ordered, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 14/47] qlit: Tighten QLit dict vs QDict comparison, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 01/47] qapi: Fix error handling code on alternate conflict, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 03/47] qobject: Explain how QNum works, and why, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 13/47] tests/check-qlit: New, covering qobject/qlit.c, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 05/47] qlit: move qlit from check-qjson to qobject/, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 17/47] qapi-schema: Introspection doc is in the wrong section, fix, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 10/47] qlit: make qlit_equal_qobject() take const arguments, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 29/47] qapi-schema: Make block-core.json self-contained, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 07/47] qlit: Change compound literals to initializers, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 31/47] qapi-schema: Improve section headings,
Markus Armbruster <=
- [Qemu-devel] [PULL 41/47] qapi: Use qapi_enum_parse() in input_type_enum(), Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 06/47] qlit: use QLit prefix consistently, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 32/47] qapi: Update qapi-code-gen.txt examples to match current code, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 26/47] qapi-schema: Collect TPM stuff in qapi/tpm.json, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 18/47] qapi-schema: Rocker doc section contains unrelated stuff, fix, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 02/47] tests/qmp-test: Add generic, basic test of query commands, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 33/47] qapi: Drop superfluous qapi_enum_parse() parameter max, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 27/47] qapi-schema: Move block events from event.json to block.json, Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 37/47] hmp: Use qapi_enum_parse() in hmp_migrate_set_parameter(), Markus Armbruster, 2017/09/01
- [Qemu-devel] [PULL 12/47] qlit: Replace open-coded qnum_get_int() by call, Markus Armbruster, 2017/09/01