2023-12-05 23:12:23

by Randy Dunlap

Subject: [PATCH] extcon: qcom-spmi-misc: don't use kernel-doc marker for comment

Do not use "/**" for non-kernel-doc comments. This prevents a warning
from scripts/kernel-doc:

warning: expecting prototype for extcon(). Prototype was for USB_ID_DEBOUNCE_MS() instead

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Andy Gross <[email protected]>
Cc: Bjorn Andersson <[email protected]>
Cc: Konrad Dybcio <[email protected]>
Cc: MyungJoo Ham <[email protected]>
Cc: Chanwoo Choi <[email protected]>
---
drivers/extcon/extcon-qcom-spmi-misc.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff -- a/drivers/extcon/extcon-qcom-spmi-misc.c b/drivers/extcon/extcon-qcom-spmi-misc.c
--- a/drivers/extcon/extcon-qcom-spmi-misc.c
+++ b/drivers/extcon/extcon-qcom-spmi-misc.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
* extcon-qcom-spmi-misc.c - Qualcomm USB extcon driver to support USB ID
* and VBUS detection based on extcon-usb-gpio.c.
*

2023-12-12 00:34:57

by Chanwoo Choi

Subject: RE: [PATCH] extcon: qcom-spmi-misc: don't use kernel-doc marker for comment

> -----Original Message-----
> From: Randy Dunlap <[email protected]>
> Sent: Wednesday, December 6, 2023 8:12 AM
> To: [email protected]
> Cc: Randy Dunlap <[email protected]>; Andy Gross <[email protected]>;
> Bjorn Andersson <[email protected]>; Konrad Dybcio
> <[email protected]>; MyungJoo Ham <[email protected]>;
Chanwoo
> Choi <[email protected]>
> Subject: [PATCH] extcon: qcom-spmi-misc: don't use kernel-doc marker for
> comment
>
> Do not use "/**" for non-kernel-doc comments. This prevents a warning from
> scripts/kernel-doc:
>
> warning: expecting prototype for extcon(). Prototype was for
> USB_ID_DEBOUNCE_MS() instead
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Andy Gross <[email protected]>
> Cc: Bjorn Andersson <[email protected]>
> Cc: Konrad Dybcio <[email protected]>
> Cc: MyungJoo Ham <[email protected]>
> Cc: Chanwoo Choi <[email protected]>
> ---
> drivers/extcon/extcon-qcom-spmi-misc.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/drivers/extcon/extcon-qcom-spmi-misc.c b/drivers/extcon/extcon-
> qcom-spmi-misc.c
> --- a/drivers/extcon/extcon-qcom-spmi-misc.c
> +++ b/drivers/extcon/extcon-qcom-spmi-misc.c
> @@ -1,5 +1,5 @@
> // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
> * extcon-qcom-spmi-misc.c - Qualcomm USB extcon driver to support USB ID
> * and VBUS detection based on extcon-usb-gpio.c.
> *

Applied it. Thanks.

Best Regards,
Chanwoo Choi