Subject: lib/23950: Doc error on the signal(3) man page.
To: None <gnats-bugs@gnats.netbsd.org>
From: Aidan Kehoe <aidan.kehoe@phorest.ie>
List: netbsd-bugs
Date: 01/02/2004 16:23:58
>Number:         23950
>Category:       lib
>Synopsis:       Bad phrasing in documentation.
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    lib-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Fri Jan 02 16:25:01 UTC 2004
>Closed-Date:
>Last-Modified:
>Originator:     Aidan Kehoe
>Release:        NetBSD 1.6ZD
>Organization:

Aidan Kehoe
Technical Officer
nDevor Systems Ltd

Email: aidan.kehoe@phorest.ie
Mobile: +353 86 3874935 
Phone: +353 1 8747800 (GMT office hours)
Physical: 69 Middle Abbey Street, Dublin 1, Ireland
Web: http://www.phorest.com/
>Environment:
System: NetBSD smiley 1.6ZD NetBSD 1.6ZD (SMILEY) #: Fri Oct 17 09:51:15 IST 2003 aidan@smiley:/usr/obj/sys/arch/i386/compile/SMILEY i386
Architecture: i386
Machine: i386
>Description:
	The documentation for the C library signal() function currently says
	"The handled signal is unblocked with the function returns and the
	process continues from where it left off when the signal occurred."

	This is unclear. Either "... is unblocked with the function return and
	.." or "... is unblocked when the function returns and ..." would be
	better; I think the second is more comprehensible.

>How-To-Repeat:
	Wonder about the exact semantics of signalling. Read up on it. Become
	almost enlightened.
>Fix:
$ diff -u lib/libc/gen/signal.3{~,}
--- lib/libc/gen/signal.3~      2003-08-08 04:10:17.000000000 +0100
+++ lib/libc/gen/signal.3       2004-01-02 16:20:11.000000000 +0000
@@ -107,7 +107,7 @@
 .Fa func
 is called.
 .Pp
-The handled signal is unblocked with the
+The handled signal is unblocked when the
 function returns and
 the process continues from where it left off when the signal occurred.
 .Bf -symbolic
$ 
>Release-Note:
>Audit-Trail:
>Unformatted: