Skip to content

doc: document the lack of support for symlinks under GOPATH #21320

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.

Sign up for GitHub

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

Jump to bottom
Closed
ncantelmo opened this issue Aug 5, 2017 · 2 comments
Closed

doc: document the lack of support for symlinks under GOPATH #21320

ncantelmo opened this issue Aug 5, 2017 · 2 comments
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Go1.11

Comments

@ncantelmo
Copy link
Contributor

Quick back story:
I've spent much longer than I should publicly admit developing Go with go guru half working. Whenever I tried to jump to a symbol in the current package outside the current file, go guru would fail to find the identifier. This was annoying, but I've become accustomed enough to broken tooling that I didn't think too much of it after a search of the vim-go issue tracker didn't mention anything.

Today I got annoyed enough by the issue that I searched a bit harder and came across #20981 which in turn led me to #15507. Since I had been symlinking my privately hosted repo into my GOPATH, I immediately understood what was wrong. Fixing the issue was as simple as swapping the source and destination of my symlink. Now go guru finds all my symbols, which is great.

Anyway, the main issue here is that a lot of developers use symlinks for perfectly valid reasons, but GOPATH doesn't support them. This causes some elements of the go tooling to break without warning, and should therefore be prominently documented in go help gopath and https://golang.org/doc/code.html#GOPATH.

I can go ahead and submit a change, but I wanted to create an issue first to make sure this was fine.
@gopherbot gopherbot added the Documentation Issues describing a change to documentation. label Aug 5, 2017
@ALTree ALTree added this to the Go1.10 milestone Aug 7, 2017
@ALTree ALTree added the NeedsFix The path to resolution is known, but the work has not been done. label Aug 7, 2017
@ALTree
Copy link
Member

ALTree commented Aug 7, 2017 •
edited
Loading

Seems reasonable (likely for go1.10). I would send a gerrit change so reviewers can bikeshed there about the exact wording and where in the page the warning should be.

@gopherbot
Copy link
Contributor

Change https://golang.org/cl/61930 mentions this issue: doc: document the lack of support for symlinks under GOPATH

@rsc rsc modified the milestones: Go1.10, Go1.11 Dec 1, 2017
dna2github pushed a commit to dna2fork/go that referenced this issue Jun 14, 2018
@ncantelmo @dna2github
doc: document the lack of support for symlinks under GOPATH
f080809 
In an effort to help others avoid the issues I've hit due to lack of
symlink support under GOPATH, I've added a note of warning to the
Workspaces section.

I have not changed the contents of go help gopath, because on reflection
it seems this change alone may be sufficient.

Fixes golang#21320

Change-Id: Ib8969bf12cecad878e89ff66b5864bbf3caaf219
Reviewed-on: https://go-review.googlesource.com/61930
Reviewed-by: Ian Lance Taylor <iant@golang.org>
@golang golang locked and limited conversation to collaborators Jun 12, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Go1.11
Development

No branches or pull requests
4 participants
@rsc @ncantelmo @ALTree @gopherbot