Skip to content

Commit cde9284

Browse files
author
Jay Conrod
committed
doc: add release note for module deprecation
Fixes #40357 Change-Id: I876edd7364530b77343ebcdd4032390493f8d031 Reviewed-on: https://go-review.googlesource.com/c/go/+/309549 Trust: Jay Conrod <[email protected]> Run-TryBot: Jay Conrod <[email protected]> TryBot-Result: Go Bot <[email protected]> Reviewed-by: Bryan C. Mills <[email protected]>
1 parent 52df929 commit cde9284

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

doc/go1.17.html

+15
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,21 @@ <h2 id="tools">Tools</h2>
4343

4444
<h3 id="go-command">Go command</h3>
4545

46+
<h4 id="modules">Modules</h4>
47+
48+
<p><!-- golang.org/issue/40357 -->
49+
Module authors may deprecate a module by adding a
50+
<a href="/ref/mod#go-mod-file-module-deprecation"><code>// Deprecated:</code>
51+
comment</a> to <code>go.mod</code>, then tagging a new version.
52+
<code>go</code> <code>get</code> now prints a warning if a module needed to
53+
build packages named on the command line is deprecated. <code>go</code>
54+
<code>list</code> <code>-m</code> <code>-u</code> prints deprecations for all
55+
dependencies (use <code>-f</code> or <code>-json</code> to show the full
56+
message). The <code>go</code> command considers different major versions to
57+
be distinct modules, so this mechanism may be used, for example, to provide
58+
users with migration instructions for a new major version.
59+
</p>
60+
4661
<h4 id="go-get"><code>go</code> <code>get</code></h4>
4762

4863
<p><!-- golang.org/issue/37519 -->

0 commit comments

Comments
 (0)