summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2016-06-09 13:35:05 -0600
committerJonathan Corbet <corbet@lwn.net>2016-06-09 13:35:05 -0600
commit8569de68e79e94cce6709831edd94accb6942ade (patch)
treee6dd9a4b5a2e5356674c969183a597cf77de7edb
parentc9de4a82c852d621975f5978157f689e0550a48e (diff)
downloadlwn-8569de68e79e94cce6709831edd94accb6942ade.tar.gz
lwn-8569de68e79e94cce6709831edd94accb6942ade.zip
docs: kernel-doc: Add "example" and "note" to the magic section typessphinx-4.8
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>
-rwxr-xr-xscripts/kernel-doc3
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*$';