os/signal: document behavior of SIGPIPE on non-Go thread

Fixes #56150

Change-Id: Id990783562950ba8be7ce9526b7a811625f2190a
Reviewed-on: https://go-review.googlesource.com/c/go/+/442415
Run-TryBot: Ian Lance Taylor <iant@google.com>
Reviewed-by: Ian Lance Taylor <iant@google.com>
Reviewed-by: Michael Pratt <mpratt@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Auto-Submit: Ian Lance Taylor <iant@google.com>
Run-TryBot: Ian Lance Taylor <iant@golang.org>

diff --git a/src/os/signal/doc.go b/src/os/signal/doc.go
index ab262edc58a2e45bdbfdecef8c13e62f4787ba59..1b9f40d9a8884693ed2248b134c437a1a3ecf910 100644 (file)
--- a/src/os/signal/doc.go
+++ b/src/os/signal/doc.go
@@ -164,6 +164,12 @@ signal, and raises it again, to invoke any non-Go handler or default
 system handler. If the program does not exit, the Go handler then
 reinstalls itself and continues execution of the program.
 
+If a SIGPIPE signal is received, the Go program will invoke the
+special handling described above if the SIGPIPE is received on a Go
+thread.  If the SIGPIPE is received on a non-Go thread the signal will
+be forwarded to the non-Go handler, if any; if there is none the
+default system handler will cause the program to terminate.
+
 # Non-Go programs that call Go code
 
 When Go code is built with options like -buildmode=c-shared, it will