Re: [RESEND PATCH] KEYS: asymmetric: Fix kerneldoc

Jarkko Sakkinen
2020-10-30T08:08:24Z

On Thu, Oct 29, 2020 at 04:48:30PM +0100, Krzysztof Kozlowski wrote:
> Fix W=1 compile warnings (invalid kerneldoc):
>
> crypto/asymmetric_keys/asymmetric_type.c:160: warning: Function parameter or member 'kid1' not described in 'asymmetric_key_id_same'
> crypto/asymmetric_keys/asymmetric_type.c:160: warning: Function parameter or member 'kid2' not described in 'asymmetric_key_id_same'
> crypto/asymmetric_keys/asymmetric_type.c:160: warning: Excess function parameter 'kid_1' description in 'asymmetric_key_id_same'
> crypto/asymmetric_keys/asymmetric_type.c:160: warning: Excess function parameter 'kid_2' description in 'asymmetric_key_id_same'
>
> Signed-off-by: Krzysztof Kozlowski <krzk@kernel.org>
> Acked-by: Randy Dunlap <rdunlap@infradead.org>
> ---

Reviewed-by: Jarkko Sakkinen <jarkko.sakkinen@iki.fi>

> crypto/asymmetric_keys/asymmetric_type.c | 6 ++++--
> 1 file changed, 4 insertions(+), 2 deletions(-)
>
> diff --git a/crypto/asymmetric_keys/asymmetric_type.c b/crypto/asymmetric_keys/asymmetric_type.c
> index 33e77d846caa..ad8af3d70ac0 100644
> --- a/crypto/asymmetric_keys/asymmetric_type.c
> +++ b/crypto/asymmetric_keys/asymmetric_type.c
> @@ -152,7 +152,8 @@ EXPORT_SYMBOL_GPL(asymmetric_key_generate_id);
>
> /**
> * asymmetric_key_id_same - Return true if two asymmetric keys IDs are the same.
> - * @kid_1, @kid_2: The key IDs to compare
> + * @kid1: The key ID to compare
> + * @kid2: The key ID to compare
> */
> bool asymmetric_key_id_same(const struct asymmetric_key_id *kid1,
> const struct asymmetric_key_id *kid2)
> @@ -168,7 +169,8 @@ EXPORT_SYMBOL_GPL(asymmetric_key_id_same);
> /**
> * asymmetric_key_id_partial - Return true if two asymmetric keys IDs
> * partially match
> - * @kid_1, @kid_2: The key IDs to compare
> + * @kid1: The key ID to compare
> + * @kid2: The key ID to compare
> */
> bool asymmetric_key_id_partial(const struct asymmetric_key_id *kid1,
> const struct asymmetric_key_id *kid2)
> --
> 2.25.1
>
>

/Jarkko