From: t-katsumura <t.katsumura.ggl@gmail.com>
Date: Sat, 10 May 2025 23:43:40 +0000 (+0900)
Subject: net/http: add missing ServeTLS on the comment of http.Server.Shutdown
X-Git-Tag: go1.25rc1~302
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=e513cd4e409f1d42df02a42b43eceb87473b229a;p=gostls13.git

net/http: add missing ServeTLS on the comment of http.Server.Shutdown

A sentinel error http.ErrServerClosed is returned after Server.Shutdown
and Server.Close but it is not documented on the Server.Shutdown while
other methods such as Server.Serve are documented on it.

Change-Id: Id82886d9d6a1474a514d62e9169b35f3579a9eee
Reviewed-on: https://go-review.googlesource.com/c/go/+/671695
Reviewed-by: Cherry Mui <cherryyz@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Auto-Submit: Sean Liao <sean@liao.dev>
Reviewed-by: Michael Knyszek <mknyszek@google.com>
Reviewed-by: Sean Liao <sean@liao.dev>
---

diff --git a/src/net/http/server.go b/src/net/http/server.go
index f2bedb7d6a..5dd21bdf3f 100644
--- a/src/net/http/server.go
+++ b/src/net/http/server.go
@@ -3154,7 +3154,7 @@ const shutdownPollIntervalMax = 500 * time.Millisecond
 // Shutdown returns the context's error, otherwise it returns any
 // error returned from closing the [Server]'s underlying Listener(s).
 //
-// When Shutdown is called, [Serve], [ListenAndServe], and
+// When Shutdown is called, [Serve], [ServeTLS], [ListenAndServe], and
 // [ListenAndServeTLS] immediately return [ErrServerClosed]. Make sure the
 // program doesn't exit and waits instead for Shutdown to return.
 //