linux-kernel - Re: [PATCH v4] HID: uclogic: properly format kernel-doc comment for hid

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <nycvar.YFH.7.76.2206081157590.10851@cbobk.fhfr.pm>
Date:   Wed, 8 Jun 2022 11:58:09 +0200 (CEST)
From:   Jiri Kosina <jikos@...nel.org>
To:     Bagas Sanjaya <bagasdotme@...il.com>
cc:     linux-doc@...r.kernel.org, Greg KH <gregkh@...uxfoundation.org>,
        kernel test robot <lkp@...el.com>,
        Randy Dunlap <rdunlap@...radead.org>,
        José Expósito <jose.exposito89@...il.com>,
        Nikolai Kondrashov <spbnick@...il.com>,
        Benjamin Tissoires <benjamin.tissoires@...hat.com>,
        llvm@...ts.linux.dev, linux-input@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v4] HID: uclogic: properly format kernel-doc comment for
 hid_dbg() wrappers

On Sat, 4 Jun 2022, 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@...el.com>
> Tested-by: Randy Dunlap <rdunlap@...radead.org>
> Tested-by: José Expósito <jose.exposito89@...il.com>
> Acked-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Nikolai Kondrashov <spbnick@...il.com>
> Cc: Jiri Kosina <jikos@...nel.org>
> Cc: Benjamin Tissoires <benjamin.tissoires@...hat.com>
> Cc: llvm@...ts.linux.dev
> Cc: linux-input@...r.kernel.org
> Cc: linux-kernel@...r.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>

Applied, thanks.

-- 
Jiri Kosina
SUSE Labs