Patched in Tegra support.

1 files changed, 12 insertions, 323 deletions

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index f565536a2be..d793001929c 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -5,8 +5,7 @@ use strict;
 ## Copyright (c) 1998 Michael Zucchi, All Rights Reserved        ##
 ## Copyright (C) 2000, 1  Tim Waugh <twaugh@redhat.com>          ##
 ## Copyright (C) 2001  Simon Huggins                             ##
-## Copyright (C) 2005-2012  Randy Dunlap                         ##
-## Copyright (C) 2012  Dan Luedtke                               ##
+## Copyright (C) 2005-2010  Randy Dunlap                         ##
 ##                                                               ##
 ## #define enhancements by Armin Kuster <akuster@mvista.com>     ##
 ## Copyright (c) 2000 MontaVista Software, Inc.                  ##
@@ -36,8 +35,6 @@ use strict;
 #              Small fixes (like spaces vs. \s in regex)
 # -- Tim Jansen <tim@tjansen.de>
 
-# 25/07/2012 - Added support for HTML5
-# -- Dan Luedtke <mail@danrl.de>
 
 #
 # This will read a 'c' file and scan for embedded comments in the
@@ -47,16 +44,12 @@ use strict;
 # Note: This only supports 'c'.
 
 # usage:
-# kernel-doc [ -docbook | -html | -html5 | -text | -man | -list ]
-#            [ -no-doc-sections ]
-#            [ -function funcname [ -function funcname ...] ]
-#            c file(s)s > outputfile
+# kernel-doc [ -docbook | -html | -text | -man | -list ] [ -no-doc-sections ]
+#           [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
 # or
-#            [ -nofunction funcname [ -function funcname ...] ]
-#            c file(s)s > outputfile
+#           [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
 #
-#  Set output format using one of -docbook -html -html5 -text or -man.
-#  Default is man.
+#  Set output format using one of -docbook -html -text or -man.  Default is man.
 #  The -list format is for internal use by docproc.
 #
 #  -no-doc-sections
@@ -137,8 +130,6 @@ use strict;
 # should document the "Context:" of the function, e.g. whether the functions
 # can be called form interrupts. Unlike other sections you can end it with an
 # empty line.
-# A non-void function should have a "Return:" section describing the return
-# value(s).
 # Example-sections should contain the string EXAMPLE so that they are marked
 # appropriately in DocBook.
 #
@@ -191,14 +182,6 @@ my $local_lt = "\\\\\\\\lt:";
 my $local_gt = "\\\\\\\\gt:";
 my $blankline_html = $local_lt . "p" . $local_gt;       # was "<p>"
 
-# html version 5
-my %highlights_html5 = ( $type_constant, "<span class=\"const\">\$1</span>",
-                        $type_func, "<span class=\"func\">\$1</span>",
-                        $type_struct_xml, "<span class=\"struct\">\$1</span>",
-                        $type_env, "<span class=\"env\">\$1</span>",
-                        $type_param, "<span class=\"param\">\$1</span>" );
-my $blankline_html5 = $local_lt . "br /" . $local_gt;
-
 # XML, docbook format
 my %highlights_xml = ( "([^=])\\\"([^\\\"<]+)\\\"", "\$1<quote>\$2</quote>",
                         $type_constant, "<constant>\$1</constant>",
@@ -247,7 +230,6 @@ my $dohighlight = "";
 
 my $verbose = 0;
 my $output_mode = "man";
-my $output_preformatted = 0;
 my $no_doc_sections = 0;
 my %highlights = %highlights_man;
 my $blankline = $blankline_man;
@@ -298,10 +280,9 @@ my $doc_special = "\@\%\$\&";
 my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start.
 my $doc_end = '\*/';
 my $doc_com = '\s*\*\s*';
-my $doc_com_body = '\s*\* ?';
 my $doc_decl = $doc_com . '(\w+)';
 my $doc_sect = $doc_com . '([' . $doc_special . ']?[\w\s]+):(.*)';
-my $doc_content = $doc_com_body . '(.*)';
+my $doc_content = $doc_com . '(.*)';
 my $doc_block = $doc_com . 'DOC:\s*(.*)?';
 
 my %constants;
@@ -317,7 +298,6 @@ my $section_default = "Description";	# default section
 my $section_intro = "Introduction";
 my $section = $section_default;
 my $section_context = "Context";
-my $section_return = "Return";
 
 my $undescribed = "-- undescribed --";
 
@@ -329,10 +309,6 @@ while ($ARGV[0] =~ m/^-(.*)/) {
         $output_mode = "html";
         %highlights = %highlights_html;
         $blankline = $blankline_html;
-    } elsif ($cmd eq "-html5") {
-        $output_mode = "html5";
-        %highlights = %highlights_html5;
-        $blankline = $blankline_html5;
     } elsif ($cmd eq "-man") {
         $output_mode = "man";
         %highlights = %highlights_man;
@@ -375,11 +351,10 @@ while ($ARGV[0] =~ m/^-(.*)/) {
 # continue execution near EOF;
 
 sub usage {
-    print "Usage: $0 [ -docbook | -html | -html5 | -text | -man | -list ]\n";
+    print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man | -list ]\n";
     print "         [ -no-doc-sections ]\n";
     print "         [ -function funcname [ -function funcname ...] ]\n";
     print "         [ -nofunction funcname [ -nofunction funcname ...] ]\n";
-    print "         [ -v ]\n";
     print "         c source file(s) > outputfile\n";
     print "         -v : verbose output, more warnings & other info listed\n";
     exit 1;
@@ -473,8 +448,7 @@ sub output_highlight {
 #       confess "output_highlight got called with no args?\n";
 #   }
 
-    if ($output_mode eq "html" || $output_mode eq "html5" ||
-        $output_mode eq "xml") {
+    if ($output_mode eq "html" || $output_mode eq "xml") {
         $contents = local_unescape($contents);
         # convert data read & converted thru xml_escape() into &xyz; format:
         $contents =~ s/\\\\\\/\&/g;
@@ -484,19 +458,9 @@ sub output_highlight {
     die $@ if $@;
 #   print STDERR "contents af:$contents\n";
 
-#   strip whitespaces when generating html5
-    if ($output_mode eq "html5") {
-        $contents =~ s/^\s+//;
-        $contents =~ s/\s+$//;
-    }
     foreach $line (split "\n", $contents) {
-        if (! $output_preformatted) {
-            $line =~ s/^\s*//;
-        }
         if ($line eq ""){
-            if (! $output_preformatted) {
-                print $lineprefix, local_unescape($blankline);
-            }
+            print $lineprefix, local_unescape($blankline);
         } else {
             $line =~ s/\\\\\\/\&/g;
             if ($output_mode eq "man" && substr($line, 0, 1) eq ".") {
@@ -509,7 +473,7 @@ sub output_highlight {
     }
 }
 
-# output sections in html
+#output sections in html
 sub output_section_html(%) {
     my %args = %{$_[0]};
     my $section;
@@ -669,239 +633,6 @@ sub output_blockhead_html(%) {
     print "<hr>\n";
 }
 
-# output sections in html5
-sub output_section_html5(%) {
-    my %args = %{$_[0]};
-    my $section;
-
-    foreach $section (@{$args{'sectionlist'}}) {
-        print "<section>\n";
-        print "<h1>$section</h1>\n";
-        print "<p>\n";
-        output_highlight($args{'sections'}{$section});
-        print "</p>\n";
-        print "</section>\n";
-    }
-}
-
-# output enum in html5
-sub output_enum_html5(%) {
-    my %args = %{$_[0]};
-    my ($parameter);
-    my $count;
-    my $html5id;
-
-    $html5id = $args{'enum'};
-    $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
-    print "<article class=\"enum\" id=\"enum:". $html5id . "\">";
-    print "<h1>enum " . $args{'enum'} . "</h1>\n";
-    print "<ol class=\"code\">\n";
-    print "<li>";
-    print "<span class=\"keyword\">enum</span> ";
-    print "<span class=\"identifier\">" . $args{'enum'} . "</span> {";
-    print "</li>\n";
-    $count = 0;
-    foreach $parameter (@{$args{'parameterlist'}}) {
-        print "<li class=\"indent\">";
-        print "<span class=\"param\">" . $parameter . "</span>";
-        if ($count != $#{$args{'parameterlist'}}) {
-            $count++;
-            print ",";
-        }
-        print "</li>\n";
-    }
-    print "<li>};</li>\n";
-    print "</ol>\n";
-
-    print "<section>\n";
-    print "<h1>Constants</h1>\n";
-    print "<dl>\n";
-    foreach $parameter (@{$args{'parameterlist'}}) {
-        print "<dt>" . $parameter . "</dt>\n";
-        print "<dd>";
-        output_highlight($args{'parameterdescs'}{$parameter});
-        print "</dd>\n";
-    }
-    print "</dl>\n";
-    print "</section>\n";
-    output_section_html5(@_);
-    print "</article>\n";
-}
-
-# output typedef in html5
-sub output_typedef_html5(%) {
-    my %args = %{$_[0]};
-    my ($parameter);
-    my $count;
-    my $html5id;
-
-    $html5id = $args{'typedef'};
-    $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
-    print "<article class=\"typedef\" id=\"typedef:" . $html5id . "\">\n";
-    print "<h1>typedef " . $args{'typedef'} . "</h1>\n";
-
-    print "<ol class=\"code\">\n";
-    print "<li>";
-    print "<span class=\"keyword\">typedef</span> ";
-    print "<span class=\"identifier\">" . $args{'typedef'} . "</span>";
-    print "</li>\n";
-    print "</ol>\n";
-    output_section_html5(@_);
-    print "</article>\n";
-}
-
-# output struct in html5
-sub output_struct_html5(%) {
-    my %args = %{$_[0]};
-    my ($parameter);
-    my $html5id;
-
-    $html5id = $args{'struct'};
-    $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
-    print "<article class=\"struct\" id=\"struct:" . $html5id . "\">\n";
-    print "<hgroup>\n";
-    print "<h1>" . $args{'type'} . " " . $args{'struct'} . "</h1>";
-    print "<h2>". $args{'purpose'} . "</h2>\n";
-    print "</hgroup>\n";
-    print "<ol class=\"code\">\n";
-    print "<li>";
-    print "<span class=\"type\">" . $args{'type'} . "</span> ";
-    print "<span class=\"identifier\">" . $args{'struct'} . "</span> {";
-    print "</li>\n";
-    foreach $parameter (@{$args{'parameterlist'}}) {
-        print "<li class=\"indent\">";
-        if ($parameter =~ /^#/) {
-                print "<span class=\"param\">" . $parameter ."</span>\n";
-                print "</li>\n";
-                next;
-        }
-        my $parameter_name = $parameter;
-        $parameter_name =~ s/\[.*//;
-
-        ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
-        $type = $args{'parametertypes'}{$parameter};
-        if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
-            # pointer-to-function
-            print "<span class=\"type\">$1</span> ";
-            print "<span class=\"param\">$parameter</span>";
-            print "<span class=\"type\">)</span> ";
-            print "(<span class=\"args\">$2</span>);";
-        } elsif ($type =~ m/^(.*?)\s*(:.*)/) {
-            # bitfield
-            print "<span class=\"type\">$1</span> ";
-            print "<span class=\"param\">$parameter</span>";
-            print "<span class=\"bits\">$2</span>;";
-        } else {
-            print "<span class=\"type\">$type</span> ";
-            print "<span class=\"param\">$parameter</span>;";
-        }
-        print "</li>\n";
-    }
-    print "<li>};</li>\n";
-    print "</ol>\n";
-
-    print "<section>\n";
-    print "<h1>Members</h1>\n";
-    print "<dl>\n";
-    foreach $parameter (@{$args{'parameterlist'}}) {
-        ($parameter =~ /^#/) && next;
-
-        my $parameter_name = $parameter;
-        $parameter_name =~ s/\[.*//;
-
-        ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
-        print "<dt>" . $parameter . "</dt>\n";
-        print "<dd>";
-        output_highlight($args{'parameterdescs'}{$parameter_name});
-        print "</dd>\n";
-    }
-    print "</dl>\n";
-    print "</section>\n";
-    output_section_html5(@_);
-    print "</article>\n";
-}
-
-# output function in html5
-sub output_function_html5(%) {
-    my %args = %{$_[0]};
-    my ($parameter, $section);
-    my $count;
-    my $html5id;
-
-    $html5id = $args{'function'};
-    $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
-    print "<article class=\"function\" id=\"func:". $html5id . "\">\n";
-    print "<hgroup>\n";
-    print "<h1>" . $args{'function'} . "</h1>";
-    print "<h2>" . $args{'purpose'} . "</h2>\n";
-    print "</hgroup>\n";
-    print "<ol class=\"code\">\n";
-    print "<li>";
-    print "<span class=\"type\">" . $args{'functiontype'} . "</span> ";
-    print "<span class=\"identifier\">" . $args{'function'} . "</span> (";
-    print "</li>";
-    $count = 0;
-    foreach $parameter (@{$args{'parameterlist'}}) {
-        print "<li class=\"indent\">";
-        $type = $args{'parametertypes'}{$parameter};
-        if ($type =~ m/([^\(]*\(\*)\s*\)\s*\(([^\)]*)\)/) {
-            # pointer-to-function
-            print "<span class=\"type\">$1</span> ";
-            print "<span class=\"param\">$parameter</span>";
-            print "<span class=\"type\">)</span> ";
-            print "(<span class=\"args\">$2</span>)";
-        } else {
-            print "<span class=\"type\">$type</span> ";
-            print "<span class=\"param\">$parameter</span>";
-        }
-        if ($count != $#{$args{'parameterlist'}}) {
-            $count++;
-            print ",";
-        }
-        print "</li>\n";
-    }
-    print "<li>)</li>\n";
-    print "</ol>\n";
-
-    print "<section>\n";
-    print "<h1>Arguments</h1>\n";
-    print "<p>\n";
-    print "<dl>\n";
-    foreach $parameter (@{$args{'parameterlist'}}) {
-        my $parameter_name = $parameter;
-        $parameter_name =~ s/\[.*//;
-
-        ($args{'parameterdescs'}{$parameter_name} ne $undescribed) || next;
-        print "<dt>" . $parameter . "</dt>\n";
-        print "<dd>";
-        output_highlight($args{'parameterdescs'}{$parameter_name});
-        print "</dd>\n";
-    }
-    print "</dl>\n";
-    print "</section>\n";
-    output_section_html5(@_);
-    print "</article>\n";
-}
-
-# output DOC: block header in html5
-sub output_blockhead_html5(%) {
-    my %args = %{$_[0]};
-    my ($parameter, $section);
-    my $count;
-    my $html5id;
-
-    foreach $section (@{$args{'sectionlist'}}) {
-        $html5id = $section;
-        $html5id =~ s/[^a-zA-Z0-9\-]+/_/g;
-        print "<article class=\"doc\" id=\"doc:". $html5id . "\">\n";
-        print "<h1>$section</h1>\n";
-        print "<p>\n";
-        output_highlight($args{'sections'}{$section});
-        print "</p>\n";
-    }
-    print "</article>\n";
-}
-
 sub output_section_xml(%) {
     my %args = %{$_[0]};
     my $section;
@@ -912,12 +643,10 @@ sub output_section_xml(%) {
         print "<title>$section</title>\n";
         if ($section =~ m/EXAMPLE/i) {
             print "<informalexample><programlisting>\n";
-            $output_preformatted = 1;
         } else {
             print "<para>\n";
         }
         output_highlight($args{'sections'}{$section});
-        $output_preformatted = 0;
         if ($section =~ m/EXAMPLE/i) {
             print "</programlisting></informalexample>\n";
         } else {
@@ -1220,12 +949,10 @@ sub output_blockhead_xml(%) {
         }
         if ($section =~ m/EXAMPLE/i) {
             print "<example><para>\n";
-            $output_preformatted = 1;
         } else {
             print "<para>\n";
         }
         output_highlight($args{'sections'}{$section});
-        $output_preformatted = 0;
         if ($section =~ m/EXAMPLE/i) {
             print "</para></example>\n";
         } else {
@@ -1301,12 +1028,10 @@ sub output_function_gnome {
         print "<simplesect>\n <title>$section</title>\n";
         if ($section =~ m/EXAMPLE/i) {
             print "<example><programlisting>\n";
-            $output_preformatted = 1;
         } else {
         }
         print "<para>\n";
         output_highlight($args{'sections'}{$section});
-        $output_preformatted = 0;
         print "</para>\n";
         if ($section =~ m/EXAMPLE/i) {
             print "</programlisting></example>\n";
@@ -2042,28 +1767,6 @@ sub check_sections($$$$$$) {
 }
 
 ##
-# Checks the section describing the return value of a function.
-sub check_return_section {
-        my $file = shift;
-        my $declaration_name = shift;
-        my $return_type = shift;
-
-        # Ignore an empty return type (It's a macro)
-        # Ignore functions with a "void" return type. (But don't ignore "void *")
-        if (($return_type eq "") || ($return_type =~ /void\s*\w*\s*$/)) {
-                return;
-        }
-
-        if (!defined($sections{$section_return}) ||
-            $sections{$section_return} eq "") {
-                print STDERR "Warning(${file}:$.): " .
-                        "No description found for return value of " .
-                        "'$declaration_name'\n";
-                ++$warnings;
-        }
-}
-
-##
 # takes a function prototype and the name of the current file being
 # processed and spits out all the details stored in the global
 # arrays/hashes.
@@ -2079,10 +1782,9 @@ sub dump_function($$) {
     $prototype =~ s/^__inline +//;
     $prototype =~ s/^__always_inline +//;
     $prototype =~ s/^noinline +//;
+    $prototype =~ s/__devinit +//;
     $prototype =~ s/__init +//;
     $prototype =~ s/__init_or_module +//;
-    $prototype =~ s/__must_check +//;
-    $prototype =~ s/__weak +//;
     $prototype =~ s/^#\s*define\s+//; #ak added
     $prototype =~ s/__attribute__\s*\(\([a-z,]*\)\)//;
 
@@ -2133,15 +1835,6 @@ sub dump_function($$) {
         my $prms = join " ", @parameterlist;
         check_sections($file, $declaration_name, "function", $sectcheck, $prms, "");
 
-        # This check emits a lot of warnings at the moment, because many
-        # functions don't have a 'Return' doc section. So until the number
-        # of warnings goes sufficiently down, the check is only performed in
-        # verbose mode.
-        # TODO: always perform the check.
-        if ($verbose) {
-                check_return_section($file, $declaration_name, $return_type);
-        }
-
     output_declaration($declaration_name,
                        'function',
                        {'function' => $declaration_name,
@@ -2351,9 +2044,6 @@ sub process_file($) {
 
     $section_counter = 0;
     while (<IN>) {
-        while (s/\\\s*$//) {
-            $_ .= <IN>;
-        }
         if ($state == 0) {
             if (/$doc_start/o) {
                 $state = 1;             # next line is always the function name
@@ -2381,7 +2071,7 @@ sub process_file($) {
                     $descr= $1;
                     $descr =~ s/^\s*//;
                     $descr =~ s/\s*$//;
-                    $descr =~ s/\s+/ /g;
+                    $descr =~ s/\s+/ /;
                     $declaration_purpose = xml_escape($descr);
                     $in_purpose = 1;
                 } else {
@@ -2473,7 +2163,6 @@ sub process_file($) {
                     # Continued declaration purpose
                     chomp($declaration_purpose);
                     $declaration_purpose .= " " . xml_escape($1);
-                    $declaration_purpose =~ s/\s+/ /g;
                 } else {
                     $contents .= $1 . "\n";
                 }