Commit 891dcd2f authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

[PATCH] kernel-doc: allow a little whitespace 



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.)

Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 3de3af13

Documentation/kernel-doc-nano-HOWTO.txt

+1 −1
Original line number Diff line number Diff line
@@ -101,7 +101,7 @@ The format of the block comment is like this: 


/**

 * 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)? )*

scripts/kernel-doc

+2 −2
Original line number Diff line number Diff line
@@ -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 whitespace at end of comment start. 
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*(.*)?';

CRA Git | Maintained and supported by SUSTech CRA and CCSE