From dcb962389c5f71bc25cdb84f3363eed95bad9bdd Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 6 Jul 2019 13:33:55 -0700 Subject: fixes #861 Man pages need to use .adoc suffix --- docs/man/nng_send.3.adoc | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) (limited to 'docs/man/nng_send.3.adoc') diff --git a/docs/man/nng_send.3.adoc b/docs/man/nng_send.3.adoc index ef31cbbe..389ba079 100644 --- a/docs/man/nng_send.3.adoc +++ b/docs/man/nng_send.3.adoc @@ -25,16 +25,16 @@ int nng_send(nng_socket s, void *data, size_t size, int flags); == DESCRIPTION The `nng_send()` function sends a message containing the _data_ of -length _size_ using the <> _s_. +length _size_ using the xref:nng_socket.5.adoc[socket] _s_. NOTE: The semantics of what sending a message means vary from protocol to protocol, so examination of the protocol documentation is encouraged. -(For example, with an <> socket the data is broadcast, so that +(For example, with an xref:nng_pub.7.adoc[_nng_] socket the data is broadcast, so that any peers who have a suitable subscription will be able to receive it using -`<>` or a similar function.) +xref:nng_recv.3.adoc[`nng_recv()`] or a similar function.) Furthermore, some protocols may not support sending data (such as -<>) or may require other conditions. -(For example, <> sockets cannot normally send data, +xref:nng_sub.7.adoc[_sub_]) or may require other conditions. +(For example, xref:nng_rep.7.adoc[_rep_] sockets cannot normally send data, which are responses to requests, until they have first received a request.) The _flags_ may contain either of (or neither of) the following values: @@ -48,12 +48,12 @@ The _flags_ may contain either of (or neither of) the following values: then the function will block if such a condition exists. `NNG_FLAG_ALLOC`:: - The _data_ was allocated using `<>`, or was - obtained from a call to `<>` with + The _data_ was allocated using xref:nng_alloc.3.adoc[`nng_alloc()`], or was + obtained from a call to xref:nng_recv.3.adoc[`nng_recv()`] with the `NNG_FLAG_ALLOC` flag. If this function returns success, then the _data_ is "owned" by the function, and it will assume responsibility for calling - `<>` when it is no longer needed. + xref:nng_free.3.adoc[`nng_free()`] when it is no longer needed. In the absence of this flag, the _data_ is copied by the implementation before the function returns to the caller. @@ -64,7 +64,7 @@ NOTE: Regardless of the presence or absence of `NNG_FLAG_NONBLOCK`, there may be queues between the sender and the receiver. Furthermore, there is no guarantee that the message has actually been delivered. Finally, with some protocols, the semantic is implicitly `NNG_FLAG_NONBLOCK`, -such as with <> sockets, which are best-effort delivery only. +such as with xref:nng_pub.7.adoc[_pub_] sockets, which are best-effort delivery only. IMPORTANT: When using `NNG_FLAG_ALLOC`, it is important that the value of _size_ match the actual allocated size of the data. @@ -91,10 +91,10 @@ This function returns 0 on success, and non-zero otherwise. == SEE ALSO [.text-left] -<>, -<>, -<>, -<>, -<>, -<>, -<> +xref:nng_alloc.3.adoc[nng_alloc(3)], +xref:nng_free.3.adoc[nng_free(3)], +xref:nng_recv.3.adoc[nng_recv(3)], +xref:nng_sendmsg.3.adoc[nng_sendmsg(3)], +xref:nng_strerror.3.adoc[nng_strerror(3)], +xref:nng_socket.5.adoc[nng_socket(5)], +xref:nng.7.adoc[nng(7)] -- cgit v1.2.3-70-g09d2