Commit 3a9089fd authored Dec 01, 2009 by Jason Baron Committed by Ingo Molnar Dec 02, 2009

tracing: Add DEFINE_EVENT(), DEFINE_SINGLE_EVENT() support to docbook



The introduction of the new 'DECLARE_EVENT_CLASS()' obviates the
need for the 'TRACE_EVENT()' macro in some cases. Thus, docbook
style comments that used to live with 'TRACE_EVENT()' are now
moved to 'DEFINE_EVENT()'. Thus, we need to make the docbook
system understand the new 'DEFINE_EVENT()' macro. In addition
I've tried to futureproof the patch, by also adding support for
'DEFINE_SINGLE_EVENT()', since there has been discussion about
renaming: TRACE_EVENT() -> DEFINE_SINGLE_EVENT().

Without this patch the tracepoint docbook fails to build.

I've verified that this patch correctly builds the tracepoint
docbook which currently covers signals, and irqs.

Changes in v2:
 - properly indent perl 'if' statements

Signed-off-by: Jason Baron <jbaron@redhat.com>
Acked-by: Steven Rostedt <rostedt@goodmis.org>
Acked-by: Randy Dunlap <randy.dunlap@oracle.com>
Cc: William Cohen <wcohen@redhat.com>
Cc: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
Cc: Masami Hiramatsu <mhiramat@redhat.com>
LKML-Reference: <200912011718.nB1HIn7t011371@int-mx04.intmail.prod.int.phx2.redhat.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>

parent ec70ccd8

scripts/kernel-doc

+12 −3

Original line number	Diff line number	Diff line
		@@ -1855,6 +1855,13 @@ sub tracepoint_munge($) {
		if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
		$tracepointname = $1;
		}
		if ($prototype =~ m/DEFINE_SINGLE_EVENT\((.*?),/) {
		$tracepointname = $1;
		}
		if ($prototype =~ m/DEFINE_EVENT\((.?),(.?),/) {
		$tracepointname = $2;
		}
		$tracepointname =~ s/^\s+//; #strip leading whitespace
		if ($prototype =~ m/TP_PROTO$(.*?)$/) {
		$tracepointargs = $1;
		}
		@@ -1920,7 +1927,9 @@ sub process_state3_function($$) {
		if ($prototype =~ /SYSCALL_DEFINE/) {
		syscall_munge();
		}
		if ($prototype =~ /TRACE_EVENT/) {
		if ($prototype =~ /TRACE_EVENT/ \|\| $prototype =~ /DEFINE_EVENT/ \|\|
		$prototype =~ /DEFINE_SINGLE_EVENT/)
		{
		tracepoint_munge($file);
		}
		dump_function($prototype, $file);

Admin message