All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jarkko Sakkinen <jarkko@kernel.org>
To: Thorsten Blum <thorsten.blum@linux.dev>
Cc: David Howells <dhowells@redhat.com>,
	keyrings@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] keys: Fix typos in 'struct key_type' function pointer comments
Date: Mon, 27 Oct 2025 22:13:17 +0200	[thread overview]
Message-ID: <aP_SXZq7TuYau4Kx@kernel.org> (raw)
In-Reply-To: <20251025095519.84361-1-thorsten.blum@linux.dev>

On Sat, Oct 25, 2025 at 11:55:19AM +0200, Thorsten Blum wrote:
> s/it/if/ and s/revokation/revocation/ and adjust the formatting to be
> consistent with the other comments.
> 
> Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
> ---
> Changes in v2:
> - Adjust the trailing '*/' as suggested by Jarkko
> - Link to v1: https://lore.kernel.org/lkml/20251016123619.98728-2-thorsten.blum@linux.dev/
> ---
>  include/linux/key-type.h | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/include/linux/key-type.h b/include/linux/key-type.h
> index 5caf3ce82373..5dfda728ff69 100644
> --- a/include/linux/key-type.h
> +++ b/include/linux/key-type.h
> @@ -107,11 +107,12 @@ struct key_type {
>  	 */
>  	int (*match_preparse)(struct key_match_data *match_data);
>  
> -	/* Free preparsed match data (optional).  This should be supplied it
> -	 * ->match_preparse() is supplied. */
> +	/* Free preparsed match data (optional).  This should be supplied if
> +	 * ->match_preparse() is supplied.
> +	 */
>  	void (*match_free)(struct key_match_data *match_data);
>  
> -	/* clear some of the data from a key on revokation (optional)
> +	/* clear some of the data from a key on revocation (optional)

A sentence starts with capital.

>  	 * - the key's semaphore will be write-locked by the caller

And end with preiod. It makes no to fix surgical issue in a source
code commit if you still leave it half broken.

>  	 */
>  	void (*revoke)(struct key *key);

Please address the comment format ie. have it.

/*
 * text

> -- 
> 2.51.0
> 

BR, Jarkko

      reply	other threads:[~2025-10-27 20:13 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-25  9:55 [PATCH v2] keys: Fix typos in 'struct key_type' function pointer comments Thorsten Blum
2025-10-27 20:13 ` Jarkko Sakkinen [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=aP_SXZq7TuYau4Kx@kernel.org \
    --to=jarkko@kernel.org \
    --cc=dhowells@redhat.com \
    --cc=keyrings@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=thorsten.blum@linux.dev \
    /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.