Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

usb: host: ohci-at91: Demote kerneldoc headers down to basic comment blocks

Neither usb_hcd_at91_probe() nor usb_hcd_at91_remove()'s function
headers reach the standards required of a kerneldoc entry. Only
one attempt at describing an argument was made, as it is not
correct (we're removing that too to save confusion).

Fixes the following kernel build warning(s):

drivers/usb/host/ohci-at91.c:166: warning: Function parameter or member 'driver' not described in 'usb_hcd_at91_probe'
drivers/usb/host/ohci-at91.c:166: warning: Function parameter or member 'pdev' not described in 'usb_hcd_at91_probe'
drivers/usb/host/ohci-at91.c:259: warning: Function parameter or member 'hcd' not described in 'usb_hcd_at91_remove'
drivers/usb/host/ohci-at91.c:259: warning: Function parameter or member 'pdev' not described in 'usb_hcd_at91_remove'
drivers/usb/host/ohci-at91.c:259: warning: Excess function parameter 'dev' description in 'usb_hcd_at91_remove'

Cc: Alan Stern <stern@rowland.harvard.edu>
Cc: Nicolas Ferre <nicolas.ferre@microchip.com>
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>
Cc: Ludovic Desroches <ludovic.desroches@microchip.com>
Cc: Thibaut VARENE <varenet@parisc-linux.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
Link: https://lore.kernel.org/r/20200702144625.2533530-21-lee.jones@linaro.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

authored by

Lee Jones and committed by
Greg Kroah-Hartman
f73a8db0 048715c0

+2 -3
+2 -3
drivers/usb/host/ohci-at91.c
··· 153 153 /* always called with process context; sleeping is OK */ 154 154 155 155 156 - /** 156 + /* 157 157 * usb_hcd_at91_probe - initialize AT91-based HCDs 158 158 * Context: !in_interrupt() 159 159 * ··· 244 244 245 245 /* may be called with controller, bus, and devices active */ 246 246 247 - /** 247 + /* 248 248 * usb_hcd_at91_remove - shutdown processing for AT91-based HCDs 249 - * @dev: USB Host Controller being removed 250 249 * Context: !in_interrupt() 251 250 * 252 251 * Reverses the effect of usb_hcd_at91_probe(), first invoking