All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Kees Cook <keescook@chromium.org>
Cc: Kees Cook <keescook@chromium.org>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	linux-hardening@vger.kernel.org
Subject: Re: [PATCH] scripts: kernel-doc: Clarify missing struct member description
Date: Fri, 15 Dec 2023 09:32:42 -0700	[thread overview]
Message-ID: <87sf43pgt1.fsf@meer.lwn.net> (raw)
In-Reply-To: <20231215001513.work.563-kees@kernel.org>

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

      reply	other threads:[~2023-12-15 16:32 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-12-15  0:15 [PATCH] scripts: kernel-doc: Clarify missing struct member description Kees Cook
2023-12-15 16:32 ` Jonathan Corbet [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87sf43pgt1.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=keescook@chromium.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hardening@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.