docs: ares_set_local_ip4() uses host byte order (#368)

Properly document brain-dead behavior of ares_set_local_ip4() using host byte order instead of expected network byte order.

Fix By: Dustin Lundquist <d.lundquist@tempered.io>
pull/372/head
Dustin Lundquist 4 years ago committed by GitHub
parent c15f403875
commit 3d4e80b0d0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 4
      docs/ares_set_local_ip4.3
  2. 5
      docs/ares_set_local_ip6.3

@ -24,8 +24,8 @@ ares_set_local_ip4 \- Set local IPv4 address outgoing requests.
.fi
.SH DESCRIPTION
The \fBares_set_local_ip4\fP function sets the IP address for outbound
requests. This allows users to specify outbound interfaces when used
on multi-homed systems.
requests. The parameter \fIlocal_ip\fP is specified in host byte order. This
allows users to specify outbound interfaces when used on multi-homed systems.
.SH SEE ALSO
.BR ares_set_local_ip6 (3)
.SH NOTES

@ -24,8 +24,9 @@ ares_set_local_ip6 \- Set local IPv6 address outgoing requests.
.fi
.SH DESCRIPTION
The \fBares_set_local_ip6\fP function sets the IPv6 address for outbound
IPv6 requests. This allows users to specify outbound interfaces when used
on multi-homed systems. The local_ip6 argument must be 16 bytes in length.
IPv6 requests. The parameter \fIlocal_ip6\fP is specified in network byte
order. This allows users to specify outbound interfaces when used on
multi-homed systems. The local_ip6 argument must be 16 bytes in length.
.SH SEE ALSO
.BR ares_set_local_ip4 (3)
.SH NOTES

Loading…
Cancel
Save