[PATCH] sigwait.3: note sigprocmask(2) requirement, explicitly link sigtimedwait(2)/NOTES

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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@xxxxxxxxxxxxxxxxxx>
---
 man3/sigwait.3 | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/man3/sigwait.3 b/man3/sigwait.3
index 226a97e6f..b65cd4db3 100644
--- a/man3/sigwait.3
+++ b/man3/sigwait.3
@@ -36,6 +36,8 @@ .SH DESCRIPTION
 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 +83,9 @@ .SH ATTRIBUTES
 .SH VERSIONS
 .BR sigwait ()
 is implemented using
-.BR sigtimedwait (2).
+.BR sigtimedwait (2);
+consult its
+.BR NOTES .
 .P
 The glibc implementation of
 .BR sigwait ()
-- 
2.39.2

Attachment: signature.asc
Description: PGP signature


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux