From owner-freebsd-doc@FreeBSD.ORG  Sun Jul 27 23:00:22 2014
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115])
 (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by hub.freebsd.org (Postfix) with ESMTPS id BBB9EB66
 for <freebsd-doc@freebsd.org>; Sun, 27 Jul 2014 23:00:22 +0000 (UTC)
Received: from mail-gw13.york.ac.uk (mail-gw13.york.ac.uk [144.32.129.163])
 (using TLSv1 with cipher AES256-SHA (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id 847572152
 for <freebsd-doc@freebsd.org>; Sun, 27 Jul 2014 23:00:22 +0000 (UTC)
Received: from ury.york.ac.uk ([144.32.64.162]:22017)
 by mail-gw13.york.ac.uk with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)
 (Exim 4.76) (envelope-from <gavin@FreeBSD.org>)
 id 1XBXQL-0008Nx-Sw; Mon, 28 Jul 2014 00:00:13 +0100
Date: Mon, 28 Jul 2014 00:00:13 +0100 (BST)
From: Gavin Atkinson <gavin@FreeBSD.org>
X-X-Sender: gavin@ury.york.ac.uk
To: Malcolm Douglas <mdoug12345678@gmail.com>
Subject: Re: man pthread
In-Reply-To: <CAAfPS01qzjg2LSxmbmzMFZmKYgbARO20nxOOH9LkrQG4iHvbiw@mail.gmail.com>
Message-ID: <alpine.BSF.2.11.1407272352060.13507@ury.york.ac.uk>
References: <CAAfPS01qzjg2LSxmbmzMFZmKYgbARO20nxOOH9LkrQG4iHvbiw@mail.gmail.com>
User-Agent: Alpine 2.11 (BSF 23 2013-08-11)
MIME-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII
Cc: freebsd-doc@freebsd.org
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc/>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Sun, 27 Jul 2014 23:00:22 -0000

On Mon, 21 Jul 2014, Malcolm Douglas wrote:
> Sorry, not sure if this is the right way to handle this, but I saw a
> doc error.
> 
> The pthread_cond_wait and pthread_cond_timedwait descriptions are
> incorrect in man pthread.
> 
> The description is:
> Wait for a condition and lock the specified mutex.
> 
> It should be:
> Wait for a condition and unlock the specified mutex.

The current description is actually correct, but not clear.  How about:

pthread_cond_timedwait()
   Unlock the specified mutex, wait no longer than the specified time for
   a condition, and then relock the mutex.

pthread_cond_wait()
   Unlock the specified mutex, wait for a condition, and relock the mutex.

Would that be better?

Thanks,

Gavin
> 
> pthread_cond_timedwait has an analogous error.
> 
> The pages for man pthread_cond_wait and pthread_cond_timedwait do not
> have this error, it is just in the descriptions in the page for
> pthread.
> _______________________________________________
> freebsd-doc@freebsd.org mailing list
> http://lists.freebsd.org/mailman/listinfo/freebsd-doc
> To unsubscribe, send any mail to "freebsd-doc-unsubscribe@freebsd.org"
>