From: Mikio Hara <mikioh.mikioh@gmail.com>
Date: Fri, 16 Dec 2016 09:45:55 +0000 (+0900)
Subject: net: clarify IP.IsGlobalUnicast docs
X-Git-Tag: go1.8rc1~94
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=7799022cddf440f79463afdad969360a2ca86a9e;p=gostls13.git

net: clarify IP.IsGlobalUnicast docs

Fixes #18181.

Change-Id: I5eed99dfb7b013aa4d4e668e95a97f5bb643d307
Reviewed-on: https://go-review.googlesource.com/34531
Run-TryBot: Mikio Hara <mikioh.mikioh@gmail.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
---

diff --git a/src/net/ip.go b/src/net/ip.go
index 4a7774ab38..db3364c1b3 100644
--- a/src/net/ip.go
+++ b/src/net/ip.go
@@ -153,6 +153,12 @@ func (ip IP) IsLinkLocalUnicast() bool {
 
 // IsGlobalUnicast reports whether ip is a global unicast
 // address.
+//
+// The identification of global unicast addresses uses address type
+// identification as defined in RFC 1122, RFC 4632 and RFC 4291 with
+// the exception of IPv4 directed broadcast addresses.
+// It returns true even if ip is in IPv4 private address space or
+// local IPv6 unicast address space.
 func (ip IP) IsGlobalUnicast() bool {
 	return (len(ip) == IPv4len || len(ip) == IPv6len) &&
 		!ip.Equal(IPv4bcast) &&