[PATCH] hwmon: (yogafan) fix non-kernel-doc comment

[PATCH] hwmon: (yogafan) fix non-kernel-doc comment

[hanzhijian]

The file description comment starts with "/**" which is reserved for
kernel-doc comments, triggering a kernel-doc checker warning.  Change
it to a plain "/*" comment since it does not document any function or
struct.

Signed-off-by: hanzhijian <hanzhijian1991@gmail.com>
---
 drivers/hwmon/yogafan.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/hwmon/yogafan.c b/drivers/hwmon/yogafan.c
index 48fa5148d..278cb089b 100644
--- a/drivers/hwmon/yogafan.c
+++ b/drivers/hwmon/yogafan.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * yoga_fan.c - Lenovo Yoga/Legion Fan Hardware Monitoring Driver
  *
  * Provides fan speed monitoring for Lenovo Yoga, Legion, and IdeaPad
-- 
2.43.0

Re: [PATCH] hwmon: (yogafan) fix non-kernel-doc comment

[hanzhijian]

Please drop this patch as well.  It is a trivial cleanup that only
silences the kernel-doc checker and does not fix a real problem.

hanzhijian

Re: [PATCH] hwmon: (yogafan) fix non-kernel-doc comment

[Guenter Roeck]

On Fri, Aug 21, 2026 at 07:57:20PM +0800, hanzhijian wrote:
> The file description comment starts with "/**" which is reserved for
> kernel-doc comments, triggering a kernel-doc checker warning.  Change
> it to a plain "/*" comment since it does not document any function or
> struct.
> 
> Signed-off-by: hanzhijian <hanzhijian1991@gmail.com>

Applied.

Thanks,
Guenter

> ---
>  drivers/hwmon/yogafan.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/hwmon/yogafan.c b/drivers/hwmon/yogafan.c
> index 48fa5148d..278cb089b 100644
> --- a/drivers/hwmon/yogafan.c
> +++ b/drivers/hwmon/yogafan.c
> @@ -1,5 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>   * yoga_fan.c - Lenovo Yoga/Legion Fan Hardware Monitoring Driver
>   *
>   * Provides fan speed monitoring for Lenovo Yoga, Legion, and IdeaPad

[PATCH v2] hwmon: (yogafan) fix non-kernel-doc comment

[hanzhijian]

The file description comment starts with "/**", which is reserved for
kernel-doc comments.  scripts/kernel-doc then warns when building the
documentation:

  Warning: drivers/hwmon/yogafan.c:2 This comment starts with '/**',
  but isn't a kernel-doc comment. Refer to
  Documentation/doc-guide/kernel-doc.rst

Change it to a plain "/*" comment since it does not document any
function or struct.

Signed-off-by: hanzhijian <hanzhijian1991@gmail.com>
---
 drivers/hwmon/yogafan.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/hwmon/yogafan.c b/drivers/hwmon/yogafan.c
index 48fa5148d..278cb089b 100644
--- a/drivers/hwmon/yogafan.c
+++ b/drivers/hwmon/yogafan.c
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * yoga_fan.c - Lenovo Yoga/Legion Fan Hardware Monitoring Driver
  *
  * Provides fan speed monitoring for Lenovo Yoga, Legion, and IdeaPad
-- 
2.43.0

Re: [PATCH v2] hwmon: (yogafan) fix non-kernel-doc comment

[Guenter Roeck]

On 8/22/26 18:38, hanzhijian wrote:
> The file description comment starts with "/**", which is reserved for
> kernel-doc comments.  scripts/kernel-doc then warns when building the
> documentation:
> 
>    Warning: drivers/hwmon/yogafan.c:2 This comment starts with '/**',
>    but isn't a kernel-doc comment. Refer to
>    Documentation/doc-guide/kernel-doc.rst
> 
> Change it to a plain "/*" comment since it does not document any
> function or struct.
> 
> Signed-off-by: hanzhijian <hanzhijian1991@gmail.com>

No change log, no change other than the commit message, that change
does not add any value, and I already applied this patch and sent
out a note that I did.

Are you playing with me ? I am inclined to drop this patch.

Guenter

> ---
>   drivers/hwmon/yogafan.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/hwmon/yogafan.c b/drivers/hwmon/yogafan.c
> index 48fa5148d..278cb089b 100644
> --- a/drivers/hwmon/yogafan.c
> +++ b/drivers/hwmon/yogafan.c
> @@ -1,5 +1,5 @@
>   // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>    * yoga_fan.c - Lenovo Yoga/Legion Fan Hardware Monitoring Driver
>    *
>    * Provides fan speed monitoring for Lenovo Yoga, Legion, and IdeaPad

Re: [PATCH v2] hwmon: (yogafan) fix non-kernel-doc comment

[hanzhijian]

My apologies, Guenter.  You are right, and I'm sorry for the noise.

I sent the "please drop" note by mistake, then over-corrected by
resending it as v2 with no code change.  That was the wrong way to
handle it.

Please drop the patch entirely.  Sorry for wasting your time.

hanzhijian