linux-input.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] input/misc: max8925_onkey.c: don't mark comment as kernel-doc
@ 2021-10-02  4:59 Randy Dunlap
  2021-10-16  5:09 ` Dmitry Torokhov
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2021-10-02  4:59 UTC (permalink / raw)
  To: linux-kernel
  Cc: Randy Dunlap, kernel test robot, Aditya Srivastava,
	Dmitry Torokhov, linux-input, Haojian Zhuang

Change the comment to a normal (non-kernel-doc) comment to avoid
these kernel-doc warnings:

max8925_onkey.c:2: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * MAX8925 ONKEY driver
max8925_onkey.c:2: warning: missing initial short description on line:
 * MAX8925 ONKEY driver

Fixes: 3734574cac100 ("Input: enable onkey driver of max8925")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Aditya Srivastava <yashsri421@gmail.com>
Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: linux-input@vger.kernel.org
Cc: Haojian Zhuang <haojian.zhuang@gmail.com>
---
 drivers/input/misc/max8925_onkey.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20211001.orig/drivers/input/misc/max8925_onkey.c
+++ linux-next-20211001/drivers/input/misc/max8925_onkey.c
@@ -1,4 +1,4 @@
-/**
+/*
  * MAX8925 ONKEY driver
  *
  * Copyright (C) 2009 Marvell International Ltd.

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] input/misc: max8925_onkey.c: don't mark comment as kernel-doc
  2021-10-02  4:59 [PATCH] input/misc: max8925_onkey.c: don't mark comment as kernel-doc Randy Dunlap
@ 2021-10-16  5:09 ` Dmitry Torokhov
  0 siblings, 0 replies; 2+ messages in thread
From: Dmitry Torokhov @ 2021-10-16  5:09 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: linux-kernel, kernel test robot, Aditya Srivastava, linux-input,
	Haojian Zhuang

On Fri, Oct 01, 2021 at 09:59:43PM -0700, Randy Dunlap wrote:
> Change the comment to a normal (non-kernel-doc) comment to avoid
> these kernel-doc warnings:
> 
> max8925_onkey.c:2: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * MAX8925 ONKEY driver
> max8925_onkey.c:2: warning: missing initial short description on line:
>  * MAX8925 ONKEY driver
> 
> Fixes: 3734574cac100 ("Input: enable onkey driver of max8925")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reported-by: kernel test robot <lkp@intel.com>
> Cc: Aditya Srivastava <yashsri421@gmail.com>
> Cc: Dmitry Torokhov <dmitry.torokhov@gmail.com>
> Cc: linux-input@vger.kernel.org
> Cc: Haojian Zhuang <haojian.zhuang@gmail.com>

Applied, thank you.

-- 
Dmitry

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2021-10-16  5:09 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-10-02  4:59 [PATCH] input/misc: max8925_onkey.c: don't mark comment as kernel-doc Randy Dunlap
2021-10-16  5:09 ` Dmitry Torokhov

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).