svn commit: r228234 - head/sys/kern

[Hans Petter Selasky]

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)