usb: cdns3: starfive: don't misuse /** comment

Message ID 20231206181317.27515-1-rdunlap@infradead.org
State New
Headers
Series usb: cdns3: starfive: don't misuse /** comment |

Commit Message

Randy Dunlap Dec. 6, 2023, 6:13 p.m. UTC
  Use a common C comment "/*" instead of "/**" to prevent a warning
from scripts/kernel-doc.

cdns3-starfive.c:23: warning: expecting prototype for cdns3(). Prototype was for USB_STRAP_HOST() instead

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Minda Chen <minda.chen@starfivetech.com>
Cc: Peter Chen <peter.chen@kernel.org>
Cc: Pawel Laszczak <pawell@cadence.com>
Cc: Roger Quadros <rogerq@kernel.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: linux-usb@vger.kernel.org
---
 drivers/usb/cdns3/cdns3-starfive.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Peter Chen Dec. 7, 2023, 3 a.m. UTC | #1
On Thu, Dec 7, 2023 at 2:13 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> Use a common C comment "/*" instead of "/**" to prevent a warning
> from scripts/kernel-doc.
>
> cdns3-starfive.c:23: warning: expecting prototype for cdns3(). Prototype was for USB_STRAP_HOST() instead
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Minda Chen <minda.chen@starfivetech.com>
> Cc: Peter Chen <peter.chen@kernel.org>
> Cc: Pawel Laszczak <pawell@cadence.com>
> Cc: Roger Quadros <rogerq@kernel.org>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: linux-usb@vger.kernel.org
> ---

Acked-by: Peter Chen <peter.chen@kernel.org>

Peter


>  drivers/usb/cdns3/cdns3-starfive.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/drivers/usb/cdns3/cdns3-starfive.c b/drivers/usb/cdns3/cdns3-starfive.c
> --- a/drivers/usb/cdns3/cdns3-starfive.c
> +++ b/drivers/usb/cdns3/cdns3-starfive.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0
> -/**
> +/*
>   * cdns3-starfive.c - StarFive specific Glue layer for Cadence USB Controller
>   *
>   * Copyright (C) 2023 StarFive Technology Co., Ltd.
  

Patch

diff -- a/drivers/usb/cdns3/cdns3-starfive.c b/drivers/usb/cdns3/cdns3-starfive.c
--- a/drivers/usb/cdns3/cdns3-starfive.c
+++ b/drivers/usb/cdns3/cdns3-starfive.c
@@ -1,5 +1,5 @@ 
 // SPDX-License-Identifier: GPL-2.0
-/**
+/*
  * cdns3-starfive.c - StarFive specific Glue layer for Cadence USB Controller
  *
  * Copyright (C) 2023 StarFive Technology Co., Ltd.