From: Jani Nikula <jani.nikula@intel.com>
Date: Sat, 28 May 2016 11:50:20 +0000 (+0300)
Subject: kernel-doc: improve handling of whitespace on the first line param description
X-Git-Tag: v4.14-rc1~2679^2~37^2~13
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=0a7263014b3a0e05b52ccef314e2ccf6f4550a8b;p=platform%2Fkernel%2Flinux-rpi.git

kernel-doc: improve handling of whitespace on the first line param description

Handle whitespace on the first line of param text as if it was the empty
string. There is no need to add the newline in this case. This improves
the rst output in particular, where blank lines may be problematic in
parameter lists.

Signed-off-by: Jani Nikula <jani.nikula@intel.com>
---

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 4f559de..e93e796 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -2814,11 +2814,11 @@ sub process_file($) {
 		$in_doc_sect = 1;
 		$in_purpose = 0;
 		$contents = $newcontents;
+		while ((substr($contents, 0, 1) eq " ") ||
+		       substr($contents, 0, 1) eq "\t") {
+		    $contents = substr($contents, 1);
+		}
 		if ($contents ne "") {
-		    while ((substr($contents, 0, 1) eq " ") ||
-			substr($contents, 0, 1) eq "\t") {
-			    $contents = substr($contents, 1);
-		    }
 		    $contents .= "\n";
 		}
 		$section = $newsection;