diff mbox series

[v4,3/3] qemu-options: updates for abstract unix sockets

Message ID 20200515043235.32189-4-zxq_yx_007@163.com (mailing list archive)
State New, archived
Headers show
Series qemu-sockets: add abstract UNIX domain socket support | expand

Commit Message

zhao xiao qiang May 15, 2020, 4:32 a.m. UTC
add options documents changes for -chardev

Signed-off-by: xiaoqiang zhao <zxq_yx_007@163.com>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
---
 qemu-options.hx | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

Comments

Eric Blake May 15, 2020, 5:37 p.m. UTC | #1
On 5/14/20 11:32 PM, xiaoqiang zhao wrote:
> add options documents changes for -chardev
> 
> Signed-off-by: xiaoqiang zhao <zxq_yx_007@163.com>
> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
> ---
>   qemu-options.hx | 9 +++++++--
>   1 file changed, 7 insertions(+), 2 deletions(-)

I'd suggest listing 'abstract' before 'tight', since 'tight' only 
matters for abstract.  I also have grammar suggestions:

> -    ``unix options: path=path``
> +    ``unix options: path=path[,tight=on|off][,abstract=on|off]``
>           ``path`` specifies the local path of the unix socket. ``path``
>           is required.
> +	``tight`` whether to set @addrlen to the minimal string length,
> +        or the maximum sun_path length. defaults to true. ``tight`` is
> +        optional.
> +	``abstract`` whether use abstract address. defaults to false.
> +	``abstract`` is optional.

``abstract`` specifies the use of the abstract socket namespace, rather 
than the filesystem.  Optional, defaults to false.
``tight`` sets the socket length of abstract sockets to their minimum, 
rather than the full sun_path length.  Optional, defaults to true.
zhao xiao qiang May 16, 2020, 3:01 a.m. UTC | #2
在 2020/5/16 上午1:37, Eric Blake 写道:
> On 5/14/20 11:32 PM, xiaoqiang zhao wrote:
>> add options documents changes for -chardev
>>
>> Signed-off-by: xiaoqiang zhao <zxq_yx_007@163.com>
>> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
>> ---
>>   qemu-options.hx | 9 +++++++--
>>   1 file changed, 7 insertions(+), 2 deletions(-)
>
> I'd suggest listing 'abstract' before 'tight', since 'tight' only 
> matters for abstract.  I also have grammar suggestions:
>
>> -    ``unix options: path=path``
>> +    ``unix options: path=path[,tight=on|off][,abstract=on|off]``
>>           ``path`` specifies the local path of the unix socket. ``path``
>>           is required.
>> +    ``tight`` whether to set @addrlen to the minimal string length,
>> +        or the maximum sun_path length. defaults to true. ``tight`` is
>> +        optional.
>> +    ``abstract`` whether use abstract address. defaults to false.
>> +    ``abstract`` is optional.
>
> ``abstract`` specifies the use of the abstract socket namespace, 
> rather than the filesystem.  Optional, defaults to false.
> ``tight`` sets the socket length of abstract sockets to their minimum, 
> rather than the full sun_path length.  Optional, defaults to true.
>
Reasonable,  will change in v6
diff mbox series

Patch

diff --git a/qemu-options.hx b/qemu-options.hx
index e2dca8a4e9..e63cc1b4b4 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -2938,7 +2938,7 @@  DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
     "         [,server][,nowait][,telnet][,websocket][,reconnect=seconds][,mux=on|off]\n"
     "         [,logfile=PATH][,logappend=on|off][,tls-creds=ID][,tls-authz=ID] (tcp)\n"
     "-chardev socket,id=id,path=path[,server][,nowait][,telnet][,websocket][,reconnect=seconds]\n"
-    "         [,mux=on|off][,logfile=PATH][,logappend=on|off] (unix)\n"
+    "         [,mux=on|off][,logfile=PATH][,logappend=on|off][,tight=on|off][,abstract=on|off] (unix)\n"
     "-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr]\n"
     "         [,localport=localport][,ipv4][,ipv6][,mux=on|off]\n"
     "         [,logfile=PATH][,logappend=on|off]\n"
@@ -3105,9 +3105,14 @@  The available backends are:
 
         ``nodelay`` disables the Nagle algorithm.
 
-    ``unix options: path=path``
+    ``unix options: path=path[,tight=on|off][,abstract=on|off]``
         ``path`` specifies the local path of the unix socket. ``path``
         is required.
+	``tight`` whether to set @addrlen to the minimal string length,
+        or the maximum sun_path length. defaults to true. ``tight`` is
+        optional.
+	``abstract`` whether use abstract address. defaults to false.
+	``abstract`` is optional.
 
 ``-chardev udp,id=id[,host=host],port=port[,localaddr=localaddr][,localport=localport][,ipv4][,ipv6]``
     Sends all traffic from the guest to a remote host over UDP.