Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmd/go: document that "go get" never operates on vendor directories #12260

Closed
jbuberel opened this issue Aug 21, 2015 · 2 comments
Closed

cmd/go: document that "go get" never operates on vendor directories #12260

jbuberel opened this issue Aug 21, 2015 · 2 comments

Comments

@jbuberel
Copy link

In the docs here:
https://golang.org/cmd/go/#hdr-Vendor_Directories

There is a single section that mentions how the behavior of go get changes when the GO15VENDOREXPERIMENT env var is enabled:

When the vendor experiment is enabled, 'go get' 
checks out submodules when checking out or 
updating a git repository (see 'go help get').

A source of confusion and many questions (twitter, slack) results from the assumption that running go get with the flag enabled will place downloaded packages into a vendor directory, which is not the case. A sentence or two added to the documentation would help:

When the vendor experiment is enabled, 'go get' 
checks out submodules when checking out or 
updating a git repository (see 'go help get'). 
The storage location of downloaded packages 
does not change with the experiment enabled; 
'go get' will not place retrieved packages into a
'vendor' directory. 

Is it possible to update the documentation prior to the next release?

@rsc
Copy link
Contributor

rsc commented Aug 25, 2015

I think we typically avoid non-essential fixes in point releases, especially docs for an experimental feature off by default.

I did add some text to the bottom of golang.org/s/go15vendor.

@rsc rsc modified the milestones: Go1.6, Go1.5.1 Aug 25, 2015
@rsc rsc changed the title cmd/go: Documentation fix for go get behavior when GO15VENDOREXPERIMENT is enabled cmd/go: document that "go get" never operates on vendor directories Nov 5, 2015
@gopherbot
Copy link

CL https://golang.org/cl/17948 mentions this issue.

@rsc rsc closed this as completed in f474885 Dec 17, 2015
@golang golang locked and limited conversation to collaborators Dec 29, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

4 participants