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.
This commit is contained in:
Colin Percival 2005-01-19 19:46:35 +00:00
parent 7d9ace1d46
commit 86fd19de7b
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=140487

View File

@ -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
*/