Re: [PATCH v2] tracing: add DEFINE_EVENT(), DEFINE_SINGLE_EVENT() support to docbook

[Randy Dunlap <randy.dunlap@oracle.com>]

Jason Baron wrote:
> 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>
> Cc: Randy Dunlap <randy.dunlap@oracle.com>

Acked-by: Randy Dunlap <randy.dunlap@oracle.com>

Thanks.

> 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>
> ---
>  scripts/kernel-doc |   15 ++++++++++++---
>  1 files changed, 12 insertions(+), 3 deletions(-)
> 
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index ea9f8a5..241310e 100755
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -1852,10 +1852,17 @@ sub tracepoint_munge($) {
>  	my $tracepointname = 0;
>  	my $tracepointargs = 0;
>  
> -	if($prototype =~ m/TRACE_EVENT\((.*?),/) {
> +	if ($prototype =~ m/TRACE_EVENT\((.*?),/) {
>  		$tracepointname = $1;
>  	}
> -	if($prototype =~ m/TP_PROTO\((.*?)\)/) {
> +	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;
>  	}
>  	if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
> @@ -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);


-- 
~Randy