linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/3] make kernel-doc understand TRACE_EVENT() macro
@ 2009-04-29 17:45 Jason Baron
  2009-04-29 19:17 ` Randy Dunlap
  0 siblings, 1 reply; 5+ messages in thread
From: Jason Baron @ 2009-04-29 17:45 UTC (permalink / raw)
  To: linux-kernel
  Cc: akpm, mingo, rostedt, fweisbec, mathieu.desnoyers, randy.dunlap,
	wcohen


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@redhat.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"
+	} 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();
     }
-- 
1.5.4.5


^ permalink raw reply related	[flat|nested] 5+ messages in thread

* Re: [PATCH 1/3] make kernel-doc understand TRACE_EVENT() macro
  2009-04-29 17:45 [PATCH 1/3] make kernel-doc understand TRACE_EVENT() macro Jason Baron
@ 2009-04-29 19:17 ` Randy Dunlap
  2009-04-29 20:34   ` Ingo Molnar
  2009-04-30 14:48   ` Jason Baron
  0 siblings, 2 replies; 5+ messages in thread
From: Randy Dunlap @ 2009-04-29 19:17 UTC (permalink / raw)
  To: Jason Baron
  Cc: linux-kernel, akpm, mingo, rostedt, fweisbec, mathieu.desnoyers,
	wcohen

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@redhat.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

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH 1/3] make kernel-doc understand TRACE_EVENT() macro
  2009-04-29 19:17 ` Randy Dunlap
@ 2009-04-29 20:34   ` Ingo Molnar
  2009-04-29 22:03     ` Randy Dunlap
  2009-04-30 14:48   ` Jason Baron
  1 sibling, 1 reply; 5+ messages in thread
From: Ingo Molnar @ 2009-04-29 20:34 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: Jason Baron, linux-kernel, akpm, rostedt, fweisbec,
	mathieu.desnoyers, wcohen


* Randy Dunlap <randy.dunlap@oracle.com> wrote:

> 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@redhat.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 ....

Good point - i'll wait for v2. Or would you like to carry them in 
your kernel-doc tree?

This bit:

 include/trace/events/irq.h            |   46 ++++++++++++++++++++++++++++++---

Has changed in the tracing tree so it's probably better to carry it 
there - once your review feedback has been addressed and once your 
Acked-by is propagated into the patches.

Thanks,

	Ingo

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH 1/3] make kernel-doc understand TRACE_EVENT() macro
  2009-04-29 20:34   ` Ingo Molnar
@ 2009-04-29 22:03     ` Randy Dunlap
  0 siblings, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2009-04-29 22:03 UTC (permalink / raw)
  To: Ingo Molnar
  Cc: Jason Baron, linux-kernel, akpm, rostedt, fweisbec,
	mathieu.desnoyers, wcohen

Ingo Molnar wrote:
> * Randy Dunlap <randy.dunlap@oracle.com> wrote:
> 
>> 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@redhat.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 ....
> 
> Good point - i'll wait for v2. Or would you like to carry them in 
> your kernel-doc tree?
> 
> This bit:
> 
>  include/trace/events/irq.h            |   46 ++++++++++++++++++++++++++++++---
> 
> Has changed in the tracing tree so it's probably better to carry it 
> there - once your review feedback has been addressed and once your 
> Acked-by is propagated into the patches.

Yes, that's fine with me.  Thanks.

-- 
~Randy

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH 1/3] make kernel-doc understand TRACE_EVENT() macro
  2009-04-29 19:17 ` Randy Dunlap
  2009-04-29 20:34   ` Ingo Molnar
@ 2009-04-30 14:48   ` Jason Baron
  1 sibling, 0 replies; 5+ messages in thread
From: Jason Baron @ 2009-04-30 14:48 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-kernel, akpm, mingo, rostedt, fweisbec, mathieu.desnoyers,
	wcohen

On Wed, Apr 29, 2009 at 12:17:37PM -0700, Randy Dunlap wrote:
> 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.
> 
> 

ok, updated patch:


Add support to kernel-doc script for tracepoint comments above 
TRACE_EVENT() macro definitions. Paves the way for tracepoint docbook.


Signed-off-by: Jason Baron <jbaron@redhat.com>

---

 scripts/kernel-doc |   22 ++++++++++++++++++++++
 1 files changed, 22 insertions(+), 0 deletions(-)


diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 0f11870..2b53a55 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1827,6 +1827,25 @@ sub reset_state {
     $state = 0;
 }
 
+sub tracepoint_munge($) {
+	my $file = shift;
+	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(${file}:$.): Unrecognized tracepoint format: \n".
+			     "$prototype\n";
+	} else {
+		$prototype = "static inline void trace_$tracepointname($tracepointargs)";
+	}
+}
+
 sub syscall_munge() {
 	my $void = 0;
 
@@ -1881,6 +1900,9 @@ sub process_state3_function($$) {
 	if ($prototype =~ /SYSCALL_DEFINE/) {
 		syscall_munge();
 	}
+	if ($prototype =~ /TRACE_EVENT/) {
+		tracepoint_munge($file);
+	}
 	dump_function($prototype, $file);
 	reset_state();
     }

^ permalink raw reply related	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2009-04-30 14:50 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-04-29 17:45 [PATCH 1/3] make kernel-doc understand TRACE_EVENT() macro Jason Baron
2009-04-29 19:17 ` Randy Dunlap
2009-04-29 20:34   ` Ingo Molnar
2009-04-29 22:03     ` Randy Dunlap
2009-04-30 14:48   ` Jason Baron

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).