linux-kernel - Re: [PATCH -next] HID: magicmouse: Fix some kernel-doc comments

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.2206091114420.14340@cbobk.fhfr.pm>
Date:   Thu, 9 Jun 2022 11:15:16 +0200 (CEST)
From:   Jiri Kosina <jikos@...nel.org>
To:     Yang Li <yang.lee@...ux.alibaba.com>
cc:     benjamin.tissoires@...hat.com, linux-input@...r.kernel.org,
        linux-kernel@...r.kernel.org, Abaci Robot <abaci@...ux.alibaba.com>
Subject: Re: [PATCH -next] HID: magicmouse: Fix some kernel-doc comments

On Thu, 2 Jun 2022, Yang Li wrote:

> Remove warnings found by running scripts/kernel-doc,
> which is caused by using 'make W=1'.
> drivers/hid/hid-magicmouse.c:148: warning: Function parameter or member
> 'hdev' not described in 'magicmouse_sc'
> drivers/hid/hid-magicmouse.c:148: warning: Function parameter or member
> 'work' not described in 'magicmouse_sc'
> drivers/hid/hid-magicmouse.c:148: warning: Function parameter or member
> 'battery_timer' not described in 'magicmouse_sc'
> 
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
> ---
>  drivers/hid/hid-magicmouse.c | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/drivers/hid/hid-magicmouse.c b/drivers/hid/hid-magicmouse.c
> index 664a624a363d..a13e07397e5d 100644
> --- a/drivers/hid/hid-magicmouse.c
> +++ b/drivers/hid/hid-magicmouse.c
> @@ -120,6 +120,9 @@ MODULE_PARM_DESC(report_undeciphered, "Report undeciphered multi-touch state fie
>   * @scroll_jiffies: Time of last scroll motion.
>   * @touches: Most recent data for a touch, indexed by tracking ID.
>   * @tracking_ids: Mapping of current touch input data to @touches.
> + * @hdev: device report descriptor

This is not a correct desciption; struct hid_device is much more than 
report descriptor. Could you please fix that up and resend?

Thanks,

-- 
Jiri Kosina
SUSE Labs