Re: [PATCH 2/2] trace_events: fix the include file dependencies

[Steven Rostedt]

On Tue, 25 Aug 2009, Frederic Weisbecker wrote:

> On Tue, Aug 25, 2009 at 02:06:22PM +0800, Xiao Guangrong wrote:
> > The TRACE_EVENT depend on the include/linux/tracepoint.h first
> > and include/trace/ftrace.h later, if we include the ftrace.h early,
> > It'll occur building error, like blow:
> > 
> > Both define TRACE_EVENT in trace_a.h and trace_b.h, if we include
> > those in .c file, like this:
> > 
> > #define CREATE_TRACE_POINTS
> > include <trace/events/trace_a.h>
> > include <trace/events/trace_b.h>
> > 
> > There are can't work,  because the TRACE_EVENT has re-defined by
> > the previous .h file
> > 
> > Reported-by: Wei Yongjun <yjwei@xxxxxxxxxxxxxx>
> > Signed-off-by: Xiao Guangrong <xiaoguangrong@xxxxxxxxxxxxxx>
> > ---
> >  include/linux/tracepoint.h   |    3 +--
> >  include/trace/define_trace.h |    1 +
> >  2 files changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/include/linux/tracepoint.h b/include/linux/tracepoint.h
> > index 5984ed0..8170985 100644
> > --- a/include/linux/tracepoint.h
> > +++ b/include/linux/tracepoint.h
> > @@ -180,6 +180,7 @@ static inline void tracepoint_synchronize_unregister(void)
> >  }
> >  
> >  #define PARAMS(args...) args
> > +#endif
> 
> 
> Please add a comment to explain what your endifs are closing, that helps
> for reviews. Especially while walking on such complicated header files,
> it's a crutch.
> 
> I guess this one closes _LINUX_TRACEPOINT_H, right?

This needs a lot more than a simple /* _LINUX_TRACEPOINT_H */ comment. It 
needs a nice explanation to why this is happening. This is a global header 
(located in include/linux), when it does something out of the norm, it 
needs a nice comment to explain why.

I'll pull this in and add a separate commit that adds the comment.

Thanks!

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