Subject: lib/10072: No description for nanosleep(2)
To: None <gnats-bugs@gnats.netbsd.org, j.d.coleman@ncl.ac.uk>
From: Julian Coleman <J.D.Coleman@newcastle.ac.uk>
List: netbsd-bugs
Date: 05/08/2000 06:19:10
>Number: 10072
>Category: lib
>Synopsis: No description for nanosleep(2)
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: lib-bug-people
>State: open
>Class: doc-bug
>Submitter-Id: net
>Arrival-Date: Mon May 08 06:20:00 PDT 2000
>Closed-Date:
>Last-Modified:
>Originator: Julian Coleman
>Release: -current 2000/May/07
>Organization:
Computing Service, University of Newcastle upon Tyne, UK
>Environment:
System: NetBSD aire.ncl.ac.uk 1.4 NetBSD 1.4 (AIRE) #1: Tue Jun 22 16:34:55 BST 1999 root@aire.ncl.ac.uk:/usr/src-1.4/sys/arch/sparc/compile/AIRE sparc
>Description:
The description for nanosleep is, um, lacking.
>How-To-Repeat:
`man nanosleep`
>Fix:
Suggested patch to the manual page (cribbed from usleep(3)) :
--- nanosleep.2- Fri Dec 3 12:08:11 1999
+++ nanosleep.2 Mon May 8 14:11:53 2000
@@ -44,7 +44,16 @@
.Fd #include <time.h>
.Ft int
.Fn nanosleep "const struct timespec *rqtp" "struct timespec *rmtp"
-.\" .Sh DESCRIPTION
+.Sh DESCRIPTION
+The
+.Fn nanosleep
+suspends execution of the calling process until either the number of
+seconds and nanoseconds specified by
+.Fa rqtp
+have elapsed or a signal is delivered to the calling process and its
+action is to invoke a signal catching function or to terminate the
+process. The suspension time may be longer than requested due to the
+scheduling of other activity by the system.
.Sh RETURN VALUE
If the
.Fn nanosleep
>Release-Note:
>Audit-Trail:
>Unformatted: