Bug 24360

Summary: sigpending(2) man page is inconsistent
Product: Documentation Reporter: ingham <ingham>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description ingham 2001-01-15 22:20:01 UTC
A quote from the man page:

    RETURN VALUES
	 A 0 value indicated that the call succeeded.  A -1 return value
	 indicates an error occurred and errno is set to indicated the reason.

    ERRORS
	 The sigpending() function does not currently detect any errors.

Fix: 

Move the second sentence under RETURN VALUES to replace the
sentence under ERRORS.
How-To-Repeat: 
man sigpending
Comment 1 csxbcs 2001-01-16 21:49:49 UTC
The bit about it not detecting errors is rubbish for a start...

ben@freefall:~/tmp$ cat t.c
#include <err.h>
#include <signal.h>

int
main(void) {

        if (sigpending((void *)0xdeadbeef) != 0)
                err(1, "sigpending");

        return (0);
}
ben@freefall:~/tmp$ ./a.out
a.out: sigpending: Bad address

I'll do something about this.

-- 
Ben Smithurst / csxbcs@comp.leeds.ac.uk / ben@FreeBSD.org
Comment 2 ben freebsd_committer freebsd_triage 2001-01-16 21:59:32 UTC
State Changed
From-To: open->closed

ERRORS section fixed, thanks!