Searched hist:"32217761 ee9db0215350dfe1ca4e66f312fb8c54" (Results 1 – 1 of 1) sorted by relevance
| /linux/scripts/ |
| H A D | kernel-doc | diff 95b6be9d198d964fafd9cbf1dd4d1968291e255c Fri Jun 10 10:14:05 CEST 2016 Jani Nikula <jani.nikula@intel.com> kernel-doc: do not warn about duplicate default section names
Since
commit 32217761ee9db0215350dfe1ca4e66f312fb8c54
Author: Jani Nikula <jani.nikula@intel.com>
Date: Sun May 29 09:40:44 2016 +0300
kernel-doc: concatenate contents of colliding sections
we started getting (more) errors on duplicate section names, especially
on the default section name "Description":
include/net/mac80211.h:3174: warning: duplicate section name 'Description'
This is usually caused by a slightly unorthodox placement of parameter
descriptions, like in the above case, and kernel-doc resetting back to
the default section more than once within a kernel-doc comment.
Ignore warnings on the duplicate section name automatically assigned by
kernel-doc, and only consider explicitly user assigned duplicate section
names an issue.
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
diff 32217761ee9db0215350dfe1ca4e66f312fb8c54 Sun May 29 08:40:44 CEST 2016 Jani Nikula <jani.nikula@intel.com> kernel-doc: concatenate contents of colliding sections
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>
|