summary refs log tree commit diff stats
path: root/docs/writing-qmp-commands.txt
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2014-10-06 16:19:07 +0200
committerPaolo Bonzini <pbonzini@redhat.com>2014-10-27 16:11:45 +0100
commite218052f9288609bb8c53b31cae3bed7d7516728 (patch)
tree2dc27f6e4f4cd4e38562fbeca90fafbea72c54e3 /docs/writing-qmp-commands.txt
parent024d9adc79651f8fd96078461a7e4dfb8bb83e16 (diff)
downloadfocaccia-qemu-e218052f9288609bb8c53b31cae3bed7d7516728.tar.gz
focaccia-qemu-e218052f9288609bb8c53b31cae3bed7d7516728.zip
aio / timers: De-document -clock
Commit 6d32717 "aio / timers: Remove alarm timers" has issues:

1. It silently ignores -clock for backward compatibility.
Incompatible change: -clock help no longer terminates the program.
Tolerable.

2. Failed to update option documentation.  In particular, -help still
advises users to try -clock help for available timers.  Drop all
documentation on -clock.

3. The 'query-alarm-clock' example in docs/writing-commands.txt no
longer works, and needs to be redone.  Can't do that right now, so I
just stick in a FIXME.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'docs/writing-qmp-commands.txt')
-rw-r--r--docs/writing-qmp-commands.txt2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/writing-qmp-commands.txt b/docs/writing-qmp-commands.txt
index 4d86c2477b..f3df2066a4 100644
--- a/docs/writing-qmp-commands.txt
+++ b/docs/writing-qmp-commands.txt
@@ -365,6 +365,8 @@ documentation for information about the other types.
 
 === User Defined Types ===
 
+FIXME This example needs to be redone after commit 6d32717
+
 For this example we will write the query-alarm-clock command, which returns
 information about QEMU's timer alarm. For more information about it, please
 check the "-clock" command-line option.