[prev in list] [next in list] [prev in thread] [next in thread] 

List:       linux-input
Subject:    Re: [PATCH v2] HID: uclogic: properly format kernel-doc comment for hid_dbg() wrappers
From:       Randy Dunlap <rdunlap () infradead ! org>
Date:       2022-05-31 15:52:28
Message-ID: 3995c3d8-395a-bd39-eebc-370bd1fca09c () infradead ! org
[Download RAW message or body]



On 5/31/22 02:28, Bagas Sanjaya wrote:
> Running kernel-doc script on drivers/hid/hid-uclogic-params.c, it found
> 6 warnings for hid_dbg() wrapper functions below:
> 
> drivers/hid/hid-uclogic-params.c:48: warning: This comment starts with '/**', but \
>                 isn't a kernel-doc comment. Refer \
>                 Documentation/doc-guide/kernel-doc.rst
> * Dump tablet interface pen parameters with hid_dbg(), indented with one tab.
> drivers/hid/hid-uclogic-params.c:48: warning: missing initial short description on \
>                 line:
> * Dump tablet interface pen parameters with hid_dbg(), indented with one tab.
> drivers/hid/hid-uclogic-params.c:48: info: Scanning doc for function Dump
> drivers/hid/hid-uclogic-params.c:80: warning: This comment starts with '/**', but \
>                 isn't a kernel-doc comment. Refer \
>                 Documentation/doc-guide/kernel-doc.rst
> * Dump tablet interface frame parameters with hid_dbg(), indented with two
> drivers/hid/hid-uclogic-params.c:80: warning: missing initial short description on \
>                 line:
> * Dump tablet interface frame parameters with hid_dbg(), indented with two
> drivers/hid/hid-uclogic-params.c:80: info: Scanning doc for function Dump
> drivers/hid/hid-uclogic-params.c:105: warning: This comment starts with '/**', but \
>                 isn't a kernel-doc comment. Refer \
>                 Documentation/doc-guide/kernel-doc.rst
> * Dump tablet interface parameters with hid_dbg().
> drivers/hid/hid-uclogic-params.c:105: warning: missing initial short description on \
>                 line:
> * Dump tablet interface parameters with hid_dbg().
> 
> One of them is reported by kernel test robot.
> 
> Fix these warnings by properly format kernel-doc comment for these
> functions.
> 
> Link: https://lore.kernel.org/linux-doc/202205272033.XFYlYj8k-lkp@intel.com/
> Fixes: a228809fa6f39c ("HID: uclogic: Move param printing to a function")
> Reported-by: kernel test robot <lkp@intel.com>
> Cc: Nikolai Kondrashov <spbnick@gmail.com>
> Cc: Jiri Kosina <jikos@kernel.org>
> Cc: Benjamin Tissoires <benjamin.tissoires@redhat.com>
> Cc: "José Expósito" <jose.exposito89@gmail.com>
> Cc: llvm@lists.linux.dev
> Cc: stable@vger.kernel.org # v5.18
> Cc: linux-input@vger.kernel.org
> Cc: linux-kernel@vger.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
> Changes since v1 [1]:
> - Approach the warning by fixing kernel-doc comments formatting
> (suggested by Jonathan Corbet)
> 
> [1]: https://lore.kernel.org/linux-doc/20220528091403.160169-1-bagasdotme@gmail.com/
> 

Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>

One note (nit) below:

> drivers/hid/hid-uclogic-params.c | 24 ++++++++++++++----------
> 1 file changed, 14 insertions(+), 10 deletions(-)
> 
> diff --git a/drivers/hid/hid-uclogic-params.c b/drivers/hid/hid-uclogic-params.c
> index db838f16282d64..647bbd3e000e2f 100644
> --- a/drivers/hid/hid-uclogic-params.c
> +++ b/drivers/hid/hid-uclogic-params.c
> @@ -23,11 +23,11 @@
> /**
> * uclogic_params_pen_inrange_to_str() - Convert a pen in-range reporting type
> *                                       to a string.
> - *
> * @inrange:	The in-range reporting type to convert.
> *
> - * Returns:
> - *	The string representing the type, or NULL if the type is unknown.
> + * Return:
> + * * The string representing the type, or
> + * * NULL if the type is unknown.

        %NULL
would be better here, but not required.

> */
> static const char *uclogic_params_pen_inrange_to_str(
> 				enum uclogic_params_pen_inrange inrange)


Thanks.
-- 
~Randy


[prev in list] [next in list] [prev in thread] [next in thread]