korg/linux
0
0
Fork 0
mirror of https://mirrors.bfsu.edu.cn/git/linux.git synced 2024-11-11 12:28:41 +08:00
Code Issues Packages Projects Releases Wiki Activity

kernel-doc: concatenate contents of colliding sections

Browse Source 
If there are multiple sections with the same section name, the current
implementation results in several sections by the same heading, with the
content duplicated from the last section to all. Even if there's the
error message, a more graceful approach is to combine all the
identically named sections into one, with concatenated contents.

With the supported sections already limited to select few, there are
massively fewer collisions than there used to be, but this is still
useful for e.g. when function parameters are documented in the middle of
a documentation comment, with description spread out above and
below. (This is not a recommended documentation style, but used in the
kernel nonetheless.)

We can now also demote the error to a warning.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
This commit is contained in:
Jani Nikula 2016-05-29 09:40:44 +03:00
parent f624adef3d
commit 32217761ee
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
scripts/kernel-doc
View File

@ -524,11 +524,13 @@ sub dump_section {
} else {
# print STDERR "other section '$name' = '$contents'\n";
if (defined($sections{$name}) && ($sections{$name} ne "")) {
print STDERR "${file}:$.: error: duplicate section name '$name'\n";
++$errors;
print STDERR "${file}:$.: warning: duplicate section name '$name'\n";
++$warnings;
$sections{$name} .= $contents;
} else {
$sections{$name} = $contents;
push @sectionlist, $name;
}
$sections{$name} = $contents;
push @sectionlist, $name;
}
}