From 7297df6278c57473d9a23e77e5e4dcf0f03c3422 Mon Sep 17 00:00:00 2001 From: sigiesec Date: Tue, 19 Sep 2017 09:13:57 +0200 Subject: [PATCH] Problem: documentation of ZMQ_ZAP_DOMAIN is wrong Solution: fix documentation --- doc/zmq_getsockopt.txt | 3 ++- doc/zmq_setsockopt.txt | 11 +++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt index 83d18819..39a2c12c 100644 --- a/doc/zmq_getsockopt.txt +++ b/doc/zmq_getsockopt.txt @@ -822,7 +822,8 @@ ZMQ_ZAP_DOMAIN: Retrieve RFC 27 authentication domain The 'ZMQ_ZAP_DOMAIN' option shall retrieve the last ZAP domain set for the socket. The returned value shall be a NULL-terminated string and MAY -be empty. The returned size SHALL include the terminating null byte. +be empty. An empty string means that ZAP authentication is disabled. +The returned size SHALL include the terminating null byte. [horizontal] Option value type:: character string diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt index 0aacaa9c..69e61611 100644 --- a/doc/zmq_setsockopt.txt +++ b/doc/zmq_setsockopt.txt @@ -1064,16 +1064,15 @@ Applicable socket types:: ZMQ_XPUB ZMQ_ZAP_DOMAIN: Set RFC 27 authentication domain ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Sets the domain for ZAP (ZMQ RFC 27) authentication. For NULL security (the -default on all tcp:// connections), ZAP authentication only happens if you -set a non-empty domain. For PLAIN and CURVE security, ZAP requests are always -made, if there is a ZAP handler present. See http://rfc.zeromq.org/spec:27 -for more details. +Sets the domain for ZAP (ZMQ RFC 27) authentication. A ZAP domain must be +specified to enable authentication. When the ZAP domain is empty, which is +the default, ZAP authentication is disabled. +See http://rfc.zeromq.org/spec:27 for more details. [horizontal] Option value type:: character string Option value unit:: N/A -Default value:: not set +Default value:: empty Applicable socket types:: all, when using TCP transport