[PATCH] manual: Document the System V sigpause function

Florian Weimer fweimer@redhat.com
Sat May 16 09:25:15 GMT 2020


* Michael Kerrisk:

>> +@deftypefun int sigpause (int @var{signal})
>> +@standards{XOPEN, signal.h}
>> +@safety{@prelim{}@mtunsafe{@mtasurace{:sigprocmask}}@asunsafe{@asulock{/hurd}}@acunsafe{@aculock{/hurd}}}
>> +This deprecated function is a precursor to the @code{sigsuspend}
>> +function (@pxref{Waiting for a Signal}): it removes @var{signal} from
>> +the thread's signal mask, and waits for a signal to arrive.  On return
>> +the previous set of blocked signals is restored.
>
> s/previous set of blocked signals is restored/thread's previous signal
> mask is restored/ ?

“Set of blocked signals” is the term preferred by the rest of the
manual.

>> +
>> +New code should use the @code{sigsuspend} function directly.
>
> s/directly/instead/ ?

Applied.

>> +The @code{sigpause} function in @theglibc{} is the @w{System V}
>> +variant.  The BSD variant is no longer provided by @theglibc{}.
>>  @end deftypefun
>
> Of course, this last sentence leaves the reader asking questions. Maybe:
>
> The BSD variant ==>
> The BSD variant (which takes an argument specifying mask of signals to
> be temporarily unblocked)
>
> ?

I'm going to post a new version with this addition:

+(The difference is that the BSD variant has a bitmask argument,
+while the @w{System V} expects a single signal number.)

Thanks,
Florian



More information about the Libc-alpha mailing list