checkpatch: prefer ftrace over function entry/exit printks

[linux-2.6-microblaze.git] / scripts / kernel-doc

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 6325bec..e046e16 100755 (executable)
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -382,6 +382,9 @@ my $inline_doc_state;
 # 'function', 'struct', 'union', 'enum', 'typedef'
 my $decl_type;
 
+# Name of the kernel-doc identifier for non-DOC markups
+my $identifier;
+
 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
 my $doc_end = '\*/';
 my $doc_com = '\s*\*\s*';
@@ -833,6 +836,7 @@ sub output_blockhead_rst(%) {
        next if (defined($nosymbol_table{$section}));
 
        if ($output_selection != OUTPUT_INCLUDE) {
+           print ".. _$section:\n\n";
            print "**$section**\n\n";
        }
         print_lineno($section_start_lines{$section});
@@ -1203,6 +1207,11 @@ sub dump_struct($$) {
        $declaration_name = $2;
        my $members = $3;
 
+       if ($identifier ne $declaration_name) {
+           print STDERR "${file}:$.: warning: expecting prototype for $decl_type $identifier. Prototype was for $decl_type $declaration_name instead\n";
+           return;
+       }
+
        # ignore members marked private:
        $members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gosi;
        $members =~ s/\/\*\s*private:.*//gosi;
@@ -1391,6 +1400,11 @@ sub dump_enum($$) {
     }
 
     if ($members) {
+       if ($identifier ne $declaration_name) {
+           print STDERR "${file}:$.: warning: expecting prototype for enum $identifier. Prototype was for enum $declaration_name instead\n";
+           return;
+       }
+
        my %_members;
 
        $members =~ s/\s+$//;
@@ -1451,6 +1465,11 @@ sub dump_typedef($$) {
        my $args = $3;
        $return_type =~ s/^\s+//;
 
+       if ($identifier ne $declaration_name) {
+           print STDERR "${file}:$.: warning: expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n";
+           return;
+       }
+
        create_parameterlist($args, ',', $file, $declaration_name);
 
        output_declaration($declaration_name,
@@ -1477,6 +1496,11 @@ sub dump_typedef($$) {
     if ($x =~ /typedef.*\s+(\w+)\s*;/) {
        $declaration_name = $1;
 
+       if ($identifier ne $declaration_name) {
+           print STDERR "${file}:$.: warning: expecting prototype for typedef $identifier. Prototype was for typedef $declaration_name instead\n";
+           return;
+       }
+
        output_declaration($declaration_name,
                           'typedef',
                           {'typedef' => $declaration_name,
@@ -1796,6 +1820,11 @@ sub dump_function($$) {
        return;
     }
 
+    if ($identifier ne $declaration_name) {
+       print STDERR "${file}:$.: warning: expecting prototype for $identifier(). Prototype was for $declaration_name() instead\n";
+       return;
+    }
+
     my $prms = join " ", @parameterlist;
     check_sections($file, $declaration_name, "function", $sectcheck, $prms);
 
@@ -1878,6 +1907,7 @@ sub tracepoint_munge($) {
                             "$prototype\n";
        } else {
                $prototype = "static inline void trace_$tracepointname($tracepointargs)";
+               $identifier = "trace_$identifier";
        }
 }
 
@@ -2041,7 +2071,6 @@ sub process_normal() {
 #
 sub process_name($$) {
     my $file = shift;
-    my $identifier;
     my $descr;
 
     if (/$doc_block/o) {
@@ -2054,12 +2083,19 @@ sub process_name($$) {
        } else {
            $section = $1;
        }
-    }
-    elsif (/$doc_decl/o) {
+    } elsif (/$doc_decl/o) {
        $identifier = $1;
-       if (/\s*([\w\s]+?)(\(\))?\s*-/) {
+       if (/\s*([\w\s]+?)(\(\))?\s*([-:].*)?$/) {
            $identifier = $1;
        }
+       if ($identifier =~ m/^(struct|union|enum|typedef)\b\s*(\S*)/) {
+           $decl_type = $1;
+           $identifier = $2;
+       } else {
+           $decl_type = 'function';
+           $identifier =~ s/^define\s+//;
+       }
+       $identifier =~ s/\s+$//;
 
        $state = STATE_BODY;
        # if there's no @param blocks need to set up default section
@@ -2067,7 +2103,7 @@ sub process_name($$) {
        $contents = "";
        $section = $section_default;
        $new_start_line = $. + 1;
-       if (/-(.*)/) {
+       if (/[-:](.*)/) {
            # strip leading/trailing/multiple spaces
            $descr= $1;
            $descr =~ s/^\s*//;
@@ -2085,20 +2121,15 @@ sub process_name($$) {
            ++$warnings;
        }
 
-       if ($identifier =~ m/^struct\b/) {
-           $decl_type = 'struct';
-       } elsif ($identifier =~ m/^union\b/) {
-           $decl_type = 'union';
-       } elsif ($identifier =~ m/^enum\b/) {
-           $decl_type = 'enum';
-       } elsif ($identifier =~ m/^typedef\b/) {
-           $decl_type = 'typedef';
-       } else {
-           $decl_type = 'function';
+       if ($identifier eq "") {
+           print STDERR "${file}:$.: warning: wrong kernel-doc identifier on line:\n";
+           print STDERR $_;
+           ++$warnings;
+           $state = STATE_NORMAL;
        }
 
        if ($verbose) {
-           print STDERR "${file}:$.: info: Scanning doc for $identifier\n";
+           print STDERR "${file}:$.: info: Scanning doc for $decl_type $identifier\n";
        }
     } else {
        print STDERR "${file}:$.: warning: Cannot understand $_ on line $.",