Re: [PATCH] usb: xhci: Fix compiler warning in xhci.c

From: Greg KH
Date: Tue Jul 09 2024 - 01:12:02 EST


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@xxxxxxxxx>
> ---
> 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