Re: [PATCH v4] ftrace: document basic ftracer/ftracer graph needs

[Steven Rostedt <rostedt@goodmis.org>]

On Mon, 2009-09-14 at 16:21 -0400, Mike Frysinger wrote:
> On Mon, Sep 14, 2009 at 15:48, Steven Rostedt wrote:
> > On Sat, 2009-06-13 at 23:05 -0400, Mike Frysinger wrote:
> >> diff --git a/Documentation/trace/ftrace.txt b/Documentation/trace/ftrace.txt
> >> index fd9a3e6..95a39fb 100644
> >> --- a/Documentation/trace/ftrace.txt
> >> +++ b/Documentation/trace/ftrace.txt
> >> @@ -27,6 +27,12 @@ disabled, and more (ftrace allows for tracer plugins, which
> >>  means that the list of tracers can always grow).
> >>
> >>
> >> +Implementation Details
> >> +----------------------
> >> +
> >> +See ftrace-implementation.txt for details for arch porters and such.
> >
> > Might want to specify that this is for the function tracer.
> 
> well, all of ftrace.txt says "function tracer", so if/when someone
> cleans that up, this will get fixed in the process.

Well things do need to be clean up, the original code had the function
tracer called ftrace, which it no longer does. Why add more incorrect
documentation just to match the previous incorrect documentation?

> 
> >> --- a/kernel/trace/Kconfig
> >> +++ b/kernel/trace/Kconfig
> >> @@ -11,31 +11,41 @@ config NOP_TRACER
> >>
> >>  config HAVE_FTRACE_NMI_ENTER
> >>       bool
> >> +     help
> >> +       See Documentation/trace/ftrace-implementation.txt
> >>
> >>  config HAVE_FUNCTION_TRACER
> >>       bool
> >> +     help
> >> +       See Documentation/trace/ftrace-implementation.txt
> >>
> >>  config HAVE_FUNCTION_GRAPH_TRACER
> >>       bool
> >> +     help
> >> +       See Documentation/trace/ftrace-implementation.txt
> >>
> >>  config HAVE_FUNCTION_TRACE_MCOUNT_TEST
> >>       bool
> >>       help
> >> -      This gets selected when the arch tests the function_trace_stop
> >> -      variable at the mcount call site. Otherwise, this variable
> >> -      is tested by the called function.
> >> +       See Documentation/trace/ftrace-implementation.txt
> >>
> >>  config HAVE_DYNAMIC_FTRACE
> >>       bool
> >> +     help
> >> +       See Documentation/trace/ftrace-implementation.txt
> >>
> >>  config HAVE_FTRACE_MCOUNT_RECORD
> >>       bool
> >> +     help
> >> +       See Documentation/trace/ftrace-implementation.txt
> >>
> >>  config HAVE_HW_BRANCH_TRACER
> >>       bool
> >>
> >>  config HAVE_FTRACE_SYSCALLS
> >>       bool
> >> +     help
> >> +       See Documentation/trace/ftrace-implementation.txt
> >>
> >>  config TRACER_MAX_TRACE
> >>       bool
> >
> > Other than this, it looks good.
> 
> so you want me to drop the Kconfig pieces ?  there was discussion in
> this thread about why the Kconfig pieces were here ...

I'm fine with the Kconfig, I was referencing my own comments, not the
above.

-- Steve