From: Jay Conrod <jayconrod@google.com>
Date: Mon, 12 Apr 2021 20:37:31 +0000 (-0400)
Subject: doc: add release note for module deprecation
X-Git-Tag: go1.17beta1~610
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=cde92846e2;p=gostls13.git

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 <jayconrod@google.com>
Run-TryBot: Jay Conrod <jayconrod@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Bryan C. Mills <bcmills@google.com>
---

diff --git a/doc/go1.17.html b/doc/go1.17.html
index 66078b12a9..ef4086d2a5 100644
--- a/doc/go1.17.html
+++ b/doc/go1.17.html
@@ -43,6 +43,21 @@ Do not send CLs removing the interior tags from such phrases.
 
 <h3 id="go-command">Go command</h3>
 
+<h4 id="modules">Modules</h4>
+
+<p><!-- golang.org/issue/40357 -->
+  Module authors may deprecate a module by adding a
+  <a href="/ref/mod#go-mod-file-module-deprecation"><code>// Deprecated:</code>
+  comment</a> to <code>go.mod</code>, then tagging a new version.
+  <code>go</code> <code>get</code> now prints a warning if a module needed to
+  build packages named on the command line is deprecated. <code>go</code>
+  <code>list</code> <code>-m</code> <code>-u</code> prints deprecations for all
+  dependencies (use <code>-f</code> or <code>-json</code> to show the full
+  message). The <code>go</code> command considers different major versions to
+  be distinct modules, so this mechanism may be used, for example, to provide
+  users with migration instructions for a new major version.
+</p>
+
 <h4 id="go-get"><code>go</code> <code>get</code></h4>
 
 <p><!-- golang.org/issue/37519 -->