Merge pull request #3016 from bluca/fix_docs

Problem: some inaccuracies in manpages
zeromq · Mar 21, 2018 · 7722381 · 7722381
2 parents 0e1a9a5 + 1b733e7
commit 7722381
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 14 deletions.
diff --git a/doc/zmq_close.txt b/doc/zmq_close.txt
@@ -29,6 +29,9 @@ NOTE: The default setting of _ZMQ_LINGER_ does not discard unsent messages;
 this behaviour may cause the application to block when calling _zmq_ctx_term()_.
 For details refer to linkzmq:zmq_setsockopt[3] and linkzmq:zmq_ctx_term[3].
 
+NOTE: This API will complete asynchronously, so not everything will be deallocated
+after it returns. See above for details about linger.
+
 
 RETURN VALUE
 ------------

diff --git a/doc/zmq_connect.txt b/doc/zmq_connect.txt
@@ -38,9 +38,8 @@ immediately but as needed by 0MQ. Thus a successful call to _zmq_connect()_
 does not mean that the connection was or could actually be established.
 Because of this, for most transports and socket types the order in which
 a 'server' socket is bound and a 'client' socket is connected to it does not
-matter. The first exception is when using the inproc:// transport: you must
-call _zmq_bind()_ before calling _zmq_connect()_. The second exception are
-_ZMQ_PAIR_ sockets, which do not automatically reconnect to endpoints.
+matter. The _ZMQ_PAIR_ sockets are an exception, as they do not automatically
+reconnect to endpoints.
 
 NOTE: following a _zmq_connect()_, for socket types except for ZMQ_ROUTER,
 the socket enters its normal 'ready' state. By contrast, following a

diff --git a/doc/zmq_getsockopt.txt b/doc/zmq_getsockopt.txt
@@ -71,8 +71,6 @@ packets received from that interface are processed by the socket. If device
 is a VRF device, then subsequent binds/connects to that socket use addresses
 in the VRF routing table.
 
-NOTE: in DRAFT state, not yet available in stable releases.
-
 [horizontal]
 Option value type:: character string
 Option value unit:: N/A
@@ -259,8 +257,6 @@ a local user name.  A value of 'ZMQ_GSSAPI_NT_KRB5_PRINCIPAL' (2) means it
 is interpreted as an unparsed principal name string (valid only with the
 krb5 GSSAPI mechanism).
 
-NOTE: in DRAFT state, not yet available in stable releases.
-
 [horizontal]
 Option value type:: int
 Option value unit:: 0, 1, 2
@@ -277,8 +273,6 @@ a local user name.  A value of 'ZMQ_GSSAPI_NT_KRB5_PRINCIPAL' (2) means it
 is interpreted as an unparsed principal name string (valid only with the
 krb5 GSSAPI mechanism).
 
-NOTE: in DRAFT state, not yet available in stable releases.
-
 [horizontal]
 Option value type:: int
 Option value unit:: 0, 1, 2

diff --git a/doc/zmq_setsockopt.txt b/doc/zmq_setsockopt.txt
@@ -79,7 +79,6 @@ is a VRF device, then subsequent binds/connects to that socket use addresses
 in the VRF routing table.
 
 NOTE: requires setting CAP_NET_RAW on the compiled program.
-NOTE: in DRAFT state, not yet available in stable releases.
 
 [horizontal]
 Option value type:: character string
@@ -283,8 +282,6 @@ of 'ZMQ_GSSAPI_NT_USER_NAME' (1) means it is interpreted as a local user name.
 A value of 'ZMQ_GSSAPI_NT_KRB5_PRINCIPAL' (2) means it is interpreted as an
 unparsed principal name string (valid only with the krb5 GSSAPI mechanism).
 
-NOTE: in DRAFT state, not yet available in stable releases.
-
 [horizontal]
 Option value type:: int
 Option value unit:: 0, 1, 2
@@ -300,8 +297,6 @@ Sets the name type of the GSSAPI principal.  A value of
 A value of 'ZMQ_GSSAPI_NT_KRB5_PRINCIPAL' (2) means it is interpreted as an
 unparsed principal name string (valid only with the krb5 GSSAPI mechanism).
 
-NOTE: in DRAFT state, not yet available in stable releases.
-
 [horizontal]
 Option value type:: int
 Option value unit:: 0, 1, 2