2023-12-15 00:15:29

by Kees Cook

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

The output "or member" should be more specific, instead saying "struct
member".

Cc: Jonathan Corbet <[email protected]>
Cc: [email protected]
Signed-off-by: Kees Cook <[email protected]>
---
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");
}
}

--
2.34.1

2023-12-15 16:33:15

by Jonathan Corbet

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

Kees Cook <[email protected]> writes:

> The output "or member" should be more specific, instead saying "struct
> member".
>
> Cc: Jonathan Corbet <[email protected]>
> Cc: [email protected]
> Signed-off-by: Kees Cook <[email protected]>
> ---
> 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