2020-07-02 14:48:13

by Lee Jones

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

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 <[email protected]>
Cc: Martin Mares <[email protected]>
Cc: [email protected]
Signed-off-by: Lee Jones <[email protected]>
---
drivers/usb/host/pci-quirks.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

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

2020-07-03 10:22:22

by Mathias Nyman

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

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 <[email protected]>
> Cc: Martin Mares <[email protected]>
> Cc: [email protected]
> Signed-off-by: Lee Jones <[email protected]>

Acked-by: Mathias Nyman <[email protected]>