[PATCH v3] keys: Fix grammar and formatting in 'struct key_type' comments

Thorsten Blum posted 1 patch 3 months, 1 week ago
include/linux/key-type.h | 9 ++++++---
1 file changed, 6 insertions(+), 3 deletions(-)
[PATCH v3] keys: Fix grammar and formatting in 'struct key_type' comments
Posted by Thorsten Blum 3 months, 1 week ago
s/it/if/ and s/revokation/revocation/, capitalize "clear", and add a
period after the sentence. Fix the comment formatting.

Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
---
Changes in v3:
- Capitalize "clear", add a period, and fix comment formatting (Jarkko)
- Link to v2: https://lore.kernel.org/lkml/20251025095519.84361-1-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 | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/include/linux/key-type.h b/include/linux/key-type.h
index 5caf3ce82373..bb97bd3e5af4 100644
--- a/include/linux/key-type.h
+++ b/include/linux/key-type.h
@@ -107,11 +107,14 @@ 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).
 	 * - the key's semaphore will be write-locked by the caller
 	 */
 	void (*revoke)(struct key *key);
-- 
2.51.0
Re: [PATCH v3] keys: Fix grammar and formatting in 'struct key_type' comments
Posted by Jarkko Sakkinen 3 months ago
On Mon, Oct 27, 2025 at 11:33:00PM +0100, Thorsten Blum wrote:
> s/it/if/ and s/revokation/revocation/, capitalize "clear", and add a
> period after the sentence. Fix the comment formatting.
> 
> Signed-off-by: Thorsten Blum <thorsten.blum@linux.dev>
> ---
> Changes in v3:
> - Capitalize "clear", add a period, and fix comment formatting (Jarkko)
> - Link to v2: https://lore.kernel.org/lkml/20251025095519.84361-1-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 | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
> 
> diff --git a/include/linux/key-type.h b/include/linux/key-type.h
> index 5caf3ce82373..bb97bd3e5af4 100644
> --- a/include/linux/key-type.h
> +++ b/include/linux/key-type.h
> @@ -107,11 +107,14 @@ 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).
>  	 * - the key's semaphore will be write-locked by the caller
>  	 */
>  	void (*revoke)(struct key *key);
> -- 
> 2.51.0
> 

Reviewed-by: Jarkko Sakkinen <jarkko@kernel.org>

BR, Jarkko