* [PATCH] scripts: kernel-doc: Clarify missing struct member description
@ 2023-12-15 0:15 Kees Cook
2023-12-15 16:32 ` Jonathan Corbet
0 siblings, 1 reply; 2+ messages in thread
From: Kees Cook @ 2023-12-15 0:15 UTC (permalink / raw)
To: Jonathan Corbet; +Cc: Kees Cook, linux-doc, linux-kernel, linux-hardening
The output "or member" should be more specific, instead saying "struct
member".
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Signed-off-by: Kees Cook <keescook@chromium.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");
}
}
--
2.34.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] scripts: kernel-doc: Clarify missing struct member description
2023-12-15 0:15 [PATCH] scripts: kernel-doc: Clarify missing struct member description Kees Cook
@ 2023-12-15 16:32 ` Jonathan Corbet
0 siblings, 0 replies; 2+ messages in thread
From: Jonathan Corbet @ 2023-12-15 16:32 UTC (permalink / raw)
To: Kees Cook; +Cc: Kees Cook, linux-doc, linux-kernel, linux-hardening
Kees Cook <keescook@chromium.org> writes:
> The output "or member" should be more specific, instead saying "struct
> member".
>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Signed-off-by: Kees Cook <keescook@chromium.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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2023-12-15 16:32 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2023-12-15 0:15 [PATCH] scripts: kernel-doc: Clarify missing struct member description Kees Cook
2023-12-15 16:32 ` Jonathan Corbet
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).