linux-kernel - Re: [PATCH 1/3] make kernel-doc understand TRACE

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <49F8A7D1.6010307@oracle.com>
Date:	Wed, 29 Apr 2009 12:17:37 -0700
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	Jason Baron <jbaron@...hat.com>
CC:	linux-kernel@...r.kernel.org, akpm@...ux-foundation.org,
	mingo@...e.hu, rostedt@...dmis.org, fweisbec@...il.com,
	mathieu.desnoyers@...ymtl.ca, wcohen@...hat.com
Subject: Re: [PATCH 1/3] make kernel-doc understand TRACE_EVENT() macro

Jason Baron wrote:
> Add support to kernel-doc for tracepoint comments above TRACE_EVENT()
> macro definitions. Paves the way for tracepoint docbook.
> 
> 
> Signed-off-by: Jason Baron <jbaron@...hat.com>
> 
> ---
>  scripts/kernel-doc |   21 +++++++++++++++++++++
>  1 files changed, 21 insertions(+), 0 deletions(-)
> 
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index 0f11870..9d9ab4b 100755
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -1827,6 +1827,24 @@ sub reset_state {
>      $state = 0;
>  }
>  
> +sub tracepoint_munge() {
> +	my $tracepointname = 0;
> +	my $tracepointargs = 0;
> +
> +	if($prototype =~ m/TRACE_EVENT\((.*?),/) {
> +		$tracepointname = $1;
> +	}
> +	if($prototype =~ m/TP_PROTO\((.*?)\)/) {
> +		$tracepointargs = $1;
> +	}
> +	if (($tracepointname eq 0) || ($tracepointargs eq 0)) {
> +		print STDERR "Warning: Unrecognized tracepoint format: \n" .
> +			     "$prototype\n"

I'd prefer for this warning to use the usual kernel-doc warning format, with
file:line information:

		print STDERR "Warning(${file}:$.): Unrecognized ....

Otherwise, looks good.  Thanks.


> +	} else {
> +		$prototype = "static inline void trace_$tracepointname($tracepointargs)";
> +	}
> +}
> +
>  sub syscall_munge() {
>  	my $void = 0;
>  
> @@ -1881,6 +1899,9 @@ sub process_state3_function($$) {
>  	if ($prototype =~ /SYSCALL_DEFINE/) {
>  		syscall_munge();
>  	}
> +	if ($prototype =~ /TRACE_EVENT/) {
> +		tracepoint_munge();
> +	}
>  	dump_function($prototype, $file);
>  	reset_state();
>      }


-- 
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/