From owner-freebsd-doc@FreeBSD.ORG  Thu Mar 30 13:00:56 2006
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
X-Original-To: freebsd-doc@hub.freebsd.org
Delivered-To: freebsd-doc@hub.freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 92CEC16A401
	for <freebsd-doc@hub.freebsd.org>; Thu, 30 Mar 2006 13:00:56 +0000 (UTC)
	(envelope-from gnats@FreeBSD.org)
Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 229C443D46
	for <freebsd-doc@hub.freebsd.org>; Thu, 30 Mar 2006 13:00:56 +0000 (GMT)
	(envelope-from gnats@FreeBSD.org)
Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1])
	by freefall.freebsd.org (8.13.4/8.13.4) with ESMTP id k2UD0t6e065136
	for <freebsd-doc@freefall.freebsd.org>; Thu, 30 Mar 2006 13:00:56 GMT
	(envelope-from gnats@freefall.freebsd.org)
Received: (from gnats@localhost)
	by freefall.freebsd.org (8.13.4/8.13.4/Submit) id k2UD0tLm065135;
	Thu, 30 Mar 2006 13:00:55 GMT (envelope-from gnats)
Date: Thu, 30 Mar 2006 13:00:55 GMT
Message-Id: <200603301300.k2UD0tLm065135@freefall.freebsd.org>
To: freebsd-doc@FreeBSD.org
From: John Baldwin <jhb@freebsd.org>
Cc: 
Subject: Re: docs/95104: tsleep() man page mentions nonexistent 'mtx' arg
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
Reply-To: John Baldwin <jhb@freebsd.org>
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/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: Thu, 30 Mar 2006 13:00:56 -0000

The following reply was made to PR docs/95104; it has been noted by GNATS.

From: John Baldwin <jhb@freebsd.org>
To: freebsd-doc@freebsd.org
Cc: Tomas Olsson <tol@stacken.kth.se>, freebsd-gnats-submit@freebsd.org
Subject: Re: docs/95104: tsleep() man page mentions nonexistent 'mtx' arg
Date: Thu, 30 Mar 2006 07:59:57 -0500

 On Thursday 30 March 2006 06:19 am, Tomas Olsson wrote:
 > >Number:         95104
 > >Category:       docs
 > >Synopsis:       tsleep() man page mentions nonexistent 'mtx' arg
 > >Confidential:   no
 > >Severity:       non-critical
 > >Priority:       low
 > >Responsible:    freebsd-doc
 > >State:          open
 > >Quarter:
 > >Keywords:
 > >Date-Required:
 > >Class:          doc-bug
 > >Submitter-Id:   current-users
 > >Arrival-Date:   Thu Mar 30 11:20:15 GMT 2006
 > >Closed-Date:
 > >Last-Modified:
 > >Originator:     Tomas Olsson
 > >Release:        5.5-BETA4
 > >Organization:
 >
 > Stacken Computer Club
 >
 > >Environment:
 >
 > FreeBSD lab04.lab.it.su.se 5.5-BETA4 FreeBSD 5.5-BETA4 #0: Mon Mar 13
 > 23:12:57 UTC 2006   =20
 > root@perseus.cse.buffalo.edu:/usr/obj/usr/src/sys/GENERIC  i386
 >
 > >Description:
 >
 > SLEEP(9) says under tsleep():
 >   If the Giant lock is not held and mtx is NULL, then timo must be
 > non-zero. However, the given proto is
 >   int
 >   tsleep(void *ident, int priority, const char *wmesg, int timo);
 >  -- no mtx there. Is this just plain wrong, or should it be under msleep()
 > instead?
 
 Under msleep instead.  Really, msleep() is the general call now, tsleep()
 is just a special case that hardcodes the mtx argument as NULL.  Thus,
 the manpage should probably describe msleep() as the primary function and
 then describe tsleep() as an msleep() without a mtx arg.
 
 =2D-=20
 John Baldwin <jhb@FreeBSD.org> =A0<>< =A0http://www.FreeBSD.org/~jhb/
 "Power Users Use the Power to Serve" =A0=3D =A0http://www.FreeBSD.org