[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 1/2] vnc: Clarify documentation of QMP command change
From: |
Gerd Hoffmann |
Subject: |
[Qemu-devel] [PULL 1/2] vnc: Clarify documentation of QMP command change |
Date: |
Thu, 20 Jul 2017 09:55:25 +0200 |
From: Markus Armbruster <address@hidden>
QMP command
{ "execute": "change",
"arguments": { "device": "vnc", "target": "password", "arg": PWD } }
behaves just like
{ "execute": "change-vnc-password",
"arguments": { "password", "arg": PWD } }
Their documentation differs, however. According to
change-vnc-password's documentation, "an empty password [...] will set
the password to the empty string", while change's documentation claims
"no future logins will be allowed". The former is actually correct.
Replace the incorrect claim by a reference to change-vnc-password.
Signed-off-by: Markus Armbruster <address@hidden>
Reviewed-by: Marc-André Lureau <address@hidden>
Message-id: address@hidden
Signed-off-by: Gerd Hoffmann <address@hidden>
---
qapi-schema.json | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
diff --git a/qapi-schema.json b/qapi-schema.json
index 8b015bee2e..58d3a0209f 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -3011,8 +3011,7 @@
# @arg: If @device is a block device, then this is an optional format to
open
# the device with.
# If @device is 'vnc' and @target is 'password', this is the new VNC
-# password to set. If this argument is an empty string, then no
future
-# logins will be allowed.
+# password to set. See change-vnc-password for additional notes.
#
# Returns: Nothing on success.
# If @device is not a valid block device, DeviceNotFound
--
2.9.3