kernel.h: fix might_sleep kernel-doc
PATCH 1/1 kernel.h: fix might_sleep kernel-doc
From: Randy Dunlap <[email protected]>
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 <[email protected]>
cc Uwe Kleine-K_nig <[email protected]>
--- include/linux/kernel.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
include/linux/kernel.h +2 -2
@@ -116,6 +116,8 @@ extern int _cond_resched(void);# define might_resched () do { } while (0)#endif +#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP +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. */ -#ifdef CONFIG_DEBUG_SPINLOCK_SLEEP -void __might_sleep (char *file,int line);# define might_sleep () \ do { __might_sleep(__FILE__, __LINE__); might_resched(); } while (0)#else