Skip to contentSkip to conversation

kernel-doc: allow a little whitespace

PATCH New Randy Dunlap 1 participant 1 message Jan 6, 2007 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kernel-doc: allow a little whitespace

From: Randy Dunlap <[email protected]>

In kernel-doc syntax, be a little flexible: allow whitespace between a function parameter name and the colon that must follow it, such as:
@pdev : PCI device to unplug

(This allows lots of megaraid kernel-doc to work without tons of editing.)

---
 Documentation/kernel-doc-nano-HOWTO.txt |    2 +-
 scripts/kernel-doc                      |    4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)
scripts/kernel-doc +2 -2
@@ -83,7 +83,7 @@ use strict;
 #  * my_function
 #  **/
 #
-# If the Description: header tag is ommitted, then there must be a blank line
+# If the Description: header tag is omitted, then there must be a blank line
 # after the last parameter specification.
 # e.g.
 # /**
@@ -265,7 +265,7 @@ my $doc_start = '^/\*\*\s*$'; # Allow wh
 my $doc_end = '\*/';
 my $doc_com = '\s*\*\s*';
 my $doc_decl = $doc_com.'(\w+)';
-my $doc_sect = $doc_com.'(['.$doc_special.']?[\w ]+):(.*)';
+my $doc_sect = $doc_com.'(['.$doc_special.']?[\w\s]+):(.*)';
 my $doc_content = $doc_com.'(.*)';
 my $doc_block = $doc_com.'DOC:\s*(.*)?';
 
Documentation/kernel-doc-nano-HOWTO.txt +1 -1
@@ -101,7 +101,7 @@ The format of the block comment is like 
 
 /**
  * function_name(:)? (- short description)?
-(* @parameterx: (description of parameter x)?)*
+(* @parameterx(space)*: (description of parameter x)?)*
 (* a blank line)?
  * (Description:)? (Description of function)?
  * (section header: (section description)? )*

---