From f474885f8a44d3c00e2f11315628fa80fda9404c Mon Sep 17 00:00:00 2001 From: Russ Cox Date: Thu, 17 Dec 2015 01:00:14 -0500 Subject: [PATCH] cmd/go: document where get writes, and not vendor directories Fixes #12260. Change-Id: I95c27aad6de8064b9a205d4ee507bce75926f16d Reviewed-on: https://go-review.googlesource.com/17948 Reviewed-by: Brad Fitzpatrick --- src/cmd/go/alldocs.go | 6 ++++++ src/cmd/go/get.go | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/src/cmd/go/alldocs.go b/src/cmd/go/alldocs.go index 6fe2b9e2b4..96aed49ee2 100644 --- a/src/cmd/go/alldocs.go +++ b/src/cmd/go/alldocs.go @@ -497,6 +497,10 @@ missing packages but does not use it to look for updates to existing packages. Get also accepts build flags to control the installation. See 'go help build'. +When checking out a new package, get creates the target directory +GOPATH/src/. If the GOPATH contains multiple entries, +get uses the first one. See 'go help gopath'. + When checking out or updating a package, get looks for a branch or tag that matches the locally installed version of Go. The most important rule is that if the local installation is running version "go1", get @@ -507,6 +511,8 @@ Unless vendoring support is disabled (see 'go help gopath'), when go get checks out or updates a Git repository, it also updates any git submodules referenced by the repository. +Get never checks out or updates code stored in vendor directories. + For more about specifying packages, see 'go help packages'. For more about how 'go get' finds source code to diff --git a/src/cmd/go/get.go b/src/cmd/go/get.go index d97afb90de..a298049a9d 100644 --- a/src/cmd/go/get.go +++ b/src/cmd/go/get.go @@ -45,6 +45,10 @@ missing packages but does not use it to look for updates to existing packages. Get also accepts build flags to control the installation. See 'go help build'. +When checking out a new package, get creates the target directory +GOPATH/src/. If the GOPATH contains multiple entries, +get uses the first one. See 'go help gopath'. + When checking out or updating a package, get looks for a branch or tag that matches the locally installed version of Go. The most important rule is that if the local installation is running version "go1", get @@ -55,6 +59,8 @@ Unless vendoring support is disabled (see 'go help gopath'), when go get checks out or updates a Git repository, it also updates any git submodules referenced by the repository. +Get never checks out or updates code stored in vendor directories. + For more about specifying packages, see 'go help packages'. For more about how 'go get' finds source code to -- 2.50.0