diff mbox

[for-2.2] qmp: document input-send-event detail

Message ID 1416840371-27646-1-git-send-email-akong@redhat.com
State New
Headers show

Commit Message

Amos Kong Nov. 24, 2014, 2:46 p.m. UTC
This patch documents what exactly input-send-event is supposed to do.

Signed-off-by: Amos Kong <akong@redhat.com>
---
 qapi-schema.json | 11 +++++++++++
 1 file changed, 11 insertions(+)

Comments

Markus Armbruster Nov. 24, 2014, 3:39 p.m. UTC | #1
Amos Kong <akong@redhat.com> writes:

> This patch documents what exactly input-send-event is supposed to do.
>
> Signed-off-by: Amos Kong <akong@redhat.com>
> ---
>  qapi-schema.json | 11 +++++++++++
>  1 file changed, 11 insertions(+)
>
> diff --git a/qapi-schema.json b/qapi-schema.json
> index d0926d9..9aa19bc 100644
> --- a/qapi-schema.json
> +++ b/qapi-schema.json
> @@ -3249,7 +3249,18 @@
>  #
>  # Send input event(s) to guest.
>  #
> +# The VM must be running or suspended.
> +#
> +# Each event is sent to exactly one admissible input device. Such a
> +# device must exist. If multiple admissible devices can handle an
> +# event, which one gets it is unspecified, except as described below.
> +#
>  # @console: #optional console to send event(s) to.
> +#           If @console is missing, only devices that aren't associated
> +#           with a console are admissible.
> +#           If @console is specified, it must exist, and both devices
> +#           associated with that console and devices not associated with a
> +#           console are admissible, but the former takes precedence.
>  #
>  # @events: List of InputEvent union.
>  #

Competes with Gerd's "[PATCH] input: improve docs for input-send-event
qmp command".
diff mbox

Patch

diff --git a/qapi-schema.json b/qapi-schema.json
index d0926d9..9aa19bc 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -3249,7 +3249,18 @@ 
 #
 # Send input event(s) to guest.
 #
+# The VM must be running or suspended.
+#
+# Each event is sent to exactly one admissible input device. Such a
+# device must exist. If multiple admissible devices can handle an
+# event, which one gets it is unspecified, except as described below.
+#
 # @console: #optional console to send event(s) to.
+#           If @console is missing, only devices that aren't associated
+#           with a console are admissible.
+#           If @console is specified, it must exist, and both devices
+#           associated with that console and devices not associated with a
+#           console are admissible, but the former takes precedence.
 #
 # @events: List of InputEvent union.
 #