Re: [PATCH v3 3/2] ftrace: ftrace_printk doc moved

[Randy Dunlap <randy.dunlap@oracle.com>]

On Fri, 1 Aug 2008 16:45:49 -0400 (EDT) Steven Rostedt wrote:

> 
> Based on Randy Dunlap's suggestion, the ftrace_printk kernel-doc belongs
> with the ftrace_printk macro that should be used. Not with the
> __ftrace_printk internal function.
> 
> Signed-off-by: Steven Rostedt <srostedt@redhat.com>

Acked-by: Randy Dunlap <randy.dunlap@oracle.com>

> ---
>  include/linux/ftrace.h |   19 ++++++++++++++++++-
>  kernel/trace/trace.c   |   16 ----------------
>  2 files changed, 18 insertions(+), 17 deletions(-)
> 
> Index: linux-tip.git/include/linux/ftrace.h
> ===================================================================
> --- linux-tip.git.orig/include/linux/ftrace.h	2008-08-01 12:20:56.000000000 -0400
> +++ linux-tip.git/include/linux/ftrace.h	2008-08-01 16:43:56.000000000 -0400
> @@ -137,7 +137,24 @@ static inline void tracer_disable(void)
>  extern void
>  ftrace_special(unsigned long arg1, unsigned long arg2, unsigned long arg3);
>  extern void ftrace_dump(void);
> -# define ftrace_printk(x...) __ftrace_printk(_THIS_IP_, x)
> +
> +/**
> + * ftrace_printk - printf formatting in the ftrace buffer
> + * @fmt: the printf format for printing
> + *
> + * Note: __ftrace_printk is an internal function for ftrace_printk and
> + *       the @ip is passed in via the ftrace_printk macro.
> + *
> + * This function allows a kernel developer to debug fast path sections
> + * that printk is not appropriate for. By scattering in various
> + * printk like tracing in the code, a developer can quickly see
> + * where problems are occurring.
> + *
> + * This is intended as a debugging tool for the developer only.
> + * Please refrain from leaving ftrace_printks scattered around in
> + * your code.
> + */
> +# define ftrace_printk(fmt...) __ftrace_printk(_THIS_IP_, fmt)
>  extern int
>  __ftrace_printk(unsigned long ip, const char *fmt, ...)
>  	__attribute__ ((format (printf, 2, 3)));
> Index: linux-tip.git/kernel/trace/trace.c
> ===================================================================
> --- linux-tip.git.orig/kernel/trace/trace.c	2008-08-01 12:20:56.000000000 -0400
> +++ linux-tip.git/kernel/trace/trace.c	2008-08-01 14:10:36.000000000 -0400
> @@ -3243,22 +3243,6 @@ void ftrace_dump(void)
>  	(sizeof(struct trace_field) - offsetof(struct trace_field, print.buf))
>  #define TRACE_CONT_BUF_SIZE sizeof(struct trace_field)
>  
> -/**
> - * ftrace_printk - printf formatting in the ftrace buffer
> - * @fmt - the printf format for printing.
> - *
> - * Note: __ftrace_printk is an internal function for ftrace_printk and
> - *       the @ip is passed in via the ftrace_printk macro.
> - *
> - * This function allows a kernel developer to debug fast path sections
> - * that printk is not appropriate for. By scattering in various
> - * printk like tracing in the code, a developer can quickly see
> - * where problems are occurring.
> - *
> - * This is intended as a debugging tool for the developer only.
> - * Please reframe from leaving ftrace_printks scattered around in
> - * your code.
> - */
>  int __ftrace_printk(unsigned long ip, const char *fmt, ...)
>  {
>  	struct trace_array *tr = &global_trace;


---
~Randy
Linux Plumbers Conference, 17-19 September 2008, Portland, Oregon USA
http://linuxplumbersconf.org/