From: Mikio Hara <mikioh.mikioh@gmail.com>
Date: Sun, 8 Jan 2017 08:29:26 +0000 (+0900)
Subject: net: update documentation on JoinHostPort and SplitHostPort
X-Git-Tag: go1.9beta2~26
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=ac7f7ecaeb1261262963992496c2562c839fc272;p=gostls13.git

net: update documentation on JoinHostPort and SplitHostPort

This change adds a reference to the Dial to clarify the parameters and
return values.

Change-Id: I611b9a79f4033ef035acd7098aea5965905d9a4c
Reviewed-on: https://go-review.googlesource.com/34880
Reviewed-by: Ian Lance Taylor <iant@golang.org>
---

diff --git a/src/net/ipsock.go b/src/net/ipsock.go
index 201c3f58bc..7dafcaf630 100644
--- a/src/net/ipsock.go
+++ b/src/net/ipsock.go
@@ -127,6 +127,9 @@ func ipv6only(addr IPAddr) bool {
 //
 // A literal IPv6 address in hostport must be enclosed in square
 // brackets, as in "[::1]:80", "[::1%lo0]:80".
+//
+// See func Dial for a description of the hostport parameter, and host
+// and port results.
 func SplitHostPort(hostport string) (host, port string, err error) {
 	const (
 		missingPort   = "missing port in address"
@@ -196,6 +199,8 @@ func splitHostZone(s string) (host, zone string) {
 // JoinHostPort combines host and port into a network address of the
 // form "host:port". If host contains a colon, as found in literal
 // IPv6 addresses, then JoinHostPort returns "[host]:port".
+//
+// See func Dial for a description of the host and port parameters.
 func JoinHostPort(host, port string) string {
 	// We assume that host is a literal IPv6 address if host has
 	// colons.