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

[Steven Rostedt]

On Fri, 1 Aug 2008, Randy Dunlap wrote:

> On Fri, 1 Aug 2008 14:17:42 -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@xxxxxxxxxx>
> > ---
> >  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 14:11:13.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.
> 
>     * @fmt: the printf format for printing

OK, thanks.

> 
> > + *
> > + * 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
> 
>              refrain

Heh,  I manually fixed that before sending out the original. I never fixed 
it in the quilt queue. Darn!

-- Steve

> 
> > + * your code.
> > + */
> > +# define ftrace_printk(fmt...) __ftrace_printk(_THIS_IP_, fmt)
> >  extern int
--
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/