| Message ID | 20231205225045.32121-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | Mainlined, archived |
| Headers | show |
| Series | ACPI: watchdog: fix kernel-doc warnings | expand |
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 -- 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). */
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(-)