diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2021-03-25 19:14:25 +0100 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2021-03-25 12:50:27 -0600 |
| commit | 8d295fbad687a61eaa0cf14958c284a3ddbf2173 (patch) | |
| tree | c4b1ef2bad7e5ab3beb3f78d3c6b102f2ec9c7a9 /scripts/kernel-doc | |
| parent | 4b9d49d1ec8dcf9851a132e510c1fd176a6561d1 (diff) | |
| download | linux-8d295fbad687a61eaa0cf14958c284a3ddbf2173.tar.gz linux-8d295fbad687a61eaa0cf14958c284a3ddbf2173.tar.bz2 linux-8d295fbad687a61eaa0cf14958c284a3ddbf2173.zip | |
kernel-doc: better handle '::' sequences
Right now, if one of the following headers end with a '::', the
kernel-doc script will do the wrong thing:
description|context|returns?|notes?|examples?
The real issue is with examples, as people could try to write
something like:
example::
/* Some C code */
and this won't be properly evaluated. So, improve the regex
to not catch '\w+::' regex for the above identifiers.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/2cf44cf1fa42588632735d4fbc8e84304bdc235f.1616696051.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts/kernel-doc')
| -rwxr-xr-x | scripts/kernel-doc | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index cb92d0e1e932..0ecd71477a16 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -392,7 +392,7 @@ my $doc_com_body = '\s*\* ?'; my $doc_decl = $doc_com . '(\w+)'; # @params and a strictly limited set of supported section names my $doc_sect = $doc_com . - '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:(.*)'; + '\s*(\@[.\w]+|\@\.\.\.|description|context|returns?|notes?|examples?)\s*:([^:]*)$'; my $doc_content = $doc_com_body . '(.*)'; my $doc_block = $doc_com . 'DOC:\s*(.*)?'; my $doc_inline_start = '^\s*/\*\*\s*$'; |