* Re: [PATCH] ftrace: Fix comments about trace/ftrace.h
2015-03-02 14:28 [PATCH] ftrace: Fix comments about trace/ftrace.h Hou Pengyang
@ 2015-03-02 14:10 ` Steven Rostedt
2015-03-03 2:38 ` Hou Pengyang
0 siblings, 1 reply; 5+ messages in thread
From: Steven Rostedt @ 2015-03-02 14:10 UTC (permalink / raw)
To: Hou Pengyang; +Cc: mingo, wangnan0, linux-kernel
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:
> *
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH] ftrace: Fix comments about trace/ftrace.h
@ 2015-03-02 14:28 Hou Pengyang
2015-03-02 14:10 ` Steven Rostedt
0 siblings, 1 reply; 5+ messages in thread
From: Hou Pengyang @ 2015-03-02 14:28 UTC (permalink / raw)
To: rostedt, mingo; +Cc: wangnan0, linux-kernel
commit f42c85e74faa422cf0bc747ed808681145448f88 moves tracepoint's ftrace
creation into include/trace/ftrace.h and trace/define_trach.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
+ * 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:
*
--
1.8.3.4
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] ftrace: Fix comments about trace/ftrace.h
2015-03-02 14:10 ` Steven Rostedt
@ 2015-03-03 2:38 ` Hou Pengyang
2015-03-03 4:06 ` Steven Rostedt
0 siblings, 1 reply; 5+ messages in thread
From: Hou Pengyang @ 2015-03-03 2:38 UTC (permalink / raw)
To: Steven Rostedt; +Cc: mingo, wangnan0, linux-kernel
On 2015/3/2 22:10, Steven Rostedt wrote:
> 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.
yes, commit f42c85e74faa422cf0bc747ed808681145448f88 refactored code,
and event_trace.h was 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
>
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/ .
>
>> + * 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:
>> *
>
>
> .
>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH] ftrace: Fix comments about trace/ftrace.h
2015-03-03 2:38 ` Hou Pengyang
@ 2015-03-03 4:06 ` Steven Rostedt
2015-03-03 21:48 ` Hou Pengyang
0 siblings, 1 reply; 5+ messages in thread
From: Steven Rostedt @ 2015-03-03 4:06 UTC (permalink / raw)
To: Hou Pengyang; +Cc: mingo, wangnan0, linux-kernel
On Tue, 3 Mar 2015 10:38:19 +0800
Hou Pengyang <houpengyang@huawei.com> 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
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH] ftrace: Fix comments about trace/ftrace.h
2015-03-03 4:06 ` Steven Rostedt
@ 2015-03-03 21:48 ` Hou Pengyang
0 siblings, 0 replies; 5+ messages in thread
From: Hou Pengyang @ 2015-03-03 21:48 UTC (permalink / raw)
To: linux-kernel, rostedt; +Cc: mingo, wangnan0
commit f42c85e74faa422cf0bc747ed808681145448f88 moved tracepoint's ftrace
creation into include/trace/ftrace.h and trace/define_trach.h was deleted
as a result. However some comment info does not adapt to the change, which
is such a misguiding when reading related code.
This patch fix this by moving trace/trace_events.h to <trace/events/XXX.h>,
since tracepoint headers have already been moved to tarce/events/.
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..44f9a98 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 the event tracepoint header <trace/events/XXX.h>
+ * to 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 the event tracepoint header <trace/events/XXX.h>
+ * 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 the event tracepoint header <trace/events/XXX.h>
+ * to include the following:
*
* For those macros defined with TRACE_EVENT:
*
--
1.8.3.4
^ permalink raw reply related [flat|nested] 5+ messages in thread
end of thread, other threads:[~2015-03-03 13:39 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2015-03-02 14:28 [PATCH] ftrace: Fix comments about trace/ftrace.h Hou Pengyang
2015-03-02 14:10 ` Steven Rostedt
2015-03-03 2:38 ` Hou Pengyang
2015-03-03 4:06 ` Steven Rostedt
2015-03-03 21:48 ` Hou Pengyang
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).