From rooneg@acm.rpi.edu  Thu Dec 28 19:46:24 2000
Return-Path: <rooneg@acm.rpi.edu>
Received: from neroon.acm.rpi.edu (unknown [128.213.5.27])
	by hub.freebsd.org (Postfix) with SMTP id 19AA237B400
	for <FreeBSD-gnats-submit@freebsd.org>; Thu, 28 Dec 2000 19:46:24 -0800 (PST)
Received: (qmail 92381 invoked by uid 1170); 29 Dec 2000 03:48:51 -0000
Message-Id: <20001229034851.92380.qmail@neroon.acm.rpi.edu>
Date: 29 Dec 2000 03:48:51 -0000
From: rooneg@rpi.edu
Sender: rooneg@acm.rpi.edu
Reply-To: rooneg@rpi.edu
To: FreeBSD-gnats-submit@freebsd.org
Subject: man page for pthread_cond_wait is unclear
X-Send-Pr-Version: 3.2

>Number:         23936
>Category:       docs
>Synopsis:       man page for pthread_cond_wait is unclear
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Dec 28 19:50:01 PST 2000
>Closed-Date:    Thu Feb 1 19:32:13 PST 2001
>Last-Modified:  Thu Feb 01 19:33:41 PST 2001
>Originator:     Garret Rooney
>Release:        FreeBSD 4.2-BETA i386
>Organization:
RPI
>Environment:

FreeBSD 4.2-BETA, although this seems to exist in -current as well

>Description:

The man page for pthread_cond_wait reads as follows: "The waiting thread 
unblocks only after another thread calls pthread_cond_signal(3), or 
pthread_cond_broadcast(3) with the same condition variable, and the current 
thread requires the lock on mutex."  While this is technically correct, it is 
slightly unclear, and "reaquires" the mutex would be clearer.

>How-To-Repeat:

man 3 pthread_cond_wait

>Fix:

apply the following patch:

--- /usr/src/lib/libc_r/man/pthread_cond_wait.3	Sat Apr 22 12:35:03 2000
+++ pthread_cond_wait.3	Thu Dec 28 22:27:12 2000
@@ -50,7 +50,7 @@
 The waiting thread unblocks only after another thread calls
 .Xr pthread_cond_signal 3 , or
 .Xr pthread_cond_broadcast 3
-with the same condition variable, and the current thread requires the lock
+with the same condition variable, and the current thread reaquires the lock
 on
 .Fa mutex .
 .Sh RETURN VALUES

>Release-Note:
>Audit-Trail:

From: Larry Rooney <lrooney01@mediaone.net>
To: freebsd-gnats-submit@FreeBSD.org, rooneg@rpi.edu
Cc:  
Subject: Re: docs/23936: man page for pthread_cond_wait is unclear
Date: Fri, 29 Dec 2000 14:26:48 -0500

 the patch i sent managed to misspell 'reacquire' ;-(  
 here's a corrected version.
 
 --- /usr/src/lib/libc_r/man/pthread_cond_wait.3 Sat Apr 22 12:35:03 2000
 +++ pthread_cond_wait.3 Thu Dec 28 22:27:12 2000
 @@ -50,7 +50,7 @@
 The waiting thread unblocks only after another thread calls
 .Xr pthread_cond_signal 3 , or
 .Xr pthread_cond_broadcast 3
 -with the same condition variable, and the current thread requires the lock
 +with the same condition variable, and the current thread reacquires the lock on
 .Fa mutex .
 .Sh RETURN VALUES
 
State-Changed-From-To: open->closed 
State-Changed-By: nik 
State-Changed-When: Thu Feb 1 19:32:13 PST 2001 
State-Changed-Why:  
Committed, thanks. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=23936 
>Unformatted:
