diff options
| author | Alejandro Colomar <alx@kernel.org> | 2023-03-17 17:08:01 +0100 |
|---|---|---|
| committer | Alejandro Colomar <alx@kernel.org> | 2023-03-30 15:14:55 +0200 |
| commit | 4131356cdab8d37fc395ca5466a0401c8573380c (patch) | |
| tree | 8c4c6f1c3172358b735b481cbbfdd9cc04b00ed9 /man3/sigpause.3 | |
| parent | fd00f831b52d61a91d59cb3b46182869145d9700 (diff) | |
| download | man-pages-4131356cdab8.tar.gz | |
man*/, man-pages.7: VERSIONS, STANDARDS, HISTORY: Reorganize sections
- Add a new HISTORY section that covers the history of an API, both
regarding implementations and regarding old standards. This was
previously covered in VERSIONS, and in some cases in STANDARDS.
- Repurpose VERSIONS to cover differing implementations in _current_
systems.
- STANDARDS is reduced to only cover current versions of standards.
That basically means only C11 (C99 has been superseeded by C11; C17
is just a bugfix of C11, so not really a new version), and
POSIX.1-2008 (*-2001 was superseeded by *-2008; *-2017 was just a
bugfix for *-2008). The section also mentions for example 'Linux',
'GNU' or 'BSD' when a non-standard API is Linux- or GNU-only or if
it's (de-facto) standard in the BSDs.
- In some cases content that should go into one of these sections was
in NOTES. Move it from there to where it corresponds.
- In the SYNOPSIS, I added [[deprecated]] in some functions that I
found are deprecated by the relevant standards.
- A few other related changes...
Cc: Oskari Pirhonen <xxc3ncoredxx@gmail.com>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man3/sigpause.3')
| -rw-r--r-- | man3/sigpause.3 | 49 |
1 files changed, 24 insertions, 25 deletions
diff --git a/man3/sigpause.3 b/man3/sigpause.3 index 78b0608b23..bbe743462e 100644 --- a/man3/sigpause.3 +++ b/man3/sigpause.3 @@ -13,9 +13,9 @@ Standard C library .nf .B #include <signal.h> .PP -.BI "int sigpause(int " sigmask "); /* BSD (but see NOTES) */" +.BI "[[deprecated]] int sigpause(int " sigmask "); /* BSD (but see NOTES) */" .PP -.BI "int sigpause(int " sig "); /* System V / UNIX 95 */" +.BI "[[deprecated]] int sigpause(int " sig "); /* POSIX.1 / SysV / UNIX 95 */" .fi .SH DESCRIPTION Don't use this function. @@ -62,29 +62,7 @@ T} Thread safety MT-Safe .\" glibc manual says /!linux!bsd indicate the preceding marker only applies .\" when the underlying kernel is neither Linux nor a BSD kernel. .\" So, it is safe in Linux kernel. -.SH STANDARDS -The System V version of -.BR sigpause () -is standardized in POSIX.1-2001. -It is also specified in POSIX.1-2008, where it is marked obsolete. -.SH NOTES -.SS History -The classical BSD version of this function appeared in 4.2BSD. -It sets the process's signal mask to -.IR sigmask . -UNIX 95 standardized the incompatible System V version of -this function, which removes only the specified signal -.I sig -from the process's signal mask. -.\" __xpg_sigpause: UNIX 95, spec 1170, SVID, SVr4, XPG -The unfortunate situation with two incompatible functions with the -same name was solved by the -.BR \%sigsuspend (2) -function, that takes a -.I "sigset_t\ *" -argument (instead of an -.IR int ). -.SS Linux notes +.SH VERSIONS On Linux, this routine is a system call only on the Sparc (sparc64) architecture. .PP @@ -119,6 +97,27 @@ should be amended to use .\" For the BSD version, one usually uses a zero .\" .I sigmask .\" to indicate that no signals are to be blocked. +.SH STANDARDS +POSIX.1-2008. +.SH HISTORY +POSIX.1-2001. +Obsoleted in POSIX.1-2008. +.PP +The classical BSD version of this function appeared in 4.2BSD. +It sets the process's signal mask to +.IR sigmask . +UNIX 95 standardized the incompatible System V version of +this function, which removes only the specified signal +.I sig +from the process's signal mask. +.\" __xpg_sigpause: UNIX 95, spec 1170, SVID, SVr4, XPG +The unfortunate situation with two incompatible functions with the +same name was solved by the +.BR \%sigsuspend (2) +function, that takes a +.I "sigset_t\ *" +argument (instead of an +.IR int ). .SH SEE ALSO .BR kill (2), .BR sigaction (2), |