[PATCH 2/6] qapi/common: Supply missing member documentation

Markus Armbruster posted 6 patches 3 months, 2 weeks ago
There is a newer version of this series
[PATCH 2/6] qapi/common: Supply missing member documentation
Posted by Markus Armbruster 3 months, 2 weeks ago
Since we neglect to document the members of GrabToggleKeys, their
description in the QEMU QMP Reference manual is "Not documented".  Fix
that.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/common.json | 14 +++++++++++++-
 qapi/pragma.json |  1 -
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/qapi/common.json b/qapi/common.json
index 7558ce5430..6ffc7a3789 100644
--- a/qapi/common.json
+++ b/qapi/common.json
@@ -183,7 +183,19 @@
 ##
 # @GrabToggleKeys:
 #
-# Keys to toggle input-linux between host and guest.
+# Key combinations to toggle input-linux between host and guest.
+#
+# @ctrl-ctrl: left and right control key
+#
+# @alt-alt: left and right alt key
+#
+# @shift-shift: left and right shift key
+#
+# @meta-meta: left and right meta key
+#
+# @scrolllock: scroll lock key
+#
+# @ctrl-scrolllock: either control key and scroll lock key
 #
 # Since: 4.0
 ##
diff --git a/qapi/pragma.json b/qapi/pragma.json
index 39a424303b..6ff135d8d2 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -55,7 +55,6 @@
         'DummyBlockCoreForceArrays',
         'DummyForceArrays',
         'DummyVirtioForceArrays',
-        'GrabToggleKeys',
         'HotKeyMod',
         'ImageInfoSpecificKind',
         'InputAxis',
-- 
2.45.0
Re: [PATCH 2/6] qapi/common: Supply missing member documentation
Posted by Philippe Mathieu-Daudé 3 months, 2 weeks ago
On 8/8/24 20:26, Markus Armbruster wrote:
> Since we neglect to document the members of GrabToggleKeys, their
> description in the QEMU QMP Reference manual is "Not documented".  Fix
> that.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>   qapi/common.json | 14 +++++++++++++-
>   qapi/pragma.json |  1 -
>   2 files changed, 13 insertions(+), 2 deletions(-)

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>