summaryrefslogtreecommitdiffstats
path: root/sys/kern/kern_timeout.c
diff options
context:
space:
mode:
authorcperciva <cperciva@FreeBSD.org>2005-01-19 19:46:35 +0000
committercperciva <cperciva@FreeBSD.org>2005-01-19 19:46:35 +0000
commit8526221cef29b01d3850ee440eacdaf51546a3e9 (patch)
tree9f8a6889eeea38aa4dba8b2607ffa8e0b7b16fdb /sys/kern/kern_timeout.c
parentb69ebd9a78883d430a4bcb25eb502360396fd518 (diff)
downloadFreeBSD-src-8526221cef29b01d3850ee440eacdaf51546a3e9.zip
FreeBSD-src-8526221cef29b01d3850ee440eacdaf51546a3e9.tar.gz
Clarify the description of the callout_active() macro: It is cleared by
callout_stop, callout_drain, and callout_deactivate, but is not automatically cleared when a callout returns.
Diffstat (limited to 'sys/kern/kern_timeout.c')
-rw-r--r--sys/kern/kern_timeout.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/sys/kern/kern_timeout.c b/sys/kern/kern_timeout.c
index b55589e..d9fe231 100644
--- a/sys/kern/kern_timeout.c
+++ b/sys/kern/kern_timeout.c
@@ -383,7 +383,9 @@ callout_handle_init(struct callout_handle *handle)
*
* <sys/callout.h> defines three convenience macros:
*
- * callout_active() - returns truth if callout has not been serviced
+ * callout_active() - returns truth if callout has not been stopped,
+ * drained, or deactivated since the last time the callout was
+ * reset.
* callout_pending() - returns truth if callout is still waiting for timeout
* callout_deactivate() - marks the callout as having been serviced
*/
OpenPOWER on IntegriCloud