From patchwork Mon Feb 24 19:07:41 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Florian Weimer X-Patchwork-Id: 38291 X-Patchwork-Delegate: carlos@redhat.com Received: (qmail 14671 invoked by alias); 24 Feb 2020 19:07:50 -0000 Mailing-List: contact libc-alpha-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: libc-alpha-owner@sourceware.org Delivered-To: mailing list libc-alpha@sourceware.org Received: (qmail 14613 invoked by uid 89); 24 Feb 2020 19:07:49 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-19.0 required=5.0 tests=AWL, BAYES_00, GIT_PATCH_0, GIT_PATCH_1, GIT_PATCH_2, GIT_PATCH_3, RCVD_IN_DNSWL_NONE autolearn=ham version=3.3.1 spammy=arrive X-HELO: us-smtp-1.mimecast.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1582571266; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=RpB9UtRRdqucFVfkjNPRE/VW2ORBCQHk7ZWOYOxeHko=; b=WF7um12e0F6VF5JEdwnMkdjlOJA9QySawUo6qkrumc+jF1kCIq7+bPT3N9ohffW30S3w09 OiVBAkn4qqQoQXi7snmimuBDyR1/YyJMeADEBRr630DdFUDKmlS4OyCwoD7t9VoVa2kyMe qeeq4roSkWvBXYVmSO7KGXmbwrDxJhY= From: Florian Weimer To: libc-alpha@sourceware.org Subject: [PATCH] manual: Document the System V sigpause function Date: Mon, 24 Feb 2020 20:07:41 +0100 Message-ID: <87h7zfn6rm.fsf@oldenburg2.str.redhat.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.3 (gnu/linux) MIME-Version: 1.0 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com currently provides only the System V variant of sigpause. Update the documentation of the function and move it to its own node. ----- manual/signal.texi | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/manual/signal.texi b/manual/signal.texi index 33e6646975..62cec48450 100644 --- a/manual/signal.texi +++ b/manual/signal.texi @@ -39,6 +39,8 @@ and synchronize. * Signal Stack:: Using a Separate Signal Stack. * BSD Signal Handling:: Additional functions for backward compatibility with BSD. +* Obsolete Signal Handling:: Deprecated functions for compatibility with + other sytems. @end menu @node Concepts of Signals @@ -3295,19 +3297,22 @@ the calling process's signal mask to @var{mask}. The return value is the previous set of blocked signals. @end deftypefun -@deftypefun int sigpause (int @var{mask}) -@standards{BSD, signal.h} -@safety{@prelim{}@mtunsafe{@mtasurace{:sigprocmask/!bsd!linux}}@asunsafe{@asulock{/hurd}}@acunsafe{@aculock{/hurd}}} -@c sigpause @mtasurace:sigprocmask/!bsd!linux @asulock/hurd @aculock/hurd -@c [posix] -@c __sigpause @mtasurace:sigprocmask/!bsd!linux @asulock/hurd @aculock/hurd -@c do_sigpause @mtasurace:sigprocmask/!bsd!linux @asulock/hurd @aculock/hurd -@c sigprocmask(0) dup @asulock/hurd @aculock/hurd [no @mtasurace:sigprocmask/bsd(SIG_UNBLOCK)] -@c sigdelset dup ok -@c sigset_set_old_mask dup ok -@c sigsuspend dup @mtasurace:sigprocmask/!bsd!linux @asulock/hurd @aculock/hurd -This function is the equivalent of @code{sigsuspend} (@pxref{Waiting -for a Signal}): it sets the calling process's signal mask to @var{mask}, -and waits for a signal to arrive. On return the previous set of blocked -signals is restored. +@node Obsolete Signal Handling +@section Obsolete Signal Handling + +This section describes deprecated signal handling functions which are +provided for compatibility with other systems. + +@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. + +New code should use the @code{sigsuspend} function directly. + +The @code{sigpause} function in @theglibc{} is the @w{System V} +variant. The BSD variant is no longer provided by @theglibc{}. @end deftypefun