From: Randy Dunlap <rdunlap@infradead.org>
Date: Tue, 26 Dec 2023 06:52:19 +0000 (-0800)
Subject: kernel-doc: handle a void function without producing a warning
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=afa751e84c30b517aebd418970d222c39c81acb8;p=linux.git

kernel-doc: handle a void function without producing a warning

Currently a void function can produce a warning:
  main.c:469: warning: contents before sections

This one is from arch/x86/kernel/cpu/sgx/main.c (which is not included
in any produced kernel documentation output).

Handle this by setting $in_doc_sect to 1 whenever any recognized
document section name is processed.

Fixes: f624adef3d0b ("kernel-doc: limit the "section header:" detection to a select few")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jani Nikula <jani.nikula@intel.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20231226065219.319-1-rdunlap@infradead.org
---

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 3cdc7dba37e3a..3ecdab5ca6128 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -2121,6 +2121,7 @@ sub process_body($$) {
     }
 
     if (/$doc_sect/i) { # case insensitive for supported section names
+	$in_doc_sect = 1;
 	$newsection = $1;
 	$newcontents = $2;