linux-kernel - Re: [PATCH] scripts: kernel-doc: Clarify missing struct member description

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: <87sf43pgt1.fsf@meer.lwn.net>
Date: Fri, 15 Dec 2023 09:32:42 -0700
From: Jonathan Corbet <corbet@....net>
To: Kees Cook <keescook@...omium.org>
Cc: Kees Cook <keescook@...omium.org>, linux-doc@...r.kernel.org,
 linux-kernel@...r.kernel.org, linux-hardening@...r.kernel.org
Subject: Re: [PATCH] scripts: kernel-doc: Clarify missing struct member
 description

Kees Cook <keescook@...omium.org> writes:

> The output "or member" should be more specific, instead saying "struct
> member".
>
> Cc: Jonathan Corbet <corbet@....net>
> Cc: linux-doc@...r.kernel.org
> Signed-off-by: Kees Cook <keescook@...omium.org>
> ---
>  scripts/kernel-doc | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/scripts/kernel-doc b/scripts/kernel-doc
> index 39e730ee1fef..41f838042364 100755
> --- a/scripts/kernel-doc
> +++ b/scripts/kernel-doc
> @@ -1613,7 +1613,7 @@ sub push_parameter($$$$$) {
>  		$parameterdescs{$param} = $undescribed;
>  
>  	        if (show_warnings($type, $declaration_name) && $param !~ /\./) {
> -			emit_warning("${file}:$.", "Function parameter or member '$param' not described in '$declaration_name'\n");
> +			emit_warning("${file}:$.", "Function parameter or struct member '$param' not described in '$declaration_name'\n");
>  		}

Applied, thanks.

jon