[<prev] [next>] [day] [month] [year] [list]
Message-ID: <1367508373.30667.142.camel@gandalf.local.home>
Date: Thu, 02 May 2013 11:26:13 -0400
From: Steven Rostedt <rostedt@...dmis.org>
To: LKML <linux-kernel@...r.kernel.org>, trivial@...nel.org
Cc: Andrew Morton <akpm@...ux-foundation.org>,
"Robert P. J. Day" <rpjday@...shcourse.ca>
Subject: [PATCH] tracing/trivial: Put trace_puts() comment above
trace_puts() macro for kernel doc
Kernel-doc gives the following warning:
DOCPROC Documentation/DocBook/kernel-api.xml
Warning(/include/linux/kernel.h:590): No description found for parameter 'ip'
Warning(/include/linux/kernel.h:590): No description found for parameter 'ip'
Due to the externs between the the comment and the trace_puts() macro.
This is fixed by moving the externs below the macro and keeping the
macro and comment directly together.
Reported-by: Robert P. J. Day <rpjday@...shcourse.ca>
Signed-off-by: Steven Rostedt <rostedt@...dmis.org>
diff --git a/include/linux/kernel.h b/include/linux/kernel.h
index 2dac79c..2675814 100644
--- a/include/linux/kernel.h
+++ b/include/linux/kernel.h
@@ -586,9 +586,6 @@ int __trace_printk(unsigned long ip, const char *fmt, ...);
* Returns: 0 if nothing was written, positive # if string was.
* (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"))) = \
@@ -599,6 +596,8 @@ extern int __trace_puts(unsigned long ip, const char *str, int size);
else \
__trace_puts(_THIS_IP_, str, strlen(str)); \
})
+extern int __trace_bputs(unsigned long ip, const char *str);
+extern int __trace_puts(unsigned long ip, const char *str, int size);
extern void trace_dump_stack(int skip);
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
Powered by blists - more mailing lists