Skip to content

Commit

Permalink
fixes nanomsg#861 Man pages need to use .adoc suffix
Browse files Browse the repository at this point in the history
  • Loading branch information
gdamore committed Jul 6, 2019
1 parent 7b6e73f commit dcb9623
Show file tree
Hide file tree
Showing 211 changed files with 1,800 additions and 1,798 deletions.
20 changes: 10 additions & 10 deletions docs/man/nn_allocmsg.3compat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,16 @@ The value of _size_ must be positive, and small enough to hold reasonable
message data plus book-keeping information.

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.

The value of _type_ *must* be zero.
(This argument was reserved to support different kinds of memory spaces
for RDMA devices, but this was never developed in the legacy API.)

The returned message must be disposed of by either
`<<nn_freemsg.3compat#,nn_freemsg()>>` or
`<<nn_send.3compat#,nn_send()>>` when the caller is finished with it.
xref:nn_freemsg.3compat.adoc[`nn_freemsg()`] or
xref:nn_send.3compat.adoc[`nn_send()`] when the caller is finished with it.

== RETURN VALUES

Expand All @@ -59,9 +59,9 @@ on failure.
== SEE ALSO

[.text-left]
<<nn_errno.3compat#,nn_errno(3compat)>>,
<<nn_freemsg.3compat#,nn_freemsg(3compat)>>,
<<nn_reallocmsg.3compat#,nn_reallocmsg(3compat)>>,
<<nn_send.3compat#,nn_send(3compat)>>,
<<nng_compat.3compat#,nng_compat(3compat)>>,
<<nng.7#,nng(7)>>
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
xref:nn_freemsg.3compat.adoc[nn_freemsg(3compat)],
xref:nn_reallocmsg.3compat.adoc[nn_reallocmsg(3compat)],
xref:nn_send.3compat.adoc[nn_send(3compat)],
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
xref:nng.7.adoc[nng(7)]
20 changes: 10 additions & 10 deletions docs/man/nn_bind.3compat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ The `nn_bind()` function arranges for the socket _sock_ to
accept connections at the address specified by _url_.
An "`endpoint identifier`" for this socket's association with the _url_ is
returned to the caller on success.
This ID can be used with `<<nn_shutdown.3compat#,nn_shutdown()>>` to
This ID can be used with xref:nn_shutdown.3compat.adoc[`nn_shutdown()`] to
"`unbind`" the socket from the address at _url_.

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.

NOTE: The bind operation is performed asynchronously, and may not have
completed before this function returns control to the caller.
Expand All @@ -42,7 +42,7 @@ IMPORTANT: Only transports supported by legacy _libnanomsg_ may be
used with this function.
In particular, only the schemes `tcp://`, `ipc://`, `inproc://`, and `ws://` are
supported with this function.
(Use the <<libnng.3#,modern API>> to use other schemes.)
(Use the xref:libnng.3.adoc[modern API] to use other schemes.)

== RETURN VALUES

Expand All @@ -59,9 +59,9 @@ This function returns a positive identifier on success, and -1 on error.
== SEE ALSO

[.text-left]
<<nn_connect.3compat#,nn_connect(3compat)>>,
<<nn_errno.3compat#,nn_errno(3compat)>>,
<<nn_shutdown.3compat#,nn_shutdown(3compat)>>,
<<nn_socket.3compat#,nn_socket(3compat)>>,
<<nng_compat.3compat#,nn_compat(3compat)>>,
<<nng.7#,nng(7)>>
xref:nn_connect.3compat.adoc[nn_connect(3compat)],
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
xref:nn_shutdown.3compat.adoc[nn_shutdown(3compat)],
xref:nn_socket.3compat.adoc[nn_socket(3compat)],
xref:nng_compat.3compat.adoc[nn_compat(3compat)],
xref:nng.7.adoc[nng(7)]
12 changes: 6 additions & 6 deletions docs/man/nn_close.3compat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ Any operations that are currently in progress will be terminated, and will
fail with error `EBADF`.

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.

== RETURN VALUES

Expand All @@ -45,7 +45,7 @@ This function returns zero on success, and -1 on failure.
== SEE ALSO

[.text-left]
<<nn_errno.3compat#,nn_errno(3compat)>>,
<<nn_socket.3compat#,nn_socket(3compat)>>,
<<nng_compat.3compat#,nng_compat(3compat)>>,
<<nng.7#,nng(7)>>
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
xref:nn_socket.3compat.adoc[nn_socket(3compat)],
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
xref:nng.7.adoc[nng(7)]
16 changes: 8 additions & 8 deletions docs/man/nn_cmsg.3compat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ struct nn_cmsghdr {
== DESCRIPTION

The `nn_cmsghdr` structure describes a block of control data that is
associated with a message either sent by `<<nn_sendmsg.3compat#,nn_sendmsg()>>`
or received by `<<nn_recvmsg.3compat#,nn_recvmsg()>>`.
associated with a message either sent by xref:nn_sendmsg.3compat.adoc[`nn_sendmsg()`]
or received by xref:nn_recvmsg.3compat.adoc[`nn_recvmsg()`].

NOTE: This structure and supporting macros are 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.

Each header is followed by `cmsg_len` bytes of data, plus any padding required
to align the structure.
Expand Down Expand Up @@ -72,7 +72,7 @@ to align for another header.
== SEE ALSO

[.text-left]
<<nn_recvmsg.3compat#,nn_recvmsg(3compat)>>,
<<nn_sendmsg.3compat#,nn_sendmsg(3compat)>>,
<<nng_compat.3compat#,nng_compat(3compat)>>,
<<nng.7#,nng(7)>>
xref:nn_recvmsg.3compat.adoc[nn_recvmsg(3compat)],
xref:nn_sendmsg.3compat.adoc[nn_sendmsg(3compat)],
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
xref:nng.7.adoc[nng(7)]
20 changes: 10 additions & 10 deletions docs/man/nn_connect.3compat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ The `nn_connect()` function arranges for the socket _sock_ to
initiate connection to a peer at the address specified by _url_.
An "`endpoint identifier`" for this socket's association with the _url_ is
returned to the caller on success.
This ID can be used with `<<nn_shutdown.3compat#,nn_shutdown()>>` to
This ID can be used with xref:nn_shutdown.3compat.adoc[`nn_shutdown()`] to
"`unbind`" the socket from the address at _url_.

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.

NOTE: The connect operation is performed asynchronously, and may not have
completed before this function returns control to the caller.
Expand All @@ -42,7 +42,7 @@ IMPORTANT: Only transports supported by legacy _libnanomsg_ may be
used with this function.
In particular, only the schemes `tcp://`, `ipc://`, `inproc://`, and `ws://` are
supported with this function.
(Use the <<libnng.3#,modern API>> to use other schemes.)
(Use the xref:libnng.3.adoc[modern API] to use other schemes.)

== RETURN VALUES

Expand All @@ -58,9 +58,9 @@ This function returns a positive identifier success, and -1 on error.
== SEE ALSO

[.text-left]
<<nn_bind.3compat#,nn_bind(3compat)>>,
<<nn_errno.3compat#,nn_errno(3compat)>>,
<<nn_shutdown.3compat#,nn_shutdown(3compat)>>,
<<nn_socket.3compat#,nn_socket(3compat)>>,
<<nng_compat.3compat#,nn_compat(3compat)>>,
<<nng.7#,nng(7)>>
xref:nn_bind.3compat.adoc[nn_bind(3compat)],
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
xref:nn_shutdown.3compat.adoc[nn_shutdown(3compat)],
xref:nn_socket.3compat.adoc[nn_socket(3compat)],
xref:nng_compat.3compat.adoc[nn_compat(3compat)],
xref:nng.7.adoc[nng(7)]
17 changes: 9 additions & 8 deletions docs/man/nn_device.3compat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,14 @@ received on one of the two sockets _sock1_ and _sock2_ are forwarded to
the other.

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.

The two sockets must be compatible, and must be <<nng.7#raw_mode,raw mode>>
The two sockets must be compatible, and must be
xref:nng.7.adoc#raw_mode[raw mode]
sockets.
More detail about devices and how they can be used is available in the
new style <<nng_device.3#,nng_device()>> documentation.
new style xref:nng_device.3.adoc[nng_device()] documentation.

== RETURN VALUES

Expand All @@ -52,7 +53,7 @@ one of the sockets is closed or an error occurs.
== SEE ALSO

[.text-left]
<<nn_errno.3compat#,nn_errno(3compat)>>,
<<nn_socket.3compat#,nn_socket(3compat)>>,
<<nng_compat.3compat#,nng_compat(3compat)>>,
<<nng.7#,nng(7)>>
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
xref:nn_socket.3compat.adoc[nn_socket(3compat)],
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
xref:nng.7.adoc[nng(7)]
10 changes: 5 additions & 5 deletions docs/man/nn_errno.3compat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ The `nn_errno()` function returns the error number corresponding to the
most recent failed operation by the calling thread.

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.

IMPORTANT: The error numbers returned from this function may include
errors caused by system functions, which overlap the usual `errno` variable,
Expand Down Expand Up @@ -74,6 +74,6 @@ If no operation has failed, then this will be zero.
== SEE ALSO

[.text-left]
<<nn_strerror.3compat#,nn_strerror(3compat)>>,
<<nng_compat.3compat#,nng_compat(3compat)>>,
<<nng.7#,nng(7)>>
xref:nn_strerror.3compat.adoc[nn_strerror(3compat)],
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
xref:nng.7.adoc[nng(7)]
16 changes: 8 additions & 8 deletions docs/man/nn_freemsg.3compat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ int nn_freemsg(void *msg);
== DESCRIPTION

The `nn_freemsg()` deallocates a message previously allocated with
`<<nn_allocmsg.3compat#,nn_allocmsg()>>` or similar functions.
xref:nn_allocmsg.3compat.adoc[`nn_allocmsg()`] or similar functions.

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.

== RETURN VALUES

Expand All @@ -42,8 +42,8 @@ None.
== SEE ALSO

[.text-left]
<<nn_allocmsg.3compat#,nn_allocmsg(3compat)>>,
<<nn_freemsg.3compat#,nn_freemsg(3compat)>>,
<<nn_errno.3compat#,nn_errno(3compat)>>,
<<nng_compat.3compat#,nng_compat(3compat)>>,
<<nng.7#,nng(7)>>
xref:nn_allocmsg.3compat.adoc[nn_allocmsg(3compat)],
xref:nn_freemsg.3compat.adoc[nn_freemsg(3compat)],
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
xref:nng.7.adoc[nng(7)]
8 changes: 4 additions & 4 deletions docs/man/nn_get_statistic.3compat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ The `nn_get_statistic()` function exists only as a stub, and always returns
zero.

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.

== RETURN VALUES

Expand All @@ -42,5 +42,5 @@ None.
== SEE ALSO

[.text-left]
<<nng_compat.3compat#,nng_compat(3compat)>>,
<<nng.7#,nng(7)>>
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
xref:nng.7.adoc[nng(7)]
18 changes: 9 additions & 9 deletions docs/man/nn_getsockopt.3compat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ The `nn_getsockopt()` function gets a socket option on socket _sock_.
The option retrieved is determined by the _level_ and _option_.

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.

The value pointed to by _szp_ must be initialized to the size of the buffer
pointed to by _val_.
Expand Down Expand Up @@ -131,7 +131,7 @@ their different application-specific purposes.
`NN_MAXTTL`::
Maximum "`hops`" through proxies and devices a message may go through.
This value, if positive, provides some protection against forwarding loops in
<<nng_device.3#,device>> chains.
xref:nng_device.3.adoc[device] chains.

NOTE: Not all protocols offer this protection, so care should still be used
in configuring device forwarding.
Expand Down Expand Up @@ -220,9 +220,9 @@ This function returns zero on success, and -1 on failure.
== SEE ALSO

[.text-left]
<<nng_socket.5#,nng_socket(5)>>,
<<nn_close.3compat#,nn_close(3compat)>>,
<<nn_errno.3compat#,nn_errno(3compat)>>,
<<nn_getsockopt.3compat#,nn_getsockopt(3compat)>>,
<<nng_compat.3compat#,nng_compat(3compat)>>,
<<nng.7#,nng(7)>>
xref:nng_socket.5.adoc[nng_socket(5)],
xref:nn_close.3compat.adoc[nn_close(3compat)],
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
xref:nn_getsockopt.3compat.adoc[nn_getsockopt(3compat)],
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
xref:nng.7.adoc[nng(7)]
20 changes: 10 additions & 10 deletions docs/man/nn_poll.3compat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ int nn_poll(struct nn_pollfd *pfds, int npfd, int timeout);
The `nn_poll()` function polls a group of sockets for readiness to send or receive.

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.

The array of _nfds_ sockets to poll for are passed into _pfds_.
Each member of this array is initialized with the `fd` field set to
Expand Down Expand Up @@ -67,10 +67,10 @@ If the _timeout_ is -1, then the function waits forever, or until one of the
requested events occurs.

IMPORTANT: This function is only suitable for use with sockets obtained with the
`<<nn_socket.3compat#,nn_socket()>>` function, and is not compatible
xref:nn_socket.3compat.adoc[`nn_socket()`] function, and is not compatible
with file descriptors obtained via any other means.
This includes file descriptors obtained using the `NN_SNDFD` or `NN_RCVFD`
options with `<<nn_getsockopt.3compat#,nn_getsockopt()>>`
options with xref:nn_getsockopt.3compat.adoc[`nn_getsockopt()`]

NOTE: This function is significantly less efficient than other polling
or asynchronous I/O mechanisms, and is provided for API compatibility only.
Expand All @@ -94,9 +94,9 @@ This function returns the number of sockets with events on success, or -1 on err
== SEE ALSO

[.text-left]
<<nn_errno.3compat#,nn_errno(3compat)>>,
<<nn_recv.3compat#,nn_recv(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_recv.3compat.adoc[nn_recv(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)]
14 changes: 7 additions & 7 deletions docs/man/nn_reallocmsg.3compat.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ void *nn_reallocmsg(void *old, size_t size);
The `nn_reallocmsg()` reallocates the message _old_, making it of size _size_.

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.

On success, the contents of _old_ are copied into the new message
(truncating if appropriate), then _old_ is deallocated, and a pointer
Expand All @@ -52,8 +52,8 @@ on failure.
== SEE ALSO

[.text-left]
<<nn_allocmsg.3compat#,nn_allocmsg(3compat)>>,
<<nn_freemsg.3compat#,nn_freemsg(3compat)>>,
<<nn_errno.3compat#,nn_errno(3compat)>>,
<<nng_compat.3compat#,nng_compat(3compat)>>,
<<nng.7#,nng(7)>>
xref:nn_allocmsg.3compat.adoc[nn_allocmsg(3compat)],
xref:nn_freemsg.3compat.adoc[nn_freemsg(3compat)],
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
xref:nng.7.adoc[nng(7)]
Loading

0 comments on commit dcb9623

Please sign in to comment.