Skip to contentSkip to conversation

usb: xhci: Fix compiler warning in xhci.c

PATCH In review Shivani Gupta 2 participants 2 messages Jul 9, 2024

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 usb: xhci: Fix compiler warning in xhci.c

Fixes the following compiler warnings by changing the comment syntax from "/**" to "/*" in the specified comments:

drivers/usb/host/xhci.c:1369: warning: Function parameter or struct member 'desc' not described in 'xhci_get_endpoint_index'

---
 drivers/usb/host/xhci.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/usb/host/xhci.c +1 -1
index 37eb37b0affa..67168661aa52 100644
@@ -1355,7 +1355,7 @@ static void xhci_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
 		usb_hcd_unmap_urb_for_dma(hcd, urb);
 }
 
-/**
+/*
  * xhci_get_endpoint_index - Used for passing endpoint bitmasks between the core and
  * HCDs.  Find the index for an endpoint given its descriptor.  Use the return
  * value to right shift 1 for the bitmask.
Signature · 1 line
2.34.1
maintainer
#1 lore raw
Quoted 2 lines · Shivani Gupta

Fixes the following compiler warnings by changing the comment syntax from "/**" to "/*" in the specified comments:

That's not a normal compiler warning, but rather a documentation builder warning, right?

Quoted 14 lines

drivers/usb/host/xhci.c:1369: warning: Function parameter or struct member 'desc' not described in 'xhci_get_endpoint_index'

---
 drivers/usb/host/xhci.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/usb/host/xhci.c +0 -0
index 37eb37b0affa..67168661aa52 100644

drivers/usb/host/xhci.c static void xhci_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb) · line 1358

Quoted 5 lines
drivers/usb/host/xhci.c +1 -1
@@ -1355,7 +1355,7 @@ static void xhci_unmap_urb_for_dma(struct usb_hcd *hcd, struct urb *urb)
 		usb_hcd_unmap_urb_for_dma(hcd, urb);
 }
 
-/**
+/*

This feels wrong, why not fix up the kerneldoc instead?

thanks,

greg k-h