summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNathan Cantelmo <n.cantelmo@gmail.com>2017-09-06 11:19:25 -0400
committerIan Lance Taylor <iant@golang.org>2018-06-12 23:52:02 +0000
commit4f6b9ed5adffbfb38f10fd1843d5f6f731ece884 (patch)
tree57efc985e4fea36c99d588ac9059e0ed57c77fa1
parentb768d82d8e19493e287b9f6c3219cd253d3ccb42 (diff)
downloadgo-git-4f6b9ed5adffbfb38f10fd1843d5f6f731ece884.tar.gz
doc: document the lack of support for symlinks under GOPATH
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 #21320 Change-Id: Ib8969bf12cecad878e89ff66b5864bbf3caaf219 Reviewed-on: https://go-review.googlesource.com/61930 Reviewed-by: Ian Lance Taylor <iant@golang.org>
-rw-r--r--doc/code.html4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/code.html b/doc/code.html
index f22e6b4919..92616a5a5a 100644
--- a/doc/code.html
+++ b/doc/code.html
@@ -111,6 +111,10 @@ and dependencies in a single workspace.
</p>
<p>
+Note that symbolic links should <b>not</b> be used to link files or directories into your workspace.
+</p>
+
+<p>
Commands and libraries are built from different kinds of source packages.
We will discuss the distinction <a href="#PackageNames">later</a>.
</p>