diff options
| author | Michael Matloob <matloob@golang.org> | 2020-12-01 21:45:49 -0500 |
|---|---|---|
| committer | Michael Matloob <matloob@golang.org> | 2020-12-11 17:26:14 +0000 |
| commit | 1341a3decd00d1106efaa73c5ff4ffcabc4e6afd (patch) | |
| tree | b465c31b6a2c692490c92caf5f6ad1d0b9feb27f /doc | |
| parent | e508c1c67b02dceea146ce3472c0f8ce9e60632c (diff) | |
| download | go-1341a3decd00d1106efaa73c5ff4ffcabc4e6afd.tar.gz go-1341a3decd00d1106efaa73c5ff4ffcabc4e6afd.zip | |
cmd/go: add documentation for the -overlay flag
Also add -overlay to the Go 1.16 release notes.
For #40700
Fixes #39958
Fixes #42893
Change-Id: Ifd397549e368b255e7b8800986cfa0563a942af5
Reviewed-on: https://go-review.googlesource.com/c/go/+/274714
Trust: Michael Matloob <matloob@golang.org>
Run-TryBot: Michael Matloob <matloob@golang.org>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Bryan C. Mills <bcmills@google.com>
Reviewed-by: Jay Conrod <jayconrod@google.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/go1.16.html | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/go1.16.html b/doc/go1.16.html index e0187effd7..2ff763f9b6 100644 --- a/doc/go1.16.html +++ b/doc/go1.16.html @@ -271,6 +271,20 @@ Do not send CLs removing the interior tags from such phrases. but without the extra step. </p> +<h4 id="overlay-flag">The <code>-overlay</code> flag</h4> + +<p><!-- golang.org/issue/39958 --> + The <code>-overlay</code> flag specifies a JSON configuration file containing + a set of file path replacements. The <code>-overlay</code> flag may be used + with all build commands and <code>go</code> <code>mod</code> subcommands. + It is primarily intended to be used by editor tooling such as gopls to + understand the effects of unsaved changes to source files. The config file + maps actual file paths to replacement file paths and the <code>go</code> + command and its builds will run as if the actual file paths exist with the + contents given by the replacement file paths, or don't exist if the replacement + file paths are empty. +</p> + <h3 id="cgo">Cgo</h3> <p><!-- CL 252378 --> |