Re: [PATCH] ftrace: Fix comments about trace/ftrace.h

From: Steven Rostedt
Date: Mon Mar 02 2015 - 23:05:23 EST


On Tue, 3 Mar 2015 10:38:19 +0800
Hou Pengyang <houpengyang@xxxxxxxxxx> wrote:


> >> --- a/include/trace/ftrace.h
> >> +++ b/include/trace/ftrace.h
> >> @@ -1,7 +1,8 @@
> >> /*
> >> * Stage 1 of the trace events.
> >> *
> >> - * Override the macros in <trace/trace_events.h> to include the following:
> >> + * Override the macros in TRACE_INCLUDE(TRACE_INCLUDE_FILE) to
> >
> > I agree that the comment needs updating, but not to this.
> > TRACE_INCLUDE(TRACE_INCLUDE_FILE) is not very descriptive. Because
> > nobody understand exactly what that is. Do you?
> >
> > Change it to:
> >
> > Override the macros in the event tracepoint header ...
> >
> > And do that for the ones below too. This is more descriptive than just
> > describing what the code is literally doing.
> >
> > -- Steve
> >
> To be more descriptive, how about "Override the macros in the event
> tracepoint header <trace/events/XXX.h> ..." ? since, tracepoint headers
> have already been moved to trace/events/ .

That's fine with me too.


-- Steve

--
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/