aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorBrad Fitzpatrick <bradfitz@golang.org>2014-09-24 17:39:00 -0700
committerBrad Fitzpatrick <bradfitz@golang.org>2014-09-24 17:39:00 -0700
commitdfaf1f71e67de2807e07c880060b457d32a66b8b (patch)
tree6c9dafe90cb72f4901205bf04f66e755dc47e22f /src
parente59ad69a44df7f00c5afab3716374f80d1bb47c7 (diff)
downloadgo-dfaf1f71e67de2807e07c880060b457d32a66b8b.tar.xz
net/http: update ProxyFromEnvironment docs for HTTPS_PROXY addition
LGTM=adg R=adg CC=golang-codereviews https://golang.org/cl/142650043
Diffstat (limited to 'src')
-rw-r--r--src/net/http/transport.go13
1 files changed, 10 insertions, 3 deletions
diff --git a/src/net/http/transport.go b/src/net/http/transport.go
index 6be341faa9..f1a6837527 100644
--- a/src/net/http/transport.go
+++ b/src/net/http/transport.go
@@ -116,10 +116,17 @@ type Transport struct {
// ProxyFromEnvironment returns the URL of the proxy to use for a
// given request, as indicated by the environment variables
-// $HTTP_PROXY and $NO_PROXY (or $http_proxy and $no_proxy).
-// An error is returned if the proxy environment is invalid.
+// HTTP_PROXY, HTTPS_PROXY and NO_PROXY (or the lowercase versions
+// thereof). HTTPS_PROXY takes precedence over HTTP_PROXY for https
+// requests.
+//
+// The environment values may be either a complete URL or a
+// "host[:port]", in which case the "http" scheme is assumed.
+// An error is returned if the value is a different form.
+//
// A nil URL and nil error are returned if no proxy is defined in the
-// environment, or a proxy should not be used for the given request.
+// environment, or a proxy should not be used for the given request,
+// as defined by NO_PROXY.
//
// As a special case, if req.URL.Host is "localhost" (with or without
// a port number), then a nil URL and nil error will be returned.