| Message ID | ca3906a0-fbb0-1afb-d619-d8b013c1d0b1@infradead.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | usb/typec: fix kernel-doc notation warning for typec_match_altmode | expand |
On Mon, Sep 03, 2018 at 12:58:35PM -0700, Randy Dunlap wrote: > From: Randy Dunlap <rdunlap@infradead.org> > > Fix kernel-doc warning for missing function parameter 'mode' description: > > ../drivers/usb/typec/bus.c:268: warning: Function parameter or member 'mode' not described in 'typec_match_altmode' > > Also fix typos for same function documentation. > > Fixes: 8a37d87d72f0 ("usb: typec: Bus type for alternate modes") > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Heikki Krogerus <heikki.krogerus@linux.intel.com> Acked-by: Heikki Krogerus <heikki.krogerus@linux.intel.com> > --- > drivers/usb/typec/bus.c | 7 ++++--- > 1 file changed, 4 insertions(+), 3 deletions(-) > > --- lnx-419-rc2.orig/drivers/usb/typec/bus.c > +++ lnx-419-rc2/drivers/usb/typec/bus.c > @@ -255,12 +255,13 @@ EXPORT_SYMBOL_GPL(typec_altmode_unregist > /* API for the port drivers */ > > /** > - * typec_match_altmode - Match SVID to an array of alternate modes > + * typec_match_altmode - Match SVID and mode to an array of alternate modes > * @altmodes: Array of alternate modes > - * @n: Number of elements in the array, or -1 for NULL termiated arrays > + * @n: Number of elements in the array, or -1 for NULL terminated arrays > * @svid: Standard or Vendor ID to match with > + * @mode: Mode to match with > * > - * Return pointer to an alternate mode with SVID mathing @svid, or NULL when no > + * Return pointer to an alternate mode with SVID matching @svid, or NULL when no > * match is found. > */ > struct typec_altmode *typec_match_altmode(struct typec_altmode **altmodes,
--- lnx-419-rc2.orig/drivers/usb/typec/bus.c +++ lnx-419-rc2/drivers/usb/typec/bus.c @@ -255,12 +255,13 @@ EXPORT_SYMBOL_GPL(typec_altmode_unregist /* API for the port drivers */ /** - * typec_match_altmode - Match SVID to an array of alternate modes + * typec_match_altmode - Match SVID and mode to an array of alternate modes * @altmodes: Array of alternate modes - * @n: Number of elements in the array, or -1 for NULL termiated arrays + * @n: Number of elements in the array, or -1 for NULL terminated arrays * @svid: Standard or Vendor ID to match with + * @mode: Mode to match with * - * Return pointer to an alternate mode with SVID mathing @svid, or NULL when no + * Return pointer to an alternate mode with SVID matching @svid, or NULL when no * match is found. */ struct typec_altmode *typec_match_altmode(struct typec_altmode **altmodes,