Re: [usb:usb-testing 41/58] htmldocs: drivers/usb/core/usb.c:178: warning: No description found for parameter 'alt'

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, Mar 23, 2017 at 06:06:45PM +0100, Johan Hovold wrote:
> On Thu, Mar 23, 2017 at 10:57:05PM +0800, kbuild test robot wrote:
> > tree:   https://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usb.git usb-testing
> > head:   5370860a1f0e6b4197982dc1d323f988f7b1b11d
> > commit: 279daf4e053470f22c9421a4ab05f8e5a9e9eeec [41/58] USB: core: add helpers to retrieve endpoints in reverse order
> > reproduce: make htmldocs
> > 
> > All warnings (new ones prefixed by >>):
> > 
> > >> drivers/usb/core/usb.c:178: warning: No description found for parameter 'alt'
> > >> drivers/usb/core/usb.c:178: warning: No description found for parameter 'bulk_in'
> > >> drivers/usb/core/usb.c:178: warning: No description found for parameter 'bulk_out'
> > >> drivers/usb/core/usb.c:178: warning: No description found for parameter 'int_in'
> > >> drivers/usb/core/usb.c:178: warning: No description found for parameter 'int_out'
> 
> > vim +/alt +178 drivers/usb/core/usb.c
> > 
> >    162		return -ENXIO;
> >    163	}
> >    164	EXPORT_SYMBOL_GPL(usb_find_common_endpoints);
> >    165	
> >    166	/**
> >    167	 * usb_find_common_endpoints_reverse() -- look up common endpoint descriptors
> >    168	 *
> >    169	 * Same as usb_find_common_endpoints(), but the endpoint descriptors are
> >    170	 * searched in reverse order (see usb_find_common_endpoints() for details).
> >    171	 */
> >    172	int usb_find_common_endpoints_reverse(struct usb_host_interface *alt,
> >    173			struct usb_endpoint_descriptor **bulk_in,
> >    174			struct usb_endpoint_descriptor **bulk_out,
> >    175			struct usb_endpoint_descriptor **int_in,
> >    176			struct usb_endpoint_descriptor **int_out)
> >    177	{
> 
> Greg, do prefer I remove the kerneldoc formatting, add the missing
> descriptions, or leave things as they are here?

Fix up the kernel doc to be the correct format would be best, that way
it shows up correctly in the kernel documentation output.

thanks,

greg k-h
--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Linux Media]     [Linux Input]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]     [Old Linux USB Devel Archive]

  Powered by Linux