diff options
| author | Jonathan Corbet <corbet@lwn.net> | 2016-06-09 21:35:05 +0200 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-06-09 21:35:05 +0200 |
| commit | 8569de68e79e94cce6709831edd94accb6942ade (patch) | |
| tree | e6dd9a4b5a2e5356674c969183a597cf77de7edb /scripts | |
| parent | docs: self-protection: rename "leak" to "exposure" (diff) | |
| download | linux-8569de68e79e94cce6709831edd94accb6942ade.tar.xz linux-8569de68e79e94cce6709831edd94accb6942ade.zip | |
docs: kernel-doc: Add "example" and "note" to the magic section types
Lots of kerneldoc entries use "example:" or "note:" as section headers.
Until such a time as we can make them use proper markup, make them work as
intended.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'scripts')
| -rwxr-xr-x | scripts/kernel-doc | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc index 5192213c5005..27757c21551a 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -406,7 +406,8 @@ my $doc_com = '\s*\*\s*'; 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?)\s*:(.*)'; +my $doc_sect = $doc_com . + '\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*$'; |