diff options
| author | Jan Kiszka <jan.kiszka@siemens.com> | 2010-05-31 14:43:31 -0300 |
|---|---|---|
| committer | Anthony Liguori <aliguori@us.ibm.com> | 2010-06-01 13:48:43 -0500 |
| commit | b40292e7115da8814da3d8acd33267202d27d678 (patch) | |
| tree | 2e123a9a07e8ba2e41f05d2feec31c3d9de91177 /QMP | |
| parent | 33572ece26744889b14b7d72ac81870d076725ac (diff) | |
QMP: Introduce commands documentation
One of the most important missing feature in QMP today is its
supported commands documentation.
The plan is to make it part of self-description support, however
self-description is a big task we have been postponing for a
long time now and still don't know when it's going to be done.
In order not to compromise QMP adoption and make users' life easier,
this commit adds a simple text documentation which fully describes
all QMP supported commands.
This is not ideal for a number of reasons (harder to maintain,
text-only, etc) but does improve the current situation. To avoid at
least divering from the user monitor help and texi snippets, QMP bits
are also maintained inside qemu-monitor.hx, and hxtool is extended to
generate a single text file from them.
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
Diffstat (limited to 'QMP')
| -rw-r--r-- | QMP/README | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/QMP/README b/QMP/README index 9334c25510..35a80c73e4 100644 --- a/QMP/README +++ b/QMP/README @@ -15,8 +15,9 @@ QMP is JSON[1] based and has the following features: For more information, please, refer to the following files: -o qmp-spec.txt QEMU Monitor Protocol current specification -o qmp-events.txt List of available asynchronous events +o qmp-spec.txt QEMU Monitor Protocol current specification +o qmp-commands.txt QMP supported commands +o qmp-events.txt List of available asynchronous events There are also two simple Python scripts available: |