diff options
| author | Randy Dunlap <randy.dunlap@oracle.com> | 2007-02-10 04:45:53 -0500 |
|---|---|---|
| committer | Linus Torvalds <torvalds@woody.linux-foundation.org> | 2007-02-11 13:51:32 -0500 |
| commit | 891dcd2f7ab15e2aaad07f6925b3a53fd8d5c02f (patch) | |
| tree | 643fea439770f91b3b0246bd304c6883761b591c /scripts/kernel-doc | |
| parent | 3de3af130b75a79c7381573e5ea69cb59502023f (diff) | |
[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: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'scripts/kernel-doc')
| -rwxr-xr-x | scripts/kernel-doc | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 8a4ec43a4985..35d7fd9a1e65 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc | |||
| @@ -83,7 +83,7 @@ use strict; | |||
| 83 | # * my_function | 83 | # * my_function |
| 84 | # **/ | 84 | # **/ |
| 85 | # | 85 | # |
| 86 | # If the Description: header tag is ommitted, then there must be a blank line | 86 | # If the Description: header tag is omitted, then there must be a blank line |
| 87 | # after the last parameter specification. | 87 | # after the last parameter specification. |
| 88 | # e.g. | 88 | # e.g. |
| 89 | # /** | 89 | # /** |
| @@ -265,7 +265,7 @@ my $doc_start = '^/\*\*\s*$'; # Allow whitespace at end of comment start. | |||
| 265 | my $doc_end = '\*/'; | 265 | my $doc_end = '\*/'; |
| 266 | my $doc_com = '\s*\*\s*'; | 266 | my $doc_com = '\s*\*\s*'; |
| 267 | my $doc_decl = $doc_com.'(\w+)'; | 267 | my $doc_decl = $doc_com.'(\w+)'; |
| 268 | my $doc_sect = $doc_com.'(['.$doc_special.']?[\w ]+):(.*)'; | 268 | my $doc_sect = $doc_com.'(['.$doc_special.']?[\w\s]+):(.*)'; |
| 269 | my $doc_content = $doc_com.'(.*)'; | 269 | my $doc_content = $doc_com.'(.*)'; |
| 270 | my $doc_block = $doc_com.'DOC:\s*(.*)?'; | 270 | my $doc_block = $doc_com.'DOC:\s*(.*)?'; |
| 271 | 271 | ||
