diff mbox series

usb: xhci: Fix compiler warning in xhci.c

Message ID 20240709030604.1347546-1-shivani07g@gmail.com (mailing list archive)
State Not Applicable
Headers
Series usb: xhci: Fix compiler warning in xhci.c |

Commit Message

Shivani Gupta July 9, 2024, 3:06 a.m. UTC 
  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'

Signed-off-by: Shivani Gupta <shivani07g@gmail.com>
---
 drivers/usb/host/xhci.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Greg KH July 9, 2024, 5:11 a.m. UTC | #1 
On Tue, Jul 09, 2024 at 03:06:04AM +0000, Shivani Gupta wrote:
> 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?

> 
> drivers/usb/host/xhci.c:1369: warning: Function parameter or struct member
> 'desc' not described in 'xhci_get_endpoint_index'
> 
> Signed-off-by: Shivani Gupta <shivani07g@gmail.com>
> ---
>  drivers/usb/host/xhci.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/usb/host/xhci.c b/drivers/usb/host/xhci.c
> index 37eb37b0affa..67168661aa52 100644
> --- a/drivers/usb/host/xhci.c
> +++ b/drivers/usb/host/xhci.c
> @@ -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
diff mbox series

Patch

diff --git a/drivers/usb/host/xhci.c b/drivers/usb/host/xhci.c
index 37eb37b0affa..67168661aa52 100644
--- a/drivers/usb/host/xhci.c
+++ b/drivers/usb/host/xhci.c
@@ -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.