diff options
| author | Dave Henderson <dhenderson@gmail.com> | 2018-05-18 13:09:07 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-18 13:09:07 -0400 |
| commit | 2fa15d29375d7330594d8ee5d47c1dc95ddf472e (patch) | |
| tree | 06e47abca16d65bb9b2c276c4cb0518a9affd79f /docs | |
| parent | ac76843e7bf4f67224e35ffd7271e41b2af01600 (diff) | |
| parent | 8ba7f5e47cbb23cfc504ea477dceb0c071da0f2f (diff) | |
Merge pull request #330 from kwilczynski/f-add-missing-anchor-for-rfc1918
Add missing anchor for RFC 1918 link in sockaddr documentation.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/functions/sockaddr.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/content/functions/sockaddr.md b/docs/content/functions/sockaddr.md index 81f2dba8..602bd557 100644 --- a/docs/content/functions/sockaddr.md +++ b/docs/content/functions/sockaddr.md @@ -49,7 +49,7 @@ Returns an array of `IfAddr`s containing every IP that matches [RFC 6890][], is attached to the interface with the default route, and is a forwardable IP address. -**Note:** RFC 6890 is a more exhaustive version of [RFC 1918][] +**Note:** [RFC 6890][] is a more exhaustive version of [RFC 1918][] because it spans IPv4 and IPv6, however it does permit the inclusion of likely undesired addresses such as multicast, therefore our definition of a "private" address also excludes non-forwardable IP addresses (as defined by the IETF). @@ -370,4 +370,5 @@ $ gomplate -i '{{ sockaddr.GetInterfaceIPs "en0" }}' 10.0.0.28 fe80::1f9a:5582:4b41:bd18 ``` +[RFC 1918]: http://tools.ietf.org/html/rfc1918 [RFC 6890]: http://tools.ietf.org/html/rfc6890 |