From: Marc-André Lureau <marcandre.lur...@redhat.com>
Add some missing double-#, the doc parser can't easily distinguish doc
comments from comments to be ignored otherwise.
Also add some more section headings.
Signed-off-by: Marc-André Lureau <marcandre.lur...@redhat.com>
---
qapi-schema.json | 12 ++++++++++--
qapi/block-core.json | 6 ++++--
qapi/block.json | 5 +++--
qapi/common.json | 5 +++--
qapi/event.json | 5 +++++
qapi/rocker.json | 3 +++
qapi/trace.json | 2 ++
qga/qapi-schema.json | 2 ++
8 files changed, 32 insertions(+), 8 deletions(-)
diff --git a/qapi-schema.json b/qapi-schema.json
index c8ee75d..b01de49 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -67,6 +67,9 @@
{ 'include': 'qapi/introspect.json' }
##
+# = QMP commands
+
+##
# @qmp_capabilities:
#
# Enable QMP capabilities.
@@ -107,6 +110,7 @@
{ 'enum': 'LostTickPolicy',
'data': ['discard', 'delay', 'merge', 'slew' ] }
+##
# @add_client
#
# Allow client connections for VNC, Spice and socket based
@@ -590,6 +594,7 @@
'cache-miss': 'int', 'cache-miss-rate': 'number',
'overflow': 'int' } }
+##
# @MigrationStatus:
#
# An enumeration of migration status.
@@ -880,6 +885,7 @@
##
{ 'command': 'query-migrate-capabilities', 'returns':
['MigrationCapabilityStatus']}
+##
# @MigrationParameter
#
# Migration parameters enumeration
@@ -903,7 +909,7 @@
{ 'enum': 'MigrationParameter',
'data': ['compress-level', 'compress-threads', 'decompress-threads'] }
-#
+##
# @migrate-set-parameters
#
# Set the following migration parameters
@@ -927,7 +933,7 @@
'*compress-threads': 'int',
'*decompress-threads': 'int'} }
-#
+##
# @MigrationParameters
#
# @compress-level: compression level
@@ -2748,6 +2754,7 @@
##
{ 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
+##
# @xen-save-devices-state:
#
# Save the state of all devices to file. The RAM and the block devices
@@ -3639,6 +3646,7 @@
##
{ 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
+##
# @AddfdInfo:
#
# Information about a file descriptor that was added to an fd set.
diff --git a/qapi/block-core.json b/qapi/block-core.json
index d5b6ed1..ff2d4a6 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -1,6 +1,7 @@
# -*- Mode: Python -*-
-#
-# QAPI block core definitions (vm unrelated)
+
+##
+# == QAPI block core definitions (vm unrelated)
# QAPI common definitions
{ 'include': 'common.json' }
@@ -2440,6 +2441,7 @@
'offset': 'int',
'speed' : 'int' } }
+##
# @PreallocMode
#
# Preallocation mode of QEMU image file
diff --git a/qapi/block.json b/qapi/block.json
index 9902b94..487abb2 100644
--- a/qapi/block.json
+++ b/qapi/block.json
@@ -1,6 +1,7 @@
# -*- Mode: Python -*-
-#
-# QAPI block definitions (vm related)
+
+##
+# = QAPI block definitions (vm related)
# QAPI block core definitions
{ 'include': 'block-core.json' }
diff --git a/qapi/common.json b/qapi/common.json
index 4e94c89..0972f4a 100644
--- a/qapi/common.json
+++ b/qapi/common.json
@@ -1,6 +1,7 @@
# -*- Mode: Python -*-
-#
-# QAPI common definitions
+
+##
+# = QAPI common definitions
##
# @ErrorClass
diff --git a/qapi/event.json b/qapi/event.json
index f0cef01..ce5853d 100644
--- a/qapi/event.json
+++ b/qapi/event.json
@@ -1,3 +1,8 @@
+# -*- Mode: Python -*-
+
+##
+# = Events
+
##
# @SHUTDOWN
#
diff --git a/qapi/rocker.json b/qapi/rocker.json
index 7cfccc4..fe17d36 100644
--- a/qapi/rocker.json
+++ b/qapi/rocker.json
@@ -1,4 +1,7 @@
##
+# = Rocker API
+
+##
# @Rocker:
#
# Rocker switch information.
diff --git a/qapi/trace.json b/qapi/trace.json
index 5111640..4faa6d3 100644
--- a/qapi/trace.json
+++ b/qapi/trace.json
@@ -5,6 +5,8 @@
# 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:
diff --git a/qga/qapi-schema.json b/qga/qapi-schema.json
index 82894c6..c138a41 100644
--- a/qga/qapi-schema.json
+++ b/qga/qapi-schema.json
@@ -808,6 +808,7 @@
{ 'command': 'guest-set-user-password',
'data': { 'username': 'str', 'password': 'str', 'crypted': 'bool' } }
+##
# @GuestMemoryBlock:
#
# @phys-index: Arbitrary guest-specific unique identifier of the MEMORY BLOCK.
@@ -907,6 +908,7 @@
'data': {'mem-blks': ['GuestMemoryBlock'] },
'returns': ['GuestMemoryBlockResponse'] }
+##
# @GuestMemoryBlockInfo:
#
# @size: the size (in bytes) of the guest memory blocks,
--
2.4.3
