diff mbox series

ACPI: watchdog: fix kernel-doc warnings

Message ID 20231205225045.32121-1-rdunlap@infradead.org
State New
Headers
Series ACPI: watchdog: fix kernel-doc warnings |

Commit Message

Randy Dunlap Dec. 5, 2023, 10:50 p.m. UTC 
  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 <rdunlap@infradead.org>
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Len Brown <lenb@kernel.org>
Cc: linux-acpi@vger.kernel.org
---
 drivers/acpi/acpi_watchdog.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Rafael J. Wysocki Dec. 12, 2023, 7:29 p.m. UTC | #1 
On Tue, Dec 5, 2023 at 11:50 PM Randy Dunlap <rdunlap@infradead.org> 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 <rdunlap@infradead.org>
> Cc: "Rafael J. Wysocki" <rafael@kernel.org>
> Cc: Len Brown <lenb@kernel.org>
> Cc: linux-acpi@vger.kernel.org
> ---
>  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!
diff mbox series

Patch

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).
  */