summaryrefslogtreecommitdiff
path: root/lib/ratelimit.c
diff options
context:
space:
mode:
authorYong Zhang <yong.zhang@windriver.com>2010-04-07 01:35:01 +0400
committerLinus Torvalds <torvalds@linux-foundation.org>2010-04-07 19:38:04 +0400
commit2a7268abc48c8009b284bd88605d14fcb65772ec (patch)
tree4a85cff6aaa6a1beda8e727b593f780a3fec3fc8 /lib/ratelimit.c
parentee5d2acd5ca1534f40e06d4f0d41a940b17beb54 (diff)
downloadlinux-2a7268abc48c8009b284bd88605d14fcb65772ec.tar.xz
ratelimit: annotate ___ratelimit()
To prevent from wrongly using the return value. [akpm@linux-foundation.org: fix spello] Signed-off-by: Yong Zhang <yong.zhang@windriver.com> Cc: Ingo Molnar <mingo@elte.hu> Cc: Dave Young <hidave.darkstar@gmail.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'lib/ratelimit.c')
-rw-r--r--lib/ratelimit.c9
1 files changed, 7 insertions, 2 deletions
diff --git a/lib/ratelimit.c b/lib/ratelimit.c
index 09f5ce1810dc..b4cd24ff9b29 100644
--- a/lib/ratelimit.c
+++ b/lib/ratelimit.c
@@ -16,9 +16,14 @@
/*
* __ratelimit - rate limiting
* @rs: ratelimit_state data
+ * @func: name of calling function
*
- * This enforces a rate limit: not more than @rs->ratelimit_burst callbacks
- * in every @rs->ratelimit_jiffies
+ * This enforces a rate limit: not more than @rs->burst callbacks
+ * in every @rs->interval
+ *
+ * RETURNS:
+ * 0 means callbacks will be suppressed.
+ * 1 means go ahead and do it.
*/
int ___ratelimit(struct ratelimit_state *rs, const char *func)
{