From nobody@FreeBSD.org  Thu Mar 30 11:19:08 2006
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id B121C16A41F
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 30 Mar 2006 11:19:08 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [216.136.204.117])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 80C5A43D45
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 30 Mar 2006 11:19:08 +0000 (GMT)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.13.1/8.13.1) with ESMTP id k2UBJ8i5021792
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 30 Mar 2006 11:19:08 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.13.1/8.13.1/Submit) id k2UBJ85v021791;
	Thu, 30 Mar 2006 11:19:08 GMT
	(envelope-from nobody)
Message-Id: <200603301119.k2UBJ85v021791@www.freebsd.org>
Date: Thu, 30 Mar 2006 11:19:08 GMT
From: Tomas Olsson <tol@stacken.kth.se>
To: freebsd-gnats-submit@FreeBSD.org
Subject: tsleep() man page mentions nonexistent 'mtx' arg
X-Send-Pr-Version: www-2.3

>Number:         95104
>Category:       docs
>Synopsis:       tsleep() man page mentions nonexistent 'mtx' arg
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    jhb
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Mar 30 11:20:15 GMT 2006
>Closed-Date:    Tue Jan 15 20:40:05 UTC 2008
>Last-Modified:  Tue Jan 15 20:40:05 UTC 2008
>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     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?

>How-To-Repeat:

>Fix:

>Release-Note:
>Audit-Trail:

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
Responsible-Changed-From-To: freebsd-doc->jhb 
Responsible-Changed-By: ru 
Responsible-Changed-When: Thu Oct 12 18:28:30 UTC 2006 
Responsible-Changed-Why:  
John fixed this already in -CURRENT; this will serve as an MFC reminder. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=95104 
State-Changed-From-To: open->closed 
State-Changed-By: jhb 
State-Changed-When: Tue Jan 15 20:39:53 UTC 2008 
State-Changed-Why:  
Fixes MFC'd. 

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