[PATCH] EDAC/sifive: fix non-kernel-doc comment

[PATCH] EDAC/sifive: fix non-kernel-doc comment

[Randy Dunlap]

scripts/kernel-doc complains about a comment that begins with "/**"
but is not in kernel-doc format, so correct it.

Prevents this warning:

drivers/edac/sifive_edac.c:23: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * EDAC error callback

Fixes: 91abaeaaff35 ("EDAC/sifive: Add EDAC platform driver for SiFive SoCs")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Guenter Roeck <linux@roeck-us.net>
Cc: Palmer Dabbelt <palmerdabbelt@google.com>
Cc: Yash Shah <yash.shah@sifive.com>
Cc: linux-edac@vger.kernel.org
Cc: Borislav Petkov <bp@alien8.de>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Cc: Tony Luck <tony.luck@intel.com>
---
 drivers/edac/sifive_edac.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20211130.orig/drivers/edac/sifive_edac.c
+++ linux-next-20211130/drivers/edac/sifive_edac.c
@@ -19,7 +19,7 @@ struct sifive_edac_priv {
 	struct edac_device_ctl_info *dci;
 };
 
-/**
+/*
  * EDAC error callback
  *
  * @event: non-zero if unrecoverable.

Re: [PATCH] EDAC/sifive: fix non-kernel-doc comment

[Borislav Petkov]

On Tue, Nov 30, 2021 at 07:09:13PM -0800, Randy Dunlap wrote:
> scripts/kernel-doc complains about a comment that begins with "/**"
> but is not in kernel-doc format, so correct it.
> 
> Prevents this warning:
> 
> drivers/edac/sifive_edac.c:23: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * EDAC error callback
> 
> Fixes: 91abaeaaff35 ("EDAC/sifive: Add EDAC platform driver for SiFive SoCs")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Cc: Guenter Roeck <linux@roeck-us.net>
> Cc: Palmer Dabbelt <palmerdabbelt@google.com>
> Cc: Yash Shah <yash.shah@sifive.com>
> Cc: linux-edac@vger.kernel.org
> Cc: Borislav Petkov <bp@alien8.de>
> Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
> Cc: Tony Luck <tony.luck@intel.com>
> ---

Applied, thanks.

-- 
Regards/Gruss,
    Boris.

https://people.kernel.org/tglx/notes-about-netiquette