2023-12-06 18:13:29

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] usb: cdns3: starfive: don't misuse /** comment

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 <[email protected]>
Cc: Minda Chen <[email protected]>
Cc: Peter Chen <[email protected]>
Cc: Pawel Laszczak <[email protected]>
Cc: Roger Quadros <[email protected]>
Cc: Greg Kroah-Hartman <[email protected]>
Cc: [email protected]
---
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.


2023-12-07 03:01:09

by Peter Chen

[permalink] [raw]
Subject: Re: [PATCH] usb: cdns3: starfive: don't misuse /** comment

On Thu, Dec 7, 2023 at 2:13 AM Randy Dunlap <[email protected]> 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 <[email protected]>
> Cc: Minda Chen <[email protected]>
> Cc: Peter Chen <[email protected]>
> Cc: Pawel Laszczak <[email protected]>
> Cc: Roger Quadros <[email protected]>
> Cc: Greg Kroah-Hartman <[email protected]>
> Cc: [email protected]
> ---

Acked-by: Peter Chen <[email protected]>

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.