[02/30] usb: host: pci-quirks: Demote function header from kerneldoc to comment block

Message ID 20200702144625.2533530-3-lee.jones@linaro.org
State New
Headers show
Series
  • Fix a bunch of W=1 issues in USB
Related show

Commit Message

Lee Jones July 2, 2020, 2:45 p.m.
quirk_usb_handoff_xhci()'s function header is the only one across
the sourcefile which is denoted as a kerneldoc header.  Despite
no attempt to document its arguments.  Drop it down in status from
kerneldoc to a standard comment block to match the other headers
in the file.

Fixes the following W=1 kernel build warning:

 drivers/usb/host/pci-quirks.c:1145: warning: Function parameter or member 'pdev' not described in 'quirk_usb_handoff_xhci'

Cc: Mathias Nyman <mathias.nyman@intel.com>
Cc: Martin Mares <mj@ucw.cz>
Cc: aleksey_gorelov@phoenix.com
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/usb/host/pci-quirks.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

-- 
2.25.1

Comments

Mathias Nyman July 3, 2020, 10:22 a.m. | #1
On 2.7.2020 17.45, Lee Jones wrote:
> quirk_usb_handoff_xhci()'s function header is the only one across

> the sourcefile which is denoted as a kerneldoc header.  Despite

> no attempt to document its arguments.  Drop it down in status from

> kerneldoc to a standard comment block to match the other headers

> in the file.

> 

> Fixes the following W=1 kernel build warning:

> 

>  drivers/usb/host/pci-quirks.c:1145: warning: Function parameter or member 'pdev' not described in 'quirk_usb_handoff_xhci'

> 

> Cc: Mathias Nyman <mathias.nyman@intel.com>

> Cc: Martin Mares <mj@ucw.cz>

> Cc: aleksey_gorelov@phoenix.com

> Signed-off-by: Lee Jones <lee.jones@linaro.org>


Acked-by: Mathias Nyman <mathias.nyman@linux.intel.com>

Patch

diff --git a/drivers/usb/host/pci-quirks.c b/drivers/usb/host/pci-quirks.c
index 0b949acfa2589..b8961c0381cfd 100644
--- a/drivers/usb/host/pci-quirks.c
+++ b/drivers/usb/host/pci-quirks.c
@@ -1133,7 +1133,7 @@  void usb_disable_xhci_ports(struct pci_dev *xhci_pdev)
 }
 EXPORT_SYMBOL_GPL(usb_disable_xhci_ports);
 
-/**
+/*
  * PCI Quirks for xHCI.
  *
  * Takes care of the handoff between the Pre-OS (i.e. BIOS) and the OS.