tracing: update sample with TRACE_INCLUDE_FILE
authorSteven Rostedt <srostedt@redhat.com>
Thu, 7 May 2009 01:20:39 +0000 (21:20 -0400)
committerSteven Rostedt <rostedt@goodmis.org>
Thu, 7 May 2009 03:10:42 +0000 (23:10 -0400)
commit71e1c8ac42ae4038ddb1367cce7097ab868dc532
treea8e7ce8c468ad924da2d510df95c4da84edbb309
parent3e07a4f680adc66dfa175aa5021aedf340251b12
tracing: update sample with TRACE_INCLUDE_FILE

When creating trace events for ftrace, the header file with the TRACE_EVENT
macros must also have a macro called TRACE_SYSTEM. This macro describes
the name of the system the TRACE_EVENTS are defined for. It also doubles
as a way for the define_trace.h file to include the file that included
it.

For example:

in irq.h

 #define TRACE_SYSTEM irq

[...]

 #include <trace/define_trace.h>

The define_trace will use TRACE_SYSTEM to include irq.h. But if the name
of the trace system does not match the name of the trace header file,
one can override it with:

Which will change define_trace.h to inclued foo_trace.h instead of foo.h

The sample comments this, but people that use the sample code will more
likely use the code and not read the comments. This patch changes the
sample code to use the TRACE_INCLUDE_FILE to better show developers how to
use it.

[ Impact: make sample less confusing to developers ]

Reported-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
samples/trace_events/trace-events-sample.h