|author||Luiz Capitulino <firstname.lastname@example.org>||2010-08-20 16:42:31 -0300|
|committer||Anthony Liguori <email@example.com>||2010-08-22 17:11:06 -0500|
QMP doc: Add 'Stability Considerations' section
Signed-off-by: Luiz Capitulino <firstname.lastname@example.org> Signed-off-by: Anthony Liguori <email@example.com>
Diffstat (limited to 'qemu-monitor.hx')
1 files changed, 24 insertions, 2 deletions
diff --git a/qemu-monitor.hx b/qemu-monitor.hx
index 9c27b3113..5c1da3398 100644
@@ -35,7 +35,29 @@ information on the Server command and response formats.
NOTE: This document is temporary and will be replaced soon.
-1. Regular Commands
+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 efect 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
@@ -1592,7 +1614,7 @@ HXCOMM This is required for the QMP documentation layout.
-2. Query Commands
+3. Query Commands