Re: [PATCH] usb: typec: Fix num_altmodes kernel-doc error

[Heikki Krogerus]

On Thu, Nov 19, 2020 at 10:35:22PM -0800, Prashant Malani wrote:
> The commit to introduce the num_altmodes attribute for partner had an
> error where one of the parameters was named differently in the comment
> and the function signature. Fix the version in the comment to align with
> what is in the function signature.
> 
> This fixes the following htmldocs warning:
> 
> drivers/usb/typec/class.c:632: warning: Excess function parameter
> 'num_alt_modes' description in 'typec_partner_set_num_altmodes'
> 
> Fixes: a0ccdc4a77a1 ("usb: typec: Add number of altmodes partner attr")
> Signed-off-by: Prashant Malani <pmalani@xxxxxxxxxxxx>

Reviewed-by: Heikki Krogerus <heikki.krogerus@xxxxxxxxxxxxxxx>

> ---
>  drivers/usb/typec/class.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/usb/typec/class.c b/drivers/usb/typec/class.c
> index e68798599ca8..cb1362187a7c 100644
> --- a/drivers/usb/typec/class.c
> +++ b/drivers/usb/typec/class.c
> @@ -618,7 +618,7 @@ EXPORT_SYMBOL_GPL(typec_partner_set_identity);
>  /**
>   * typec_partner_set_num_altmodes - Set the number of available partner altmodes
>   * @partner: The partner to be updated.
> - * @num_alt_modes: The number of altmodes we want to specify as available.
> + * @num_altmodes: The number of altmodes we want to specify as available.
>   *
>   * This routine is used to report the number of alternate modes supported by the
>   * partner. This value is *not* enforced in alternate mode registration routines.
> -- 
> 2.29.2.454.gaff20da3a2-goog

thanks,

-- 
heikki