summaryrefslogtreecommitdiffstats
path: root/sys/kern/kern_synch.c
diff options
context:
space:
mode:
authorhselasky <hselasky@FreeBSD.org>2011-12-03 15:51:15 +0000
committerhselasky <hselasky@FreeBSD.org>2011-12-03 15:51:15 +0000
commit5829cbdab5c5110053c13dad16491c4401ea512c (patch)
treee04aed3177dae804925e60a6690fbd6e39709eac /sys/kern/kern_synch.c
parent3be1835ce67fbffad000fe19effd7260193165a5 (diff)
downloadFreeBSD-src-5829cbdab5c5110053c13dad16491c4401ea512c.zip
FreeBSD-src-5829cbdab5c5110053c13dad16491c4401ea512c.tar.gz
Make sure the description of pause() is
equivalent to its implementation. No code change. Suggested by: Bruce Evans MFC after: 3 days
Diffstat (limited to 'sys/kern/kern_synch.c')
-rw-r--r--sys/kern/kern_synch.c3
1 files changed, 2 insertions, 1 deletions
diff --git a/sys/kern/kern_synch.c b/sys/kern/kern_synch.c
index bab9178..fdfe8bb 100644
--- a/sys/kern/kern_synch.c
+++ b/sys/kern/kern_synch.c
@@ -328,7 +328,8 @@ msleep_spin(void *ident, struct mtx *mtx, const char *wmesg, int timo)
* 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)
OpenPOWER on IntegriCloud