Skip to content

Commit 0fb3e2c

Browse files
author
Bryan C. Mills
committed
doc/go1.17: add a release note for the '-compat' flag to 'go mod tidy'
Updates golang#46141 Change-Id: I7a6a84f816e3db19bb492f862366a29dc46ed2ee Reviewed-on: https://go-review.googlesource.com/c/go/+/325910 Trust: Bryan C. Mills <[email protected]> Run-TryBot: Bryan C. Mills <[email protected]> TryBot-Result: Go Bot <[email protected]> Reviewed-by: Michael Matloob <[email protected]>
1 parent 2169deb commit 0fb3e2c

1 file changed

Lines changed: 29 additions & 4 deletions

File tree

‎doc/go1.17.html‎

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,9 @@ <h4 id="lazy-loading">Lazy module loading</h4>
137137
<!-- TODO(bcmills): replace the design-doc link with proper documentation. -->
138138
</p>
139139

140-
<p><!-- golang.org/issue/45094 --> To facilitate the upgrade to lazy loading,
141-
the <code>go</code> <code>mod</code> <code>tidy</code> subcommand now supports
140+
<p><!-- golang.org/issue/45094 -->
141+
To facilitate the upgrade to lazy loading, the
142+
<code>go</code> <code>mod</code> <code>tidy</code> subcommand now supports
142143
a <code>-go</code> flag to set or change the <code>go</code> version in
143144
the <code>go.mod</code> file. To enable lazy loading for an existing module
144145
without changing the selected versions of its dependencies, run:
@@ -149,8 +150,32 @@ <h4 id="lazy-loading">Lazy module loading</h4>
149150
</pre>
150151

151152
<p><!-- golang.org/issue/46141 -->
152-
TODO: Describe the <code>-compat</code> flag
153-
for <code>go</code> <code>mod</code> <code>tidy</code>.
153+
By default, <code>go</code> <code>mod</code> <code>tidy</code> verifies that
154+
the selected versions of dependencies relevant to the main module are the same
155+
versions that would be used by the prior Go release (Go 1.16 for a module that
156+
spsecifies <code>go</code> <code>1.17</code>), and preserves
157+
the <code>go.sum</code> entries needed by that release even for dependencies
158+
that are not normally needed by other commands.
159+
</p>
160+
161+
<p>
162+
The <code>-compat</code> flag allows that version to be overridden to support
163+
older (or only newer) versions, up to the version specified by
164+
the <code>go</code> directive in the <code>go.mod</code> file. To tidy
165+
a <code>go</code> <code>1.17</code> module for Go 1.17 only, without saving
166+
checksums for (or checking for consistency with) Go 1.16:
167+
</p>
168+
169+
<pre>
170+
go mod tidy -compat=1.17
171+
</pre>
172+
173+
<p>
174+
Note that even if the main module is tidied with <code>-compat=1.17</code>,
175+
users who <code>require</code> the module from a
176+
<code>go</code> <code>1.16</code> or earlier module will still be able to
177+
use it, provided that the packages use only compatible language and library
178+
features.
154179
</p>
155180

156181
<h4 id="module-deprecation-comments">Module deprecation comments</h4>

0 commit comments

Comments
 (0)