From owner-freebsd-doc@FreeBSD.ORG  Thu Mar 30 13:00:07 2006
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
X-Original-To: freebsd-doc@freebsd.org
Delivered-To: freebsd-doc@freebsd.org
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id D4EEF16A400;
	Thu, 30 Mar 2006 13:00:07 +0000 (UTC) (envelope-from jhb@freebsd.org)
Received: from server.baldwin.cx (66-23-211-162.clients.speedfactory.net
	[66.23.211.162])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 2C62D43D46;
	Thu, 30 Mar 2006 13:00:07 +0000 (GMT) (envelope-from jhb@freebsd.org)
Received: from zion.baldwin.cx (zion.baldwin.cx [192.168.0.7])
	(authenticated bits=0)
	by server.baldwin.cx (8.13.4/8.13.4) with ESMTP id k2UCxx46000437;
	Thu, 30 Mar 2006 07:59:59 -0500 (EST) (envelope-from jhb@freebsd.org)
From: John Baldwin <jhb@freebsd.org>
To: freebsd-doc@freebsd.org
Date: Thu, 30 Mar 2006 07:59:57 -0500
User-Agent: KMail/1.8.3
References: <200603301119.k2UBJ85v021791@www.freebsd.org>
In-Reply-To: <200603301119.k2UBJ85v021791@www.freebsd.org>
MIME-Version: 1.0
Content-Type: text/plain;
  charset="iso-8859-15"
Content-Transfer-Encoding: quoted-printable
Content-Disposition: inline
Message-Id: <200603300759.58726.jhb@freebsd.org>
X-Virus-Scanned: ClamAV 0.87.1/1363/Wed Mar 29 15:38:37 2006 on
	server.baldwin.cx
X-Virus-Status: Clean
X-Spam-Status: No, score=-3.9 required=4.2 tests=ALL_TRUSTED,AWL,BAYES_00 
	autolearn=ham version=3.1.0
X-Spam-Checker-Version: SpamAssassin 3.1.0 (2005-09-13) on server.baldwin.cx
Cc: freebsd-gnats-submit@freebsd.org, Tomas Olsson <tol@stacken.kth.se>
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
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:08 -0000

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