2023-12-05 22:51:43

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] ACPI: watchdog: fix kernel-doc warnings

Fix kernel-doc warnings found when using "W=1".

acpi_watchdog.c:85: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
acpi_watchdog.c:85: warning: missing initial short description on line:
* Returns true if this system should prefer ACPI based watchdog instead of

Signed-off-by: Randy Dunlap <[email protected]>
Cc: "Rafael J. Wysocki" <[email protected]>
Cc: Len Brown <[email protected]>
Cc: [email protected]
---
drivers/acpi/acpi_watchdog.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff -- a/drivers/acpi/acpi_watchdog.c b/drivers/acpi/acpi_watchdog.c
--- a/drivers/acpi/acpi_watchdog.c
+++ b/drivers/acpi/acpi_watchdog.c
@@ -81,7 +81,7 @@ static const struct acpi_table_wdat *acp
return wdat;
}

-/**
+/*
* Returns true if this system should prefer ACPI based watchdog instead of
* the native one (which are typically the same hardware).
*/


2023-12-12 19:30:49

by Rafael J. Wysocki

[permalink] [raw]
Subject: Re: [PATCH] ACPI: watchdog: fix kernel-doc warnings

On Tue, Dec 5, 2023 at 11:50 PM Randy Dunlap <[email protected]> wrote:
>
> Fix kernel-doc warnings found when using "W=1".
>
> acpi_watchdog.c:85: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> acpi_watchdog.c:85: warning: missing initial short description on line:
> * Returns true if this system should prefer ACPI based watchdog instead of
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: "Rafael J. Wysocki" <[email protected]>
> Cc: Len Brown <[email protected]>
> Cc: [email protected]
> ---
> drivers/acpi/acpi_watchdog.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/drivers/acpi/acpi_watchdog.c b/drivers/acpi/acpi_watchdog.c
> --- a/drivers/acpi/acpi_watchdog.c
> +++ b/drivers/acpi/acpi_watchdog.c
> @@ -81,7 +81,7 @@ static const struct acpi_table_wdat *acp
> return wdat;
> }
>
> -/**
> +/*
> * Returns true if this system should prefer ACPI based watchdog instead of
> * the native one (which are typically the same hardware).
> */

Applied as 6.8 material, thanks!