[PATCH] ipmi: Fix some kernel-doc warnings

Bo Liu posted 1 patch 3 years, 5 months ago
drivers/char/ipmi/ipmi_msghandler.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] ipmi: Fix some kernel-doc warnings
Posted by Bo Liu 3 years, 5 months ago
The current code provokes some kernel-doc warnings:
	drivers/char/ipmi/ipmi_msghandler.c:618: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Signed-off-by: Bo Liu <liubo03@inspur.com>
---
 drivers/char/ipmi/ipmi_msghandler.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/char/ipmi/ipmi_msghandler.c b/drivers/char/ipmi/ipmi_msghandler.c
index d5ee52be176d..f6b8ca6df9b5 100644
--- a/drivers/char/ipmi/ipmi_msghandler.c
+++ b/drivers/char/ipmi/ipmi_msghandler.c
@@ -614,7 +614,7 @@ static int __ipmi_bmc_register(struct ipmi_smi *intf,
 static int __scan_channels(struct ipmi_smi *intf, struct ipmi_device_id *id);
 
 
-/**
+/*
  * The driver model view of the IPMI messaging driver.
  */
 static struct platform_driver ipmidriver = {
-- 
2.27.0
Re: [PATCH] ipmi: Fix some kernel-doc warnings
Posted by Corey Minyard 3 years, 5 months ago
On Tue, Oct 25, 2022 at 02:04:36AM -0400, Bo Liu wrote:
> The current code provokes some kernel-doc warnings:
> 	drivers/char/ipmi/ipmi_msghandler.c:618: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Thanks, this is in my for-next tree.

-corey

> 
> Signed-off-by: Bo Liu <liubo03@inspur.com>
> ---
>  drivers/char/ipmi/ipmi_msghandler.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/char/ipmi/ipmi_msghandler.c b/drivers/char/ipmi/ipmi_msghandler.c
> index d5ee52be176d..f6b8ca6df9b5 100644
> --- a/drivers/char/ipmi/ipmi_msghandler.c
> +++ b/drivers/char/ipmi/ipmi_msghandler.c
> @@ -614,7 +614,7 @@ static int __ipmi_bmc_register(struct ipmi_smi *intf,
>  static int __scan_channels(struct ipmi_smi *intf, struct ipmi_device_id *id);
>  
>  
> -/**
> +/*
>   * The driver model view of the IPMI messaging driver.
>   */
>  static struct platform_driver ipmidriver = {
> -- 
> 2.27.0
>