[PATCH] kernel-doc: clean up the script (whitespace)

Remove lots of trailing whitespace. Nothing else. Signed-off-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>

[PATCH] kernel-doc: clean up the script (whitespace)
Remove lots of trailing whitespace. Nothing else. Signed-off-by: Randy Dunlap <rdunlap@xenotime.net> Signed-off-by: Andrew Morton <akpm@osdl.org> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
Randy Dunlap · Linus Torvalds
1 parent d28bee0c0a
Showing 1 changed file with 34 additions and 34 deletions Side-by-side Diff
scripts/kernel-doc
@@ -90,28 +90,28 @@
 #  * my_function - does my stuff
 #  * @my_arg: its mine damnit
 #  *
-#  * Does my stuff explained. 
+#  * Does my stuff explained.
 #  */
 #
 #  or, could also use:
 # /**
 #  * my_function - does my stuff
 #  * @my_arg: its mine damnit
-#  * Description: Does my stuff explained. 
+#  * Description: Does my stuff explained.
 #  */
 # etc.
 #
-# Beside functions you can also write documentation for structs, unions, 
-# enums and typedefs. Instead of the function name you must write the name 
-# of the declaration;  the struct/union/enum/typedef must always precede 
-# the name. Nesting of declarations is not supported. 
+# Beside functions you can also write documentation for structs, unions,
+# enums and typedefs. Instead of the function name you must write the name
+# of the declaration;  the struct/union/enum/typedef must always precede
+# the name. Nesting of declarations is not supported.
 # Use the argument mechanism to document members or constants.
 # e.g.
 # /**
 #  * struct my_struct - short description
 #  * @a: first member
 #  * @b: second member
-#  * 
+#  *
 #  * Longer description
 #  */
 # struct my_struct {
  
@@ -122,12 +122,12 @@
 # };
 #
 # All descriptions can be multiline, except the short function description.
-# 
-# You can also add additional sections. When documenting kernel functions you 
-# should document the "Context:" of the function, e.g. whether the functions 
+#
+# You can also add additional sections. When documenting kernel functions you
+# 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. 
-# Example-sections should contain the string EXAMPLE so that they are marked 
+# empty line.
+# Example-sections should contain the string EXAMPLE so that they are marked
 # appropriately in DocBook.
 #
 # Example:
@@ -135,7 +135,7 @@
 #  * user_function - function that can only be called in user context
 #  * @a: some argument
 #  * Context: !in_interrupt()
-#  * 
+#  *
 #  * Some description
 #  * Example:
 #  *    user_function(22);
@@ -223,9 +223,9 @@
 my $blankline = $blankline_man;
 my $modulename = "Kernel API";
 my $function_only = 0;
-my $man_date = ('January', 'February', 'March', 'April', 'May', 'June', 
-		'July', 'August', 'September', 'October', 
-		'November', 'December')[(localtime)[4]] . 
+my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
+		'July', 'August', 'September', 'October',
+		'November', 'December')[(localtime)[4]] .
   " " . ((localtime)[5]+1900);
  
 # Essentially these are globals
@@ -236,7 +236,7 @@
 my ($type,$declaration_name,$return_type);
 my ($newsection,$newcontents,$prototype,$filelist, $brcount, %source_map);
  
-# Generated docbook code is inserted in a template at a point where 
+# Generated docbook code is inserted in a template at a point where
 # docbook v3.1 requires a non-zero sequence of RefEntry's; see:
 # http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
 # We keep track of number of generated entries and generate a dummy
@@ -365,7 +365,7 @@
 #  parameterdescs => %parameter descriptions
 #  sectionlist => @list of sections
 #  sections => %descriont descriptions
-#  
+#
  
 sub output_highlight {
     my $contents = join "\n",@_;
@@ -400,7 +400,7 @@
 	print "<blockquote>\n";
 	output_highlight($args{'sections'}{$section});
 	print "</blockquote>\n";
-    }  
+    }
 }
  
 # output enum in html
@@ -551,7 +551,7 @@
  
 sub output_section_xml(%) {
     my %args = %{$_[0]};
-    my $section;    
+    my $section;
     # print out each section
     $lineprefix="   ";
     foreach $section (@{$args{'sectionlist'}}) {
@@ -778,7 +778,7 @@
     print "</refsynopsisdiv>\n";
  
     print "<refsect1>\n";
-    print " <title>Constants</title>\n";    
+    print " <title>Constants</title>\n";
     print "  <variablelist>\n";
     foreach $parameter (@{$args{'parameterlist'}}) {
       my $parameter_name = $parameter;
@@ -1157,7 +1157,7 @@
     foreach $section (@{$args{'sectionlist'}}) {
 	print "$section:\n\n";
 	output_highlight($args{'sections'}{$section});
-    }  
+    }
     print "\n\n";
 }
  
@@ -1262,8 +1262,8 @@
     my $name = shift;
     my $functype = shift;
     my $func = "output_${functype}_$output_mode";
-    if (($function_only==0) || 
-	( $function_only == 1 && defined($function_table{$name})) || 
+    if (($function_only==0) ||
+	( $function_only == 1 && defined($function_table{$name})) ||
 	( $function_only == 2 && !defined($function_table{$name})))
     {
         &$func(@_);
@@ -1282,7 +1282,7 @@
 }
  
 ##
-# takes a declaration (struct, union, enum, typedef) and 
+# takes a declaration (struct, union, enum, typedef) and
 # invokes the right handler. NOT called for functions.
 sub dump_declaration($$) {
     no strict 'refs';
@@ -1352,7 +1352,7 @@
 	    }
  
 	}
-	
+
 	output_declaration($declaration_name,
 			   'enum',
 			   {'enum' => $declaration_name,
@@ -1409,7 +1409,7 @@
     while ($args =~ /(\([^\),]+),/) {
         $args =~ s/(\([^\),]+),/$1#/g;
     }
-    
+
     foreach my $arg (split($splitter, $args)) {
 	# strip comments
 	$arg =~ s/\/\*.*\*\///;
@@ -1558,7 +1558,7 @@
 	return;
     }
  
-    output_declaration($declaration_name, 
+    output_declaration($declaration_name,
 		       'function',
 		       {'function' => $declaration_name,
 			'module' => $modulename,
  
@@ -1617,11 +1617,11 @@
     %sections = ();
     @sectionlist = ();
     $prototype = "";
-    
+
     $state = 0;
 }
  
-sub process_state3_function($$) { 
+sub process_state3_function($$) {
     my $x = shift;
     my $file = shift;
  
@@ -1640,7 +1640,7 @@
     }
 }
  
-sub process_state3_type($$) { 
+sub process_state3_type($$) {
     my $x = shift;
     my $file = shift;
  
@@ -1780,7 +1780,7 @@
 	    } elsif (/$doc_content/) {
 		# miguel-style comment kludge, look for blank lines after
 		# @parameter line to signify start of description
-		if ($1 eq "" && 
+		if ($1 eq "" &&
 			($section =~ m/^@/ || $section eq $section_context)) {
 		    dump_section($section, xml_escape($contents));
 		    $section = $section_default;
@@ -1790,7 +1790,7 @@
 		}
 	    } else {
 		# i dont know - bad line?  ignore.
-		print STDERR "Warning(${file}:$.): bad line: $_"; 
+		print STDERR "Warning(${file}:$.): bad line: $_";
 		++$warnings;
 	    }
 	} elsif ($state == 3) {	# scanning for function { (end of prototype)
@@ -1845,7 +1845,7 @@
 			else
 			{
 				$contents .= $1 . "\n";
-			}	
+			}
         	}
           }
     }
...	...	@@ -90,28 +90,28 @@
90	90	# * my_function - does my stuff
91	91	# * @my_arg: its mine damnit
92	92	# *
93		-# * Does my stuff explained.
	93	+# * Does my stuff explained.
94	94	# */
95	95	#
96	96	# or, could also use:
97	97	# /**
98	98	# * my_function - does my stuff
99	99	# * @my_arg: its mine damnit
100		-# * Description: Does my stuff explained.
	100	+# * Description: Does my stuff explained.
101	101	# */
102	102	# etc.
103	103	#
104		-# Beside functions you can also write documentation for structs, unions,
105		-# enums and typedefs. Instead of the function name you must write the name
106		-# of the declaration; the struct/union/enum/typedef must always precede
107		-# the name. Nesting of declarations is not supported.
	104	+# Beside functions you can also write documentation for structs, unions,
	105	+# enums and typedefs. Instead of the function name you must write the name
	106	+# of the declaration; the struct/union/enum/typedef must always precede
	107	+# the name. Nesting of declarations is not supported.
108	108	# Use the argument mechanism to document members or constants.
109	109	# e.g.
110	110	# /**
111	111	# * struct my_struct - short description
112	112	# * @a: first member
113	113	# * @b: second member
114		-# *
	114	+# *
115	115	# * Longer description
116	116	# */
117	117	# struct my_struct {
118	118
...	...	@@ -122,12 +122,12 @@
122	122	# };
123	123	#
124	124	# All descriptions can be multiline, except the short function description.
125		-#
126		-# You can also add additional sections. When documenting kernel functions you
127		-# should document the "Context:" of the function, e.g. whether the functions
	125	+#
	126	+# You can also add additional sections. When documenting kernel functions you
	127	+# should document the "Context:" of the function, e.g. whether the functions
128	128	# can be called form interrupts. Unlike other sections you can end it with an
129		-# empty line.
130		-# Example-sections should contain the string EXAMPLE so that they are marked
	129	+# empty line.
	130	+# Example-sections should contain the string EXAMPLE so that they are marked
131	131	# appropriately in DocBook.
132	132	#
133	133	# Example:
...	...	@@ -135,7 +135,7 @@
135	135	# * user_function - function that can only be called in user context
136	136	# * @a: some argument
137	137	# * Context: !in_interrupt()
138		-# *
	138	+# *
139	139	# * Some description
140	140	# * Example:
141	141	# * user_function(22);
...	...	@@ -223,9 +223,9 @@
223	223	my $blankline = $blankline_man;
224	224	my $modulename = "Kernel API";
225	225	my $function_only = 0;
226		-my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
227		- 'July', 'August', 'September', 'October',
228		- 'November', 'December')[(localtime)[4]] .
	226	+my $man_date = ('January', 'February', 'March', 'April', 'May', 'June',
	227	+ 'July', 'August', 'September', 'October',
	228	+ 'November', 'December')[(localtime)[4]] .
229	229	" " . ((localtime)[5]+1900);
230	230
231	231	# Essentially these are globals
...	...	@@ -236,7 +236,7 @@
236	236	my ($type,$declaration_name,$return_type);
237	237	my ($newsection,$newcontents,$prototype,$filelist, $brcount, %source_map);
238	238
239		-# Generated docbook code is inserted in a template at a point where
	239	+# Generated docbook code is inserted in a template at a point where
240	240	# docbook v3.1 requires a non-zero sequence of RefEntry's; see:
241	241	# http://www.oasis-open.org/docbook/documentation/reference/html/refentry.html
242	242	# We keep track of number of generated entries and generate a dummy
...	...	@@ -365,7 +365,7 @@
365	365	# parameterdescs => %parameter descriptions
366	366	# sectionlist => @list of sections
367	367	# sections => %descriont descriptions
368		-#
	368	+#
369	369
370	370	sub output_highlight {
371	371	my $contents = join "\n",@_;
...	...	@@ -400,7 +400,7 @@
400	400	print "<blockquote>\n";
401	401	output_highlight($args{'sections'}{$section});
402	402	print "</blockquote>\n";
403		- }
	403	+ }
404	404	}
405	405
406	406	# output enum in html
...	...	@@ -551,7 +551,7 @@
551	551
552	552	sub output_section_xml(%) {
553	553	my %args = %{$_[0]};
554		- my $section;
	554	+ my $section;
555	555	# print out each section
556	556	$lineprefix=" ";
557	557	foreach $section (@{$args{'sectionlist'}}) {
...	...	@@ -778,7 +778,7 @@
778	778	print "</refsynopsisdiv>\n";
779	779
780	780	print "<refsect1>\n";
781		- print " <title>Constants</title>\n";
	781	+ print " <title>Constants</title>\n";
782	782	print " <variablelist>\n";
783	783	foreach $parameter (@{$args{'parameterlist'}}) {
784	784	my $parameter_name = $parameter;
...	...	@@ -1157,7 +1157,7 @@
1157	1157	foreach $section (@{$args{'sectionlist'}}) {
1158	1158	print "$section:\n\n";
1159	1159	output_highlight($args{'sections'}{$section});
1160		- }
	1160	+ }
1161	1161	print "\n\n";
1162	1162	}
1163	1163
...	...	@@ -1262,8 +1262,8 @@
1262	1262	my $name = shift;
1263	1263	my $functype = shift;
1264	1264	my $func = "output_${functype}_$output_mode";
1265		- if (($function_only==0) \|\|
1266		- ( $function_only == 1 && defined($function_table{$name})) \|\|
	1265	+ if (($function_only==0) \|\|
	1266	+ ( $function_only == 1 && defined($function_table{$name})) \|\|
1267	1267	( $function_only == 2 && !defined($function_table{$name})))
1268	1268	{
1269	1269	&$func(@_);
...	...	@@ -1282,7 +1282,7 @@
1282	1282	}
1283	1283
1284	1284	##
1285		-# takes a declaration (struct, union, enum, typedef) and
	1285	+# takes a declaration (struct, union, enum, typedef) and
1286	1286	# invokes the right handler. NOT called for functions.
1287	1287	sub dump_declaration($$) {
1288	1288	no strict 'refs';
...	...	@@ -1352,7 +1352,7 @@
1352	1352	}
1353	1353
1354	1354	}
1355		-
	1355	+
1356	1356	output_declaration($declaration_name,
1357	1357	'enum',
1358	1358	{'enum' => $declaration_name,
...	...	@@ -1409,7 +1409,7 @@
1409	1409	while ($args =~ /(\([^\),]+),/) {
1410	1410	$args =~ s/(\([^\),]+),/$1#/g;
1411	1411	}
1412		-
	1412	+
1413	1413	foreach my $arg (split($splitter, $args)) {
1414	1414	# strip comments
1415	1415	$arg =~ s/\/\.\*\///;
...	...	@@ -1558,7 +1558,7 @@
1558	1558	return;
1559	1559	}
1560	1560
1561		- output_declaration($declaration_name,
	1561	+ output_declaration($declaration_name,
1562	1562	'function',
1563	1563	{'function' => $declaration_name,
1564	1564	'module' => $modulename,
1565	1565
...	...	@@ -1617,11 +1617,11 @@
1617	1617	%sections = ();
1618	1618	@sectionlist = ();
1619	1619	$prototype = "";
1620		-
	1620	+
1621	1621	$state = 0;
1622	1622	}
1623	1623
1624		-sub process_state3_function($$) {
	1624	+sub process_state3_function($$) {
1625	1625	my $x = shift;
1626	1626	my $file = shift;
1627	1627
...	...	@@ -1640,7 +1640,7 @@
1640	1640	}
1641	1641	}
1642	1642
1643		-sub process_state3_type($$) {
	1643	+sub process_state3_type($$) {
1644	1644	my $x = shift;
1645	1645	my $file = shift;
1646	1646
...	...	@@ -1780,7 +1780,7 @@
1780	1780	} elsif (/$doc_content/) {
1781	1781	# miguel-style comment kludge, look for blank lines after
1782	1782	# @parameter line to signify start of description
1783		- if ($1 eq "" &&
	1783	+ if ($1 eq "" &&
1784	1784	($section =~ m/^@/ \|\| $section eq $section_context)) {
1785	1785	dump_section($section, xml_escape($contents));
1786	1786	$section = $section_default;
...	...	@@ -1790,7 +1790,7 @@
1790	1790	}
1791	1791	} else {
1792	1792	# i dont know - bad line? ignore.
1793		- print STDERR "Warning(${file}:$.): bad line: $_";
	1793	+ print STDERR "Warning(${file}:$.): bad line: $_";
1794	1794	++$warnings;
1795	1795	}
1796	1796	} elsif ($state == 3) { # scanning for function { (end of prototype)
...	...	@@ -1845,7 +1845,7 @@
1845	1845	else
1846	1846	{
1847	1847	$contents .= $1 . "\n";
1848		- }
	1848	+ }
1849	1849	}
1850	1850	}
1851	1851	}