]> Cypherpunks repositories - gostls13.git/commitdiff
net/http: add missing ServeTLS on the comment of http.Server.Shutdown
authort-katsumura <t.katsumura.ggl@gmail.com>
Sat, 10 May 2025 23:43:40 +0000 (08:43 +0900)
committerGopher Robot <gobot@golang.org>
Mon, 12 May 2025 17:08:48 +0000 (10:08 -0700)
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>
src/net/http/server.go

index f2bedb7d6adb5ffac73f43c27417809eaccc5f5c..5dd21bdf3f198f093768e701ba4f4a164c4ed25a 100644 (file)
@@ -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.
 //