Skip to content

Commit 7722381

Browse files
authored
Merge pull request #3016 from bluca/fix_docs
Problem: some inaccuracies in manpages
2 parents 0e1a9a5 + 1b733e7 commit 7722381

4 files changed

Lines changed: 5 additions & 14 deletions

File tree

doc/zmq_close.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ NOTE: The default setting of _ZMQ_LINGER_ does not discard unsent messages;
2929
this behaviour may cause the application to block when calling _zmq_ctx_term()_.
3030
For details refer to linkzmq:zmq_setsockopt[3] and linkzmq:zmq_ctx_term[3].
3131

32+
NOTE: This API will complete asynchronously, so not everything will be deallocated
33+
after it returns. See above for details about linger.
34+
3235

3336
RETURN VALUE
3437
------------

doc/zmq_connect.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,8 @@ immediately but as needed by 0MQ. Thus a successful call to _zmq_connect()_
3838
does not mean that the connection was or could actually be established.
3939
Because of this, for most transports and socket types the order in which
4040
a 'server' socket is bound and a 'client' socket is connected to it does not
41-
matter. The first exception is when using the inproc:// transport: you must
42-
call _zmq_bind()_ before calling _zmq_connect()_. The second exception are
43-
_ZMQ_PAIR_ sockets, which do not automatically reconnect to endpoints.
41+
matter. The _ZMQ_PAIR_ sockets are an exception, as they do not automatically
42+
reconnect to endpoints.
4443

4544
NOTE: following a _zmq_connect()_, for socket types except for ZMQ_ROUTER,
4645
the socket enters its normal 'ready' state. By contrast, following a

doc/zmq_getsockopt.txt

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,6 @@ packets received from that interface are processed by the socket. If device
7171
is a VRF device, then subsequent binds/connects to that socket use addresses
7272
in the VRF routing table.
7373

74-
NOTE: in DRAFT state, not yet available in stable releases.
75-
7674
[horizontal]
7775
Option value type:: character string
7876
Option value unit:: N/A
@@ -259,8 +257,6 @@ a local user name. A value of 'ZMQ_GSSAPI_NT_KRB5_PRINCIPAL' (2) means it
259257
is interpreted as an unparsed principal name string (valid only with the
260258
krb5 GSSAPI mechanism).
261259

262-
NOTE: in DRAFT state, not yet available in stable releases.
263-
264260
[horizontal]
265261
Option value type:: int
266262
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
277273
is interpreted as an unparsed principal name string (valid only with the
278274
krb5 GSSAPI mechanism).
279275

280-
NOTE: in DRAFT state, not yet available in stable releases.
281-
282276
[horizontal]
283277
Option value type:: int
284278
Option value unit:: 0, 1, 2

doc/zmq_setsockopt.txt

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,6 @@ is a VRF device, then subsequent binds/connects to that socket use addresses
7979
in the VRF routing table.
8080

8181
NOTE: requires setting CAP_NET_RAW on the compiled program.
82-
NOTE: in DRAFT state, not yet available in stable releases.
8382

8483
[horizontal]
8584
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.
283282
A value of 'ZMQ_GSSAPI_NT_KRB5_PRINCIPAL' (2) means it is interpreted as an
284283
unparsed principal name string (valid only with the krb5 GSSAPI mechanism).
285284

286-
NOTE: in DRAFT state, not yet available in stable releases.
287-
288285
[horizontal]
289286
Option value type:: int
290287
Option value unit:: 0, 1, 2
@@ -300,8 +297,6 @@ Sets the name type of the GSSAPI principal. A value of
300297
A value of 'ZMQ_GSSAPI_NT_KRB5_PRINCIPAL' (2) means it is interpreted as an
301298
unparsed principal name string (valid only with the krb5 GSSAPI mechanism).
302299

303-
NOTE: in DRAFT state, not yet available in stable releases.
304-
305300
[horizontal]
306301
Option value type:: int
307302
Option value unit:: 0, 1, 2

0 commit comments

Comments
 (0)