docs/95104: tsleep() man page mentions nonexistent 'mtx' arg

[John Baldwin]

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

From: John Baldwin <jhb at freebsd.org>
To: freebsd-doc at freebsd.org
Cc: Tomas Olsson <tol at stacken.kth.se>, freebsd-gnats-submit at 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 at 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 at FreeBSD.org> =A0<>< =A0http://www.FreeBSD.org/~jhb/
 "Power Users Use the Power to Serve" =A0=3D =A0http://www.FreeBSD.org