summaryrefslogtreecommitdiff
path: root/scripts/kernel-doc
diff options
context:
space:
mode:
authorJani Nikula <jani.nikula@intel.com>2016-05-26 19:04:42 (GMT)
committerJani Nikula <jani.nikula@intel.com>2016-05-30 10:39:00 (GMT)
commit6450c8957ee3a8f58191c2ed6c5b71c7b7d1b310 (patch)
treef8ea7e03f396d11a6aaa6d0558bc9306ef4d3096 /scripts/kernel-doc
parent830066a7a317e3e8872cb2d21dd24af0815f51f9 (diff)
downloadlinux-6450c8957ee3a8f58191c2ed6c5b71c7b7d1b310.tar.xz
kernel-doc: strip leading blank lines from inline doc comments
The inline member markup allows whitespace lines before the actual documentation starts. Strip the leading blank lines. This improves the rst output. Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Diffstat (limited to 'scripts/kernel-doc')
-rwxr-xr-xscripts/kernel-doc4
1 files changed, 4 insertions, 0 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index a89ff3c..e8ea295 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -2889,6 +2889,10 @@ sub process_file($) {
} elsif (/$doc_content/) {
if ($inline_doc_state == STATE_INLINE_TEXT) {
$contents .= $1 . "\n";
+ # nuke leading blank lines
+ if ($contents =~ /^\s*$/) {
+ $contents = "";
+ }
} elsif ($inline_doc_state == STATE_INLINE_NAME) {
$inline_doc_state = STATE_INLINE_ERROR;
print STDERR "Warning(${file}:$.): ";