aboutsummaryrefslogtreecommitdiff
path: root/docs/writing-qmp-commands.txt
diff options
context:
space:
mode:
authorMarc-André Lureau <marcandre.lureau@redhat.com>2016-09-12 13:19:13 +0400
committerMarkus Armbruster <armbru@redhat.com>2016-09-19 18:27:37 +0200
commitbd6092e407a5d682fbfddcbc510038b84bc1a1aa (patch)
treec9c9622f50970b8d8600b516ebe6a390b17f5acf /docs/writing-qmp-commands.txt
parentbdf05133233faa11899738d5c90c7b78d145682b (diff)
downloadqemu-bd6092e407a5d682fbfddcbc510038b84bc1a1aa.zip
qemu-bd6092e407a5d682fbfddcbc510038b84bc1a1aa.tar.gz
qemu-bd6092e407a5d682fbfddcbc510038b84bc1a1aa.tar.bz2
Replace qmp-commands.hx by docs/qmp-commands.txt
The only remaining function of qmp-commands.hx is to let us generate qmp-commands.txt from it. Replace qmp-commands.hx by qmp-commands.txt. We intend to move the documentation into the QAPI schema and generate qapi-commands.txt from it, but not right now. Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Message-Id: <20160912091913.15831-19-marcandre.lureau@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'docs/writing-qmp-commands.txt')
-rw-r--r--docs/writing-qmp-commands.txt38
1 files changed, 0 insertions, 38 deletions
diff --git a/docs/writing-qmp-commands.txt b/docs/writing-qmp-commands.txt
index c425393..cfa6fe7 100644
--- a/docs/writing-qmp-commands.txt
+++ b/docs/writing-qmp-commands.txt
@@ -119,16 +119,6 @@ There are a few things to be noticed:
5. Printing to the terminal is discouraged for QMP commands, we do it here
because it's the easiest way to demonstrate a QMP command
-Now a little hack is needed. As we're still using the old QMP server we need
-to add the new command to its internal dispatch table. This step won't be
-required in the near future. Open the qmp-commands.hx file and add the
-following at the bottom:
-
- {
- .name = "hello-world",
- .args_type = "",
- },
-
You're done. Now build qemu, run it as suggested in the "Testing" section,
and then type the following QMP command:
@@ -173,20 +163,6 @@ There are two important details to be noticed:
2. The C implementation signature must follow the schema's argument ordering,
which is defined by the "data" member
-The last step is to update the qmp-commands.hx file:
-
- {
- .name = "hello-world",
- .args_type = "message:s?",
- },
-
-Notice that the "args_type" member got our "message" argument. The character
-"s" stands for "string" and "?" means it's optional. This too must be ordered
-according to the C implementation and schema file. You can look for more
-examples in the qmp-commands.hx file if you need to define more arguments.
-
-Again, this step won't be required in the future.
-
Time to test our new version of the "hello-world" command. Build qemu, run it as
described in the "Testing" section and then send two commands:
@@ -452,13 +428,6 @@ There are a number of things to be noticed:
6. You have to include the "qmp-commands.h" header file in qemu-timer.c,
otherwise qemu won't build
-The last step is to add the corresponding entry in the qmp-commands.hx file:
-
- {
- .name = "query-alarm-clock",
- .args_type = "",
- },
-
Time to test the new command. Build qemu, run it as described in the "Testing"
section and try this:
@@ -597,13 +566,6 @@ iteration of the loop. That's because the alarm timer method in use is the
first element of the alarm_timers array. Also notice that QAPI lists are handled
by hand and we return the head of the list.
-To test this you have to add the corresponding qmp-commands.hx entry:
-
- {
- .name = "query-alarm-methods",
- .args_type = "",
- },
-
Now Build qemu, run it as explained in the "Testing" section and try our new
command: