path: root/include
diff options
authorRandy Dunlap <randy.dunlap@oracle.com>2008-10-29 14:01:15 -0700
committerLinus Torvalds <torvalds@linux-foundation.org>2008-10-30 11:38:47 -0700
commit7106a27b52940085c2c3f6e42742d3a2a84d872a (patch)
tree439723ef5835c3c21205ebdc7a767f2b3fa2de62 /include
parent89a056df78b113fcab21d71cd24aa1893c09225b (diff)
kernel.h: fix might_sleep kernel-doc
Put the kernel-doc for might_sleep() _immediately_ before the macro (no intervening lines). Otherwise kernel-doc complains like so: Warning(linux-2.6.27-rc3-git2//include/linux/kernel.h:129): No description found for parameter 'file' Warning(linux-2.6.27-rc3-git2//include/linux/kernel.h:129): No description found for parameter 'line' because kernel-doc is looking at the wrong function prototype (i.e., __might_sleep). [Yes, I have a todo note to myself to check/warn for that inconsistency in scripts/kernel-doc.] Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com> Cc: <Uwe.Kleine-Koenig@digi.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'include')
1 files changed, 2 insertions, 2 deletions
diff --git a/include/linux/kernel.h b/include/linux/kernel.h
index 396a350b87a6..fba141d3ca07 100644
--- a/include/linux/kernel.h
+++ b/include/linux/kernel.h
@@ -116,6 +116,8 @@ extern int _cond_resched(void);
# define might_resched() do { } while (0)
+ void __might_sleep(char *file, int line);
* might_sleep - annotation for functions that can sleep
@@ -126,8 +128,6 @@ extern int _cond_resched(void);
* be bitten later when the calling function happens to sleep when it is not
* supposed to.
- void __might_sleep(char *file, int line);
# define might_sleep() \
do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)

Privacy Policy