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

[Steven Rostedt <rostedt@goodmis.org>]

On Mon, 2 Mar 2015 14:28:54 +0000
Hou Pengyang <houpengyang@huawei.com> wrote:

> commit f42c85e74faa422cf0bc747ed808681145448f88 moves tracepoint's ftrace 
> creation into include/trace/ftrace.h and trace/define_trach.h is deleted 

You mean event_trace.h is deleted.

> as a result. However some comment info does not adapt to the change, which 
> I think is such a misguiding when reading related code. 
> 
> This patch fix this comment by moving trace/trace_events.h to TRACE_INCLUDE
> (TRACE_INCLUDE_FILE), the macro TRACE_INCLUDE(TRACE_INCLUDE_FILE) is defined
> in trace/define_trace.h
> 
> Signed-off-by: Hou Pengyang <houpengyang@huawei.com>
> ---
>  include/trace/ftrace.h | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
> 
> diff --git a/include/trace/ftrace.h b/include/trace/ftrace.h
> index 41bf65f..cb78a8b 100644
> --- 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


> + * include the following:
>   *
>   * struct ftrace_raw_<call> {
>   *	struct trace_entry		ent;
> @@ -170,7 +171,8 @@
>  /*
>   * Stage 3 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 
> + * include the following:
>   *
>   * enum print_line_t
>   * ftrace_raw_output_<call>(struct trace_iterator *iter, int flags)
> @@ -479,7 +481,8 @@ static inline notrace int ftrace_get_offsets_##call(			\
>  /*
>   * Stage 4 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 
> + * include the following:
>   *
>   * For those macros defined with TRACE_EVENT:
>   *