From owner-svn-src-all@FreeBSD.ORG  Sat Dec  3 15:51:15 2011
Return-Path: <owner-svn-src-all@FreeBSD.ORG>
Delivered-To: svn-src-all@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id D1376106566B;
	Sat,  3 Dec 2011 15:51:15 +0000 (UTC)
	(envelope-from hselasky@FreeBSD.org)
Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:4f8:fff6::2c])
	by mx1.freebsd.org (Postfix) with ESMTP id C0C978FC0A;
	Sat,  3 Dec 2011 15:51:15 +0000 (UTC)
Received: from svn.freebsd.org (localhost [127.0.0.1])
	by svn.freebsd.org (8.14.4/8.14.4) with ESMTP id pB3FpF6A046115;
	Sat, 3 Dec 2011 15:51:15 GMT (envelope-from hselasky@svn.freebsd.org)
Received: (from hselasky@localhost)
	by svn.freebsd.org (8.14.4/8.14.4/Submit) id pB3FpF3d046113;
	Sat, 3 Dec 2011 15:51:15 GMT (envelope-from hselasky@svn.freebsd.org)
Message-Id: <201112031551.pB3FpF3d046113@svn.freebsd.org>
From: Hans Petter Selasky <hselasky@FreeBSD.org>
Date: Sat, 3 Dec 2011 15:51:15 +0000 (UTC)
To: src-committers@freebsd.org, svn-src-all@freebsd.org,
	svn-src-head@freebsd.org
X-SVN-Group: head
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Cc: 
Subject: svn commit: r228234 - head/sys/kern
X-BeenThere: svn-src-all@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: "SVN commit messages for the entire src tree \(except for &quot;
	user&quot; and &quot; projects&quot; \)" <svn-src-all.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/svn-src-all>,
	<mailto:svn-src-all-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-src-all>
List-Post: <mailto:svn-src-all@freebsd.org>
List-Help: <mailto:svn-src-all-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/svn-src-all>,
	<mailto:svn-src-all-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Sat, 03 Dec 2011 15:51:15 -0000

Author: hselasky
Date: Sat Dec  3 15:51:15 2011
New Revision: 228234
URL: http://svn.freebsd.org/changeset/base/228234

Log:
  Make sure the description of pause() is
  equivalent to its implementation.
  No code change.
  
  Suggested by:	Bruce Evans
  MFC after:	3 days

Modified:
  head/sys/kern/kern_synch.c

Modified: head/sys/kern/kern_synch.c
==============================================================================
--- head/sys/kern/kern_synch.c	Sat Dec  3 15:41:37 2011	(r228233)
+++ head/sys/kern/kern_synch.c	Sat Dec  3 15:51:15 2011	(r228234)
@@ -328,7 +328,8 @@ msleep_spin(void *ident, struct mtx *mtx
  * pause() delays the calling thread by the given number of system ticks.
  * During cold bootup, pause() uses the DELAY() function instead of
  * the tsleep() function to do the waiting. The "timo" argument must be
- * greater than zero.
+ * greater than or equal to zero. A "timo" value of zero is equivalent
+ * to a "timo" value of one.
  */
 int
 pause(const char *wmesg, int timo)