aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorOlivier Mengué <olivier.mengue@gmail.com>2025-04-24 16:46:44 +0200
committerGopher Robot <gobot@golang.org>2025-06-06 14:05:14 -0700
commit0ccfbc834a489f92745613b2e06275c2cfe6ace0 (patch)
tree9c56f1dcf6cdc32881f812c6e7a615a5c9329c93 /src
parent78eadf5b3de568297456fe137b65ff16e8cc8bb6 (diff)
downloadgo-0ccfbc834a489f92745613b2e06275c2cfe6ace0.tar.xz
os/signal: doc link to syscall.EPIPE
Add godoc link for EPIPE error. Change-Id: I5df35f700684510328f92bb5d4946c5123ba5f2c Reviewed-on: https://go-review.googlesource.com/c/go/+/667757 Auto-Submit: Michael Knyszek <mknyszek@google.com> Reviewed-by: Michael Pratt <mpratt@google.com> Reviewed-by: Michael Knyszek <mknyszek@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Diffstat (limited to 'src')
-rw-r--r--src/os/signal/doc.go7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/os/signal/doc.go b/src/os/signal/doc.go
index 1d3e6eb573..df942b8428 100644
--- a/src/os/signal/doc.go
+++ b/src/os/signal/doc.go
@@ -98,12 +98,13 @@ the behavior depends on the file descriptor number. A write to a
broken pipe on file descriptors 1 or 2 (standard output or standard
error) will cause the program to exit with a SIGPIPE signal. A write
to a broken pipe on some other file descriptor will take no action on
-the SIGPIPE signal, and the write will fail with an EPIPE error.
+the SIGPIPE signal, and the write will fail with a [syscall.EPIPE]
+error.
If the program has called Notify to receive SIGPIPE signals, the file
descriptor number does not matter. The SIGPIPE signal will be
-delivered to the Notify channel, and the write will fail with an EPIPE
-error.
+delivered to the Notify channel, and the write will fail with a
+[syscall.EPIPE] error.
This means that, by default, command line programs will behave like
typical Unix command line programs, while other programs will not