[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH v7 07/21] qapi: avoid interleaving sections and para
From: |
Marc-André Lureau |
Subject: |
[Qemu-devel] [PATCH v7 07/21] qapi: avoid interleaving sections and parameters |
Date: |
Mon, 9 Jan 2017 15:34:23 +0100 |
Follow documentation guideline, body, parameters then additional
sections.
Signed-off-by: Marc-André Lureau <address@hidden>
---
qapi-schema.json | 10 +++++-----
qapi/event.json | 4 ++--
qapi/introspect.json | 3 +--
3 files changed, 8 insertions(+), 9 deletions(-)
diff --git a/qapi-schema.json b/qapi-schema.json
index ac6352fcf9..10a3506528 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -4729,17 +4729,17 @@
# it should be passed by management with device_add command when
# a CPU is being hotplugged.
#
+# @node-id: #optional NUMA node ID the CPU belongs to
+# @socket-id: #optional socket number within node/board the CPU belongs to
+# @core-id: #optional core number within socket the CPU belongs to
+# @thread-id: #optional thread number within core the CPU belongs to
+#
# Note: currently there are 4 properties that could be present
# but management should be prepared to pass through other
# properties with device_add command to allow for future
# interface extension. This also requires the filed names to be kept in
# sync with the properties passed to -device/device_add.
#
-# @node-id: #optional NUMA node ID the CPU belongs to
-# @socket-id: #optional socket number within node/board the CPU belongs to
-# @core-id: #optional core number within socket the CPU belongs to
-# @thread-id: #optional thread number within core the CPU belongs to
-#
# Since: 2.7
##
{ 'struct': 'CpuInstanceProperties',
diff --git a/qapi/event.json b/qapi/event.json
index 37bf34ed6d..c7689b211d 100644
--- a/qapi/event.json
+++ b/qapi/event.json
@@ -272,9 +272,9 @@
#
# Emitted when guest executes ACPI _OST method.
#
-# Since: 2.1
-#
# @info: ACPIOSTInfo type as described in qapi-schema.json
+#
+# Since: 2.1
##
{ 'event': 'ACPI_DEVICE_OST',
'data': { 'info': 'ACPIOSTInfo' } }
diff --git a/qapi/introspect.json b/qapi/introspect.json
index 464097a235..f6adc439bb 100644
--- a/qapi/introspect.json
+++ b/qapi/introspect.json
@@ -78,14 +78,13 @@
# @SchemaInfo:
#
# @name: the entity's name, inherited from @base.
+# The SchemaInfo is always referenced by this name.
# Commands and events have the name defined in the QAPI schema.
# Unlike command and event names, type names are not part of
# the wire ABI. Consequently, type names are meaningless
# strings here, although they are still guaranteed unique
# regardless of @meta-type.
#
-# All references to other SchemaInfo are by name.
-#
# @meta-type: the entity's meta type, inherited from @base.
#
# Additional members depend on the value of @meta-type.
--
2.11.0
- [Qemu-devel] [PATCH v7 00/21] qapi doc generation (whole version, squashed), Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 03/21] qapi: make TODOs named-sections, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 04/21] qapi: improve device_add schema, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 01/21] qapi: replace 'o' for list items, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 02/21] qapi: move QKeyCode doc body at the top, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 06/21] qga/schema: improve guest-set-vcpus Returns: section, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 05/21] qapi: improve TransactionAction doc, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 07/21] qapi: avoid interleaving sections and parameters,
Marc-André Lureau <=
- [Qemu-devel] [PATCH v7 08/21] qapi: move experimental note down, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 09/21] qapi: add some sections in docs, Marc-André Lureau, 2017/01/09
- [Qemu-devel] [PATCH v7 12/21] qapi.py: fix line break before binary operator pep8, Marc-André Lureau, 2017/01/09