linux-kernel - Re: [PATCH v2] keys: Fix typos in 'struct key

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: <aP_SXZq7TuYau4Kx@kernel.org>
Date: Mon, 27 Oct 2025 22:13:17 +0200
From: Jarkko Sakkinen <jarkko@...nel.org>
To: Thorsten Blum <thorsten.blum@...ux.dev>
Cc: David Howells <dhowells@...hat.com>, keyrings@...r.kernel.org,
	linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] keys: Fix typos in 'struct key_type' function pointer
 comments

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@...ux.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