[v4,02/34] qapi: Belatedly update doc comment for @wait deprecation

Commit Message

Markus Armbruster March 17, 2020, 11:54 a.m. UTC

Commit a9b305ba29 "socket: allow wait=false for client socket"
deprecated use of @wait for client socket chardevs, but neglected to
update char.json's doc comment.  Make up for that.

Signed-off-by: Markus Armbruster <[e-mail]>
Reviewed-by: Marc-André Lureau <[e-mail]>
Reviewed-by: Eric Blake <[e-mail]>
---
 qapi/char.json | 1 +
 1 file changed, 1 insertion(+)

Patch

diff --git a/qapi/char.json b/qapi/char.json
index 6907b2bfdb..daceb20f84 100644
--- a/qapi/char.json
+++ b/qapi/char.json
@@ -258,6 +258,7 @@ 
 # @server: create server socket (default: true)
 # @wait: wait for incoming connection on server
 #        sockets (default: false).
+#        Silently ignored with server: false.  This use is deprecated.
 # @nodelay: set TCP_NODELAY socket option (default: false)
 # @telnet: enable telnet protocol on server
 #          sockets (default: false)