summaryrefslogtreecommitdiffstats
path: root/scripts
diff options
context:
space:
mode:
authorJani Nikula <jani.nikula@intel.com>2016-05-26 21:04:42 +0200
committerJani Nikula <jani.nikula@intel.com>2016-05-30 12:39:00 +0200
commit6450c8957ee3a8f58191c2ed6c5b71c7b7d1b310 (patch)
treef8ea7e03f396d11a6aaa6d0558bc9306ef4d3096 /scripts
parentkernel-doc/rst: blank lines in output are not needed (diff)
downloadlinux-6450c8957ee3a8f58191c2ed6c5b71c7b7d1b310.tar.xz
linux-6450c8957ee3a8f58191c2ed6c5b71c7b7d1b310.zip
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')
-rwxr-xr-xscripts/kernel-doc4
1 files changed, 4 insertions, 0 deletions
diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index a89ff3ca366c..e8ea295567a3 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}:$.): ";