[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 06/36] qapi: move documentation bits in schema files
From: |
marcandre . lureau |
Subject: |
[Qemu-devel] [PATCH 06/36] qapi: move documentation bits in schema files |
Date: |
Fri, 25 Sep 2015 16:03:34 +0200 |
From: Marc-André Lureau <address@hidden>
Moving the remaining bits of documentation to the schema files.
Signed-off-by: Marc-André Lureau <address@hidden>
---
qapi-schema.json | 48 ++++++++++++++++++++++++++++++++++++++++++-
qmp-commands.hx | 62 --------------------------------------------------------
2 files changed, 47 insertions(+), 63 deletions(-)
diff --git a/qapi-schema.json b/qapi-schema.json
index 1383011..c8ee75d 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -1,6 +1,52 @@
# -*- Mode: Python -*-
+##
+# = Introduction
+#
+# This document describes all commands currently supported by QMP.
+#
+# Most of the time their usage is exactly the same as in the user Monitor, this
+# means that any other document which also describe commands (the manpage,
+# QEMU's manual, etc) can and should be consulted.
+#
+# QMP has two types of commands: regular and query commands. Regular commands
+# usually change the Virtual Machine's state someway, while query commands just
+# return information. The sections below are divided accordingly.
+#
+# It's important to observe that all communication examples are formatted in
+# a reader-friendly way, so that they're easier to understand. However, in real
+# protocol usage, they're emitted as a single line.
+#
+# Also, the following notation is used to denote data flow:
+#
+# Example:
+#
+# | -> data issued by the Client
+# | <- Server data response
+#
+# Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
+# information on the Server command and response formats.
+#
+# = Stability Considerations
+#
+# The current QMP command set (described in this file) may be useful for a
+# number of use cases, however it's limited and several commands have bad
+# defined semantics, specially with regard to command completion.
+#
+# These problems are going to be solved incrementally in the next QEMU releases
+# and we're going to establish a deprecation policy for badly defined commands.
+#
+# If you're planning to adopt QMP, please observe the following:
+#
+# 1. The deprecation policy will take effect and be documented soon, please
+# check the documentation of each used command as soon as a new release
of
+# QEMU is available
+#
+# 2. DO NOT rely on anything which is not explicit documented
+#
+# 3. Errors, in special, are not documented. Applications should NOT check
+# for specific errors classes or data (it's strongly recommended to only
+# check for the "error" key)
#
-# QAPI Schema
# QAPI common definitions
{ 'include': 'qapi/common.json' }
diff --git a/qmp-commands.hx b/qmp-commands.hx
index c09918b..3a7af18 100644
--- a/qmp-commands.hx
+++ b/qmp-commands.hx
@@ -1,65 +1,3 @@
-HXCOMM QMP dispatch table and documentation
-HXCOMM Text between SQMP and EQMP is copied to the QMP documentation file and
-HXCOMM does not show up in the other formats.
-
-SQMP
- QMP Supported Commands
- ----------------------
-
-This document describes all commands currently supported by QMP.
-
-Most of the time their usage is exactly the same as in the user Monitor, this
-means that any other document which also describe commands (the manpage,
-QEMU's manual, etc) can and should be consulted.
-
-QMP has two types of commands: regular and query commands. Regular commands
-usually change the Virtual Machine's state someway, while query commands just
-return information. The sections below are divided accordingly.
-
-It's important to observe that all communication examples are formatted in
-a reader-friendly way, so that they're easier to understand. However, in real
-protocol usage, they're emitted as a single line.
-
-Also, the following notation is used to denote data flow:
-
--> data issued by the Client
-<- Server data response
-
-Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
-information on the Server command and response formats.
-
-NOTE: This document is temporary and will be replaced soon.
-
-1. Stability Considerations
-===========================
-
-The current QMP command set (described in this file) may be useful for a
-number of use cases, however it's limited and several commands have bad
-defined semantics, specially with regard to command completion.
-
-These problems are going to be solved incrementally in the next QEMU releases
-and we're going to establish a deprecation policy for badly defined commands.
-
-If you're planning to adopt QMP, please observe the following:
-
- 1. The deprecation policy will take effect and be documented soon, please
- check the documentation of each used command as soon as a new release of
- QEMU is available
-
- 2. DO NOT rely on anything which is not explicit documented
-
- 3. Errors, in special, are not documented. Applications should NOT check
- for specific errors classes or data (it's strongly recommended to only
- check for the "error" key)
-
-2. Regular Commands
-===================
-
-Server's responses in the examples below are always a success response, please
-refer to the QMP specification for more details on error responses.
-
-EQMP
-
{
.name = "quit",
.args_type = "",
--
2.4.3
- [Qemu-devel] [PATCH 00/36] post-Eric's fixes, QAPI improvements, marcandre . lureau, 2015/09/25
- [Qemu-devel] [PATCH 04/36] monitor: use qapi for qmp_capabilities command, marcandre . lureau, 2015/09/25
- [Qemu-devel] [PATCH 07/36] qapi: add some headings in docs, marcandre . lureau, 2015/09/25
- [Qemu-devel] [PATCH 10/36] texi2pod: learn quotation, deftp and deftypefn, marcandre . lureau, 2015/09/25
- [Qemu-devel] [PATCH 08/36] qapi: add qapi2texi script, marcandre . lureau, 2015/09/25