Skip to content

Commit dcb9623

Browse files
committed
fixes nanomsg#861 Man pages need to use .adoc suffix
1 parent 7b6e73f commit dcb9623

File tree

211 files changed

+1800
-1798
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

211 files changed

+1800
-1798
lines changed

docs/man/nn_allocmsg.3compat.adoc

+10-10
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,16 @@ The value of _size_ must be positive, and small enough to hold reasonable
3333
message data plus book-keeping information.
3434

3535
NOTE: This function is provided for API
36-
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
37-
Consider using the relevant <<libnng.3#,modern API>> instead.
36+
xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
37+
Consider using the relevant xref:libnng.3.adoc[modern API] instead.
3838

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

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

4747
== RETURN VALUES
4848

@@ -59,9 +59,9 @@ on failure.
5959
== SEE ALSO
6060

6161
[.text-left]
62-
<<nn_errno.3compat#,nn_errno(3compat)>>,
63-
<<nn_freemsg.3compat#,nn_freemsg(3compat)>>,
64-
<<nn_reallocmsg.3compat#,nn_reallocmsg(3compat)>>,
65-
<<nn_send.3compat#,nn_send(3compat)>>,
66-
<<nng_compat.3compat#,nng_compat(3compat)>>,
67-
<<nng.7#,nng(7)>>
62+
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
63+
xref:nn_freemsg.3compat.adoc[nn_freemsg(3compat)],
64+
xref:nn_reallocmsg.3compat.adoc[nn_reallocmsg(3compat)],
65+
xref:nn_send.3compat.adoc[nn_send(3compat)],
66+
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
67+
xref:nng.7.adoc[nng(7)]

docs/man/nn_bind.3compat.adoc

+10-10
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ The `nn_bind()` function arranges for the socket _sock_ to
2828
accept connections at the address specified by _url_.
2929
An "`endpoint identifier`" for this socket's association with the _url_ is
3030
returned to the caller on success.
31-
This ID can be used with `<<nn_shutdown.3compat#,nn_shutdown()>>` to
31+
This ID can be used with xref:nn_shutdown.3compat.adoc[`nn_shutdown()`] to
3232
"`unbind`" the socket from the address at _url_.
3333

3434
NOTE: This function is provided for API
35-
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
36-
Consider using the relevant <<libnng.3#,modern API>> instead.
35+
xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
36+
Consider using the relevant xref:libnng.3.adoc[modern API] instead.
3737

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

4747
== RETURN VALUES
4848

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

6161
[.text-left]
62-
<<nn_connect.3compat#,nn_connect(3compat)>>,
63-
<<nn_errno.3compat#,nn_errno(3compat)>>,
64-
<<nn_shutdown.3compat#,nn_shutdown(3compat)>>,
65-
<<nn_socket.3compat#,nn_socket(3compat)>>,
66-
<<nng_compat.3compat#,nn_compat(3compat)>>,
67-
<<nng.7#,nng(7)>>
62+
xref:nn_connect.3compat.adoc[nn_connect(3compat)],
63+
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
64+
xref:nn_shutdown.3compat.adoc[nn_shutdown(3compat)],
65+
xref:nn_socket.3compat.adoc[nn_socket(3compat)],
66+
xref:nng_compat.3compat.adoc[nn_compat(3compat)],
67+
xref:nng.7.adoc[nng(7)]

docs/man/nn_close.3compat.adoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Any operations that are currently in progress will be terminated, and will
2929
fail with error `EBADF`.
3030

3131
NOTE: This function is provided for API
32-
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
33-
Consider using the relevant <<libnng.3#,modern API>> instead.
32+
xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
33+
Consider using the relevant xref:libnng.3.adoc[modern API] instead.
3434

3535
== RETURN VALUES
3636

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

4747
[.text-left]
48-
<<nn_errno.3compat#,nn_errno(3compat)>>,
49-
<<nn_socket.3compat#,nn_socket(3compat)>>,
50-
<<nng_compat.3compat#,nng_compat(3compat)>>,
51-
<<nng.7#,nng(7)>>
48+
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
49+
xref:nn_socket.3compat.adoc[nn_socket(3compat)],
50+
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
51+
xref:nng.7.adoc[nng(7)]

docs/man/nn_cmsg.3compat.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ struct nn_cmsghdr {
2929
== DESCRIPTION
3030

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

3535
NOTE: This structure and supporting macros are provided for API
36-
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
37-
Consider using the relevant <<libnng.3#,modern API>> instead.
36+
xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
37+
Consider using the relevant xref:libnng.3.adoc[modern API] instead.
3838

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

7474
[.text-left]
75-
<<nn_recvmsg.3compat#,nn_recvmsg(3compat)>>,
76-
<<nn_sendmsg.3compat#,nn_sendmsg(3compat)>>,
77-
<<nng_compat.3compat#,nng_compat(3compat)>>,
78-
<<nng.7#,nng(7)>>
75+
xref:nn_recvmsg.3compat.adoc[nn_recvmsg(3compat)],
76+
xref:nn_sendmsg.3compat.adoc[nn_sendmsg(3compat)],
77+
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
78+
xref:nng.7.adoc[nng(7)]

docs/man/nn_connect.3compat.adoc

+10-10
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,12 @@ The `nn_connect()` function arranges for the socket _sock_ to
2828
initiate connection to a peer at the address specified by _url_.
2929
An "`endpoint identifier`" for this socket's association with the _url_ is
3030
returned to the caller on success.
31-
This ID can be used with `<<nn_shutdown.3compat#,nn_shutdown()>>` to
31+
This ID can be used with xref:nn_shutdown.3compat.adoc[`nn_shutdown()`] to
3232
"`unbind`" the socket from the address at _url_.
3333

3434
NOTE: This function is provided for API
35-
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
36-
Consider using the relevant <<libnng.3#,modern API>> instead.
35+
xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
36+
Consider using the relevant xref:libnng.3.adoc[modern API] instead.
3737

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

4747
== RETURN VALUES
4848

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

6060
[.text-left]
61-
<<nn_bind.3compat#,nn_bind(3compat)>>,
62-
<<nn_errno.3compat#,nn_errno(3compat)>>,
63-
<<nn_shutdown.3compat#,nn_shutdown(3compat)>>,
64-
<<nn_socket.3compat#,nn_socket(3compat)>>,
65-
<<nng_compat.3compat#,nn_compat(3compat)>>,
66-
<<nng.7#,nng(7)>>
61+
xref:nn_bind.3compat.adoc[nn_bind(3compat)],
62+
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
63+
xref:nn_shutdown.3compat.adoc[nn_shutdown(3compat)],
64+
xref:nn_socket.3compat.adoc[nn_socket(3compat)],
65+
xref:nng_compat.3compat.adoc[nn_compat(3compat)],
66+
xref:nng.7.adoc[nng(7)]

docs/man/nn_device.3compat.adoc

+9-8
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,14 @@ received on one of the two sockets _sock1_ and _sock2_ are forwarded to
2929
the other.
3030

3131
NOTE: This function is provided for API
32-
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
33-
Consider using the relevant <<libnng.3#,modern API>> instead.
32+
xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
33+
Consider using the relevant xref:libnng.3.adoc[modern API] instead.
3434

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

4041
== RETURN VALUES
4142

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

5455
[.text-left]
55-
<<nn_errno.3compat#,nn_errno(3compat)>>,
56-
<<nn_socket.3compat#,nn_socket(3compat)>>,
57-
<<nng_compat.3compat#,nng_compat(3compat)>>,
58-
<<nng.7#,nng(7)>>
56+
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
57+
xref:nn_socket.3compat.adoc[nn_socket(3compat)],
58+
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
59+
xref:nng.7.adoc[nng(7)]

docs/man/nn_errno.3compat.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ The `nn_errno()` function returns the error number corresponding to the
2828
most recent failed operation by the calling thread.
2929

3030
NOTE: This function is provided for API
31-
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
32-
Consider using the relevant <<libnng.3#,modern API>> instead.
31+
xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
32+
Consider using the relevant xref:libnng.3.adoc[modern API] instead.
3333

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

7676
[.text-left]
77-
<<nn_strerror.3compat#,nn_strerror(3compat)>>,
78-
<<nng_compat.3compat#,nng_compat(3compat)>>,
79-
<<nng.7#,nng(7)>>
77+
xref:nn_strerror.3compat.adoc[nn_strerror(3compat)],
78+
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
79+
xref:nng.7.adoc[nng(7)]

docs/man/nn_freemsg.3compat.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,11 @@ int nn_freemsg(void *msg);
2525
== DESCRIPTION
2626

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

3030
NOTE: This function is provided for API
31-
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
32-
Consider using the relevant <<libnng.3#,modern API>> instead.
31+
xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
32+
Consider using the relevant xref:libnng.3.adoc[modern API] instead.
3333

3434
== RETURN VALUES
3535

@@ -42,8 +42,8 @@ None.
4242
== SEE ALSO
4343

4444
[.text-left]
45-
<<nn_allocmsg.3compat#,nn_allocmsg(3compat)>>,
46-
<<nn_freemsg.3compat#,nn_freemsg(3compat)>>,
47-
<<nn_errno.3compat#,nn_errno(3compat)>>,
48-
<<nng_compat.3compat#,nng_compat(3compat)>>,
49-
<<nng.7#,nng(7)>>
45+
xref:nn_allocmsg.3compat.adoc[nn_allocmsg(3compat)],
46+
xref:nn_freemsg.3compat.adoc[nn_freemsg(3compat)],
47+
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
48+
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
49+
xref:nng.7.adoc[nng(7)]

docs/man/nn_get_statistic.3compat.adoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ The `nn_get_statistic()` function exists only as a stub, and always returns
2828
zero.
2929

3030
NOTE: This function is provided for API
31-
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
32-
Consider using the relevant <<libnng.3#,modern API>> instead.
31+
xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
32+
Consider using the relevant xref:libnng.3.adoc[modern API] instead.
3333

3434
== RETURN VALUES
3535

@@ -42,5 +42,5 @@ None.
4242
== SEE ALSO
4343

4444
[.text-left]
45-
<<nng_compat.3compat#,nng_compat(3compat)>>,
46-
<<nng.7#,nng(7)>>
45+
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
46+
xref:nng.7.adoc[nng(7)]

docs/man/nn_getsockopt.3compat.adoc

+9-9
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ The `nn_getsockopt()` function gets a socket option on socket _sock_.
2828
The option retrieved is determined by the _level_ and _option_.
2929

3030
NOTE: This function is provided for API
31-
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
32-
Consider using the relevant <<libnng.3#,modern API>> instead.
31+
xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
32+
Consider using the relevant xref:libnng.3.adoc[modern API] instead.
3333

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

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

222222
[.text-left]
223-
<<nng_socket.5#,nng_socket(5)>>,
224-
<<nn_close.3compat#,nn_close(3compat)>>,
225-
<<nn_errno.3compat#,nn_errno(3compat)>>,
226-
<<nn_getsockopt.3compat#,nn_getsockopt(3compat)>>,
227-
<<nng_compat.3compat#,nng_compat(3compat)>>,
228-
<<nng.7#,nng(7)>>
223+
xref:nng_socket.5.adoc[nng_socket(5)],
224+
xref:nn_close.3compat.adoc[nn_close(3compat)],
225+
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
226+
xref:nn_getsockopt.3compat.adoc[nn_getsockopt(3compat)],
227+
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
228+
xref:nng.7.adoc[nng(7)]

docs/man/nn_poll.3compat.adoc

+10-10
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ int nn_poll(struct nn_pollfd *pfds, int npfd, int timeout);
3636
The `nn_poll()` function polls a group of sockets for readiness to send or receive.
3737

3838
NOTE: This function is provided for API
39-
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
40-
Consider using the relevant <<libnng.3#,modern API>> instead.
39+
xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
40+
Consider using the relevant xref:libnng.3.adoc[modern API] instead.
4141

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

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

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

9696
[.text-left]
97-
<<nn_errno.3compat#,nn_errno(3compat)>>,
98-
<<nn_recv.3compat#,nn_recv(3compat)>>,
99-
<<nn_send.3compat#,nn_send(3compat)>>,
100-
<<nn_socket.3compat#,nn_socket(3compat)>>,
101-
<<nng_compat.3compat#,nn_compat(3compat)>>,
102-
<<nng.7#,nng(7)>>
97+
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
98+
xref:nn_recv.3compat.adoc[nn_recv(3compat)],
99+
xref:nn_send.3compat.adoc[nn_send(3compat)],
100+
xref:nn_socket.3compat.adoc[nn_socket(3compat)],
101+
xref:nng_compat.3compat.adoc[nn_compat(3compat)],
102+
xref:nng.7.adoc[nng(7)]

docs/man/nn_reallocmsg.3compat.adoc

+7-7
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ void *nn_reallocmsg(void *old, size_t size);
2727
The `nn_reallocmsg()` reallocates the message _old_, making it of size _size_.
2828

2929
NOTE: This function is provided for API
30-
<<nng_compat.3compat#,compatibility>> with legacy _libnanomsg_.
31-
Consider using the relevant <<libnng.3#,modern API>> instead.
30+
xref:nng_compat.3compat.adoc[compatibility] with legacy _libnanomsg_.
31+
Consider using the relevant xref:libnng.3.adoc[modern API] instead.
3232

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

5454
[.text-left]
55-
<<nn_allocmsg.3compat#,nn_allocmsg(3compat)>>,
56-
<<nn_freemsg.3compat#,nn_freemsg(3compat)>>,
57-
<<nn_errno.3compat#,nn_errno(3compat)>>,
58-
<<nng_compat.3compat#,nng_compat(3compat)>>,
59-
<<nng.7#,nng(7)>>
55+
xref:nn_allocmsg.3compat.adoc[nn_allocmsg(3compat)],
56+
xref:nn_freemsg.3compat.adoc[nn_freemsg(3compat)],
57+
xref:nn_errno.3compat.adoc[nn_errno(3compat)],
58+
xref:nng_compat.3compat.adoc[nng_compat(3compat)],
59+
xref:nng.7.adoc[nng(7)]

0 commit comments

Comments
 (0)