aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorнаб <nabijaczleweli@nabijaczleweli.xyz>2024-04-03 17:06:45 +0200
committerAlejandro Colomar <alx@kernel.org>2024-04-04 10:46:59 +0200
commit5788bf3d81934f21ce9c602d623c9b31cf2bedc4 (patch)
tree71124befc6c88bd4918c4de9f37678ce9df28b1d
parentc1e10426dc22ca976ba1107f7ca95a373bb22f83 (diff)
downloadman-pages-5788bf3d81934f21ce9c602d623c9b31cf2bedc4.tar.gz
sigwait.3: Note sigprocmask(2) requirement, explicitly link sigtimedwait(2)/NOTES
This comes from a real user complaint. sigwait(3) is the most obvious of the family, and it doesn't mention any of the usage details. Most of these can be crosslinked, but not mentioning the sigprocmask(2) requirement is malice. Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz> Signed-off-by: Alejandro Colomar <alx@kernel.org>
-rw-r--r--man3/sigwait.37
1 files changed, 6 insertions, 1 deletions
diff --git a/man3/sigwait.3 b/man3/sigwait.3
index 226a97e6fa..2c3330015b 100644
--- a/man3/sigwait.3
+++ b/man3/sigwait.3
@@ -36,6 +36,9 @@ function suspends execution of the calling thread until
one of the signals specified in the signal set
.I set
becomes pending.
+For a signal to become pending,
+it must first be blocked with
+.BR sigprocmask (2).
The function accepts the signal
(removes it from the pending list of signals),
and returns the signal number in
@@ -81,7 +84,9 @@ T} Thread safety MT-Safe
.SH VERSIONS
.BR sigwait ()
is implemented using
-.BR sigtimedwait (2).
+.BR sigtimedwait (2);
+consult its
+.BR NOTES .
.P
The glibc implementation of
.BR sigwait ()