linux-kernel - Re: [PATCH] kernel-doc: handle a void function without producing a warning

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <87le9686in.fsf@meer.lwn.net>
Date: Wed, 03 Jan 2024 14:13:36 -0700
From: Jonathan Corbet <corbet@....net>
To: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>, Jani Nikula
 <jani.nikula@...el.com>, linux-doc@...r.kernel.org
Subject: Re: [PATCH] kernel-doc: handle a void function without producing a
 warning

Randy Dunlap <rdunlap@...radead.org> writes:

> 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@...radead.org>
> Cc: Jani Nikula <jani.nikula@...el.com>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: linux-doc@...r.kernel.org
> ---
>  scripts/kernel-doc |    1 +
>  1 file changed, 1 insertion(+)
>
> diff -- a/scripts/kernel-doc b/scripts/kernel-doc
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -2126,6 +2126,7 @@ sub process_body($$) {
>      }
>  
>      if (/$doc_sect/i) { # case insensitive for supported section names
> +	$in_doc_sect = 1;
>  	$newsection = $1;

Applied, thanks.

jon