aboutsummaryrefslogtreecommitdiff
path: root/docs/man/nn_recv.3compat.adoc
diff options
context:
space:
mode:
authorGarrett D'Amore <garrett@damore.org>2019-07-06 13:33:55 -0700
committerGarrett D'Amore <garrett@damore.org>2019-07-06 13:33:55 -0700
commitdcb962389c5f71bc25cdb84f3363eed95bad9bdd (patch)
tree2a94b72596df4ff76081eb74632af0ce273517b1 /docs/man/nn_recv.3compat.adoc
parent7b6e73f23104a50b898da1065cf9d3bf8b6a3bca (diff)
downloadnng-dcb962389c5f71bc25cdb84f3363eed95bad9bdd.tar.gz
nng-dcb962389c5f71bc25cdb84f3363eed95bad9bdd.tar.bz2
nng-dcb962389c5f71bc25cdb84f3363eed95bad9bdd.zip
fixes #861 Man pages need to use .adoc suffix
Diffstat (limited to 'docs/man/nn_recv.3compat.adoc')
-rw-r--r--docs/man/nn_recv.3compat.adoc22
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/man/nn_recv.3compat.adoc b/docs/man/nn_recv.3compat.adoc
index 1b77f28f..9e44d840 100644
--- a/docs/man/nn_recv.3compat.adoc
+++ b/docs/man/nn_recv.3compat.adoc
@@ -30,22 +30,22 @@ at the location specified by _data_, unless _size_ is the
special value `NN_MSG`, indicating a zero-copy operation.
NOTE: This function is provided for API
-<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
-Consider using the relevant <<libnng.3#,modern API>> instead.
+xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
+Consider using the relevant xref:libnng.3.adoc[modern API] instead.
If _size_ has the special value `NN_MSG`, then a zero-copy operation
is performed.
In this case, instead of copying the message data into the address
specified by _data_, a new message large enough to hold the message data
will be allocated (as if by the
-function `<<nn_allocmsg.3compat#,nn_allocmsg()>>`), and the message
+function xref:nn_allocmsg.3compat.adoc[`nn_allocmsg()`]), and the message
payload will be stored accordingly.
In this case, the value stored at _data_ will not be message data,
but a pointer to the message itself.
In this case, on success, the caller shall take responsibility for
the final disposition of the message (such as by sending it to
-another peer using `<<nn_send.3compat#,nn_send()>>`) or
-`<<nn_freemsg.3compat#,nn_freemsg()>>`.
+another peer using xref:nn_send.3compat.adoc[`nn_send()`]) or
+xref:nn_freemsg.3compat.adoc[`nn_freemsg()`].
The _flags_ field may contain the special flag `NN_DONTWAIT`.
In this case, if the no message is available for immediate receipt,
@@ -67,9 +67,9 @@ This function returns the number of bytes sent on success, and -1 on error.
== SEE ALSO
[.text-left]
-<<nn_errno.3compat#,nn_errno(3compat)>>,
-<<nn_recvmsg.3compat#,nn_recvmsg(3compat)>>,
-<<nn_send.3compat#,nn_send(3compat)>>,
-<<nn_socket.3compat#,nn_socket(3compat)>>,
-<<nng_compat.3compat#,nn_compat(3compat)>>,
-<<nng.7#,nng(7)>>
+xref:nn_errno.3compat.adoc[nn_errno(3compat)],
+xref:nn_recvmsg.3compat.adoc[nn_recvmsg(3compat)],
+xref:nn_send.3compat.adoc[nn_send(3compat)],
+xref:nn_socket.3compat.adoc[nn_socket(3compat)],
+xref:nng_compat.3compat.adoc[nn_compat(3compat)],
+xref:nng.7.adoc[nng(7)]