diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-05-29 17:03:51 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-05-29 18:14:55 -0700 |
| commit | 0ddaee41ec753805fa12eeabd679870802528dac (patch) | |
| tree | 3418859f4f22e9857b5ae979b3bc4eb53fd70035 /docs/man/nn_sendmsg.3compat.adoc | |
| parent | 33dc5d611f578ace9833a80dc006a34b09da18af (diff) | |
| download | nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.gz nng-0ddaee41ec753805fa12eeabd679870802528dac.tar.bz2 nng-0ddaee41ec753805fa12eeabd679870802528dac.zip | |
fixes #495 SEE ALSO should use [align=left]
fixes #494 ERRORS section should use [horizontal]
These changes address some basic formatting consistency things,
and ultimately (when combined with other tooling changes that are
not part of this repo) lead to vastly improved layout in the
printed documentation.
While here we removed trailing whitespace, and did certain other
minor markup tweaks.
Diffstat (limited to 'docs/man/nn_sendmsg.3compat.adoc')
| -rw-r--r-- | docs/man/nn_sendmsg.3compat.adoc | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/man/nn_sendmsg.3compat.adoc b/docs/man/nn_sendmsg.3compat.adoc index 71a69c14..8a3487c8 100644 --- a/docs/man/nn_sendmsg.3compat.adoc +++ b/docs/man/nn_sendmsg.3compat.adoc @@ -61,7 +61,7 @@ has the base address (`iov_base`) and length (`iov_len`) indicated. For buffers allocated for zero copy (such as by `<<nn_allocmsg.3compat#,nn_allocmsg()>>`), the value of `iov_base` should be the address of the pointer to the buffer, -rather than the address of the buffer itself. +rather than the address of the buffer itself. In this case, the value of `iov_len` should be `NN_MSG`, as the length is inferred from the allocated message. If the `msg_iovlen` field is `NN_MSG`, then this function will free @@ -97,6 +97,7 @@ This function returns the number of bytes sent on success, and -1 on error. == SEE ALSO +[.text-left] <<nn_cmsg.3compat#,nn_cmsg(3compat)>>, <<nn_errno.3compat#,nn_errno(3compat)>>, <<nn_recv.3compat#,nn_recv(3compat)>>, |