aboutsummaryrefslogtreecommitdiff
path: root/qapi-schema.json
diff options
context:
space:
mode:
authorMarkus Armbruster <armbru@redhat.com>2017-07-19 09:09:42 +0200
committerGerd Hoffmann <kraxel@redhat.com>2017-07-20 09:25:06 +0200
commit6dfe8eabe21c73ede730687e10b85ab645e3022e (patch)
treec406a03bdc0e7442bace803c326fc25d8f96fdf7 /qapi-schema.json
parentd4e59218ab80e86015753782fb5378767a51ccd0 (diff)
downloadqemu-arm-6dfe8eabe21c73ede730687e10b85ab645e3022e.tar.gz
vnc: Clarify documentation of QMP command change
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 <armbru@redhat.com> Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com> Message-id: 1500448182-21376-1-git-send-email-armbru@redhat.com Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
Diffstat (limited to 'qapi-schema.json')
-rw-r--r--qapi-schema.json3
1 files changed, 1 insertions, 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