Commit bcf312cf authored May 02, 2013 by Steven Rostedt Committed by Jiri Kosina May 28, 2013

tracing: 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@crashcourse.ca>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>

parent 8ef726cb

include/linux/kernel.h

+2 −3

Original line number	Diff line number	Diff line
		@@ -562,9 +562,6 @@ int __trace_bprintk(unsigned long ip, const char *fmt, ...);
		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
		@@ -600,6 +597,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);