From: Nathan Cantelmo <n.cantelmo@gmail.com>
Date: Wed, 6 Sep 2017 15:19:25 +0000 (-0400)
Subject: doc: document the lack of support for symlinks under GOPATH
X-Git-Tag: go1.11beta1~128
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=4f6b9ed5adffbfb38f10fd1843d5f6f731ece884;p=gostls13.git

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>
---

diff --git a/doc/code.html b/doc/code.html
index f22e6b4919..92616a5a5a 100644
--- a/doc/code.html
+++ b/doc/code.html
@@ -110,6 +110,10 @@ packages and commands. Most Go programmers keep <i>all</i> their Go source code
 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>.