[PATCH] linux/kernel.h: fix kernel-doc warning

From: Randy Dunlap
Date: Mon May 13 2013 - 12:42:34 EST


From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

Fix kernel-doc warning in <linux/kernel.h>:

Warning(include/linux/kernel.h:590): No description found for parameter 'ip'

scripts/kernel-doc cannot handle macros, functions, or function
prototypes between the function or macro that is being documented
and its definition, so move these prototypes above the function
that is being documented.

Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
---
include/linux/kernel.h | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)

--- lnx-310-rc1.orig/include/linux/kernel.h
+++ lnx-310-rc1/include/linux/kernel.h
@@ -562,6 +562,9 @@ int __trace_bprintk(unsigned long ip, co
extern __printf(2, 3)
int __trace_printk(unsigned long ip, const char *fmt, ...);

+extern int __trace_bputs(unsigned long ip, const char *str);
+extern int __trace_puts(unsigned long ip, const char *str, int size);
+
/**
* trace_puts - write a string into the ftrace buffer
* @str: the string to record
@@ -587,8 +590,6 @@ int __trace_printk(unsigned long ip, con
* (1 when __trace_bputs is used, strlen(str) when __trace_puts is used)
*/

-extern int __trace_bputs(unsigned long ip, const char *str);
-extern int __trace_puts(unsigned long ip, const char *str, int size);
#define trace_puts(str) ({ \
static const char *trace_printk_fmt \
__attribute__((section("__trace_printk_fmt"))) = \
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/