All of lore.kernel.org
 help / color / mirror / Atom feed
* [Qemu-trivial] [PATCH] qmp-shell: add documentation
@ 2015-07-01 18:25 ` John Snow
  0 siblings, 0 replies; 18+ messages in thread
From: John Snow @ 2015-07-01 18:25 UTC (permalink / raw)
  To: qemu-devel; +Cc: qemu-trivial, John Snow, mjt, lcapitulino

I should probably document the changes that were made.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 scripts/qmp/qmp-shell | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/scripts/qmp/qmp-shell b/scripts/qmp/qmp-shell
index 65280d2..fa39bf0 100755
--- a/scripts/qmp/qmp-shell
+++ b/scripts/qmp/qmp-shell
@@ -29,6 +29,41 @@
 # (QEMU) device_add driver=e1000 id=net1
 # {u'return': {}}
 # (QEMU)
+#
+# key=value pairs also support Python or JSON object literal subset notations,
+# without spaces. Dictionaries/objects {} are supported as are arrays [].
+#
+#    example-command arg-name1={'key':'value','obj'={'prop':"value"}}
+#
+# Both JSON and Python formatting should work, including both styles of
+# string literal quotes. Both paradigms of literal values should work,
+# including null/true/false for JSON and None/True/False for Python.
+#
+#
+# Transactions have the following multi-line format:
+#
+#    transaction(
+#    action-name1 [ arg-name1=arg1 ] ... [arg-nameN=argN ]
+#    ...
+#    action-nameN [ arg-name1=arg1 ] ... [arg-nameN=argN ]
+#    )
+#
+# One line transactions are also supported:
+#
+#    transaction( action-name1 ... )
+#
+# For example:
+#
+#     (QEMU) transaction(
+#     TRANS> block-dirty-bitmap-add node=drive0 name=bitmap1
+#     TRANS> block-dirty-bitmap-clear node=drive0 name=bitmap0
+#     TRANS> )
+#     {"return": {}}
+#     (QEMU)
+#
+# Use the -v and -p options to activate the verbose and pretty-print options,
+# which will echo back the properly formatted JSON-compliant QMP that is being
+# sent to QEMU, which is useful for debugging and documentation generation.
 
 import qmp
 import json
-- 
2.1.0



^ permalink raw reply related	[flat|nested] 18+ messages in thread

end of thread, other threads:[~2015-08-05  9:49 UTC | newest]

Thread overview: 18+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2015-07-01 18:25 [Qemu-trivial] [PATCH] qmp-shell: add documentation John Snow
2015-07-01 18:25 ` [Qemu-devel] " John Snow
2015-07-02 15:31 ` [Qemu-trivial] " Luiz Capitulino
2015-07-02 15:31   ` [Qemu-devel] " Luiz Capitulino
2015-07-07 16:33   ` [Qemu-trivial] " John Snow
2015-07-07 16:33     ` John Snow
2015-07-23  7:36     ` [Qemu-trivial] " Markus Armbruster
2015-07-23  7:36       ` Markus Armbruster
2015-07-27  3:30       ` [Qemu-trivial] " John Snow
2015-07-27  3:30         ` John Snow
2015-07-27 21:59         ` [Qemu-trivial] " Eric Blake
2015-07-27 21:59           ` Eric Blake
2015-07-30 14:48       ` [Qemu-trivial] " Luiz Capitulino
2015-07-30 14:48         ` Luiz Capitulino
2015-08-05  9:49         ` [Qemu-trivial] " Markus Armbruster
2015-08-05  9:49           ` Markus Armbruster
2015-07-28  7:51 ` [Qemu-trivial] " Kashyap Chamarthy
2015-07-28  7:51   ` Kashyap Chamarthy

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.