linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] usb: typec: Fix num_altmodes kernel-doc error
@ 2020-11-20  6:35 Prashant Malani
  2020-11-20  7:33 ` Heikki Krogerus
  2020-11-20  8:41 ` Greg KH
  0 siblings, 2 replies; 4+ messages in thread
From: Prashant Malani @ 2020-11-20  6:35 UTC (permalink / raw)
  To: linux-usb, gregkh, heikki.krogerus
  Cc: linux-kernel, sfr, linux-next, Prashant Malani

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@chromium.org>
---
 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


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] usb: typec: Fix num_altmodes kernel-doc error
  2020-11-20  6:35 [PATCH] usb: typec: Fix num_altmodes kernel-doc error Prashant Malani
@ 2020-11-20  7:33 ` Heikki Krogerus
  2020-11-20  8:41 ` Greg KH
  1 sibling, 0 replies; 4+ messages in thread
From: Heikki Krogerus @ 2020-11-20  7:33 UTC (permalink / raw)
  To: Prashant Malani; +Cc: linux-usb, gregkh, linux-kernel, sfr, linux-next

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@chromium.org>

Reviewed-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>

> ---
>  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

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] usb: typec: Fix num_altmodes kernel-doc error
  2020-11-20  6:35 [PATCH] usb: typec: Fix num_altmodes kernel-doc error Prashant Malani
  2020-11-20  7:33 ` Heikki Krogerus
@ 2020-11-20  8:41 ` Greg KH
  2020-11-20  8:43   ` Prashant Malani
  1 sibling, 1 reply; 4+ messages in thread
From: Greg KH @ 2020-11-20  8:41 UTC (permalink / raw)
  To: Prashant Malani; +Cc: linux-usb, heikki.krogerus, linux-kernel, sfr, linux-next

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@chromium.org>

You forgot a "Reported-by:" tag here :(

I'll go add it by hand...

greg k-h

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH] usb: typec: Fix num_altmodes kernel-doc error
  2020-11-20  8:41 ` Greg KH
@ 2020-11-20  8:43   ` Prashant Malani
  0 siblings, 0 replies; 4+ messages in thread
From: Prashant Malani @ 2020-11-20  8:43 UTC (permalink / raw)
  To: Greg KH; +Cc: linux-usb, heikki.krogerus, linux-kernel, sfr, linux-next

On Fri, Nov 20, 2020 at 09:41:21AM +0100, Greg KH wrote:
> 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@chromium.org>
> 
> You forgot a "Reported-by:" tag here :(
> 
> I'll go add it by hand...

My bad :(, thank you for making the addition.

Best regards,

-Prashant

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2020-11-20  8:43 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-11-20  6:35 [PATCH] usb: typec: Fix num_altmodes kernel-doc error Prashant Malani
2020-11-20  7:33 ` Heikki Krogerus
2020-11-20  8:41 ` Greg KH
2020-11-20  8:43   ` Prashant Malani

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).