Re: [PATCH 1/3] make kernel-doc understand TRACE_EVENT() macro

From: Jason Baron
Date: Thu Apr 30 2009 - 10:50:33 EST


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@xxxxxxxxxx>

---

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();
}
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/