diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2008-10-29 17:01:15 -0400 |
---|---|---|
committer | Linus Torvalds <torvalds@linux-foundation.org> | 2008-10-30 14:38:47 -0400 |
commit | 7106a27b52940085c2c3f6e42742d3a2a84d872a (patch) | |
tree | 439723ef5835c3c21205ebdc7a767f2b3fa2de62 /include | |
parent | 89a056df78b113fcab21d71cd24aa1893c09225b (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')
-rw-r--r-- | include/linux/kernel.h | 4 |
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); | |||
116 | # define might_resched() do { } while (0) | 116 | # define might_resched() do { } while (0) |
117 | #endif | 117 | #endif |
118 | 118 | ||
119 | #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP | ||
120 | void __might_sleep(char *file, int line); | ||
119 | /** | 121 | /** |
120 | * might_sleep - annotation for functions that can sleep | 122 | * might_sleep - annotation for functions that can sleep |
121 | * | 123 | * |
@@ -126,8 +128,6 @@ extern int _cond_resched(void); | |||
126 | * be bitten later when the calling function happens to sleep when it is not | 128 | * be bitten later when the calling function happens to sleep when it is not |
127 | * supposed to. | 129 | * supposed to. |
128 | */ | 130 | */ |
129 | #ifdef CONFIG_DEBUG_SPINLOCK_SLEEP | ||
130 | void __might_sleep(char *file, int line); | ||
131 | # define might_sleep() \ | 131 | # define might_sleep() \ |
132 | do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0) | 132 | do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0) |
133 | #else | 133 | #else |