linux-kernel - Re: [PATCH -next] HID: intel-ish-hid: ishtp-fw-loader: Fix a kernel-doc formatting issue

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]

Date:   Thu, 6 Jan 2022 14:20:49 +0100 (CET)
From:   Jiri Kosina <jikos@...nel.org>
To:     Yang Li <yang.lee@...ux.alibaba.com>
cc:     srinivas.pandruvada@...ux.intel.com, 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: intel-ish-hid: ishtp-fw-loader: Fix a kernel-doc
 formatting issue

On Thu, 16 Dec 2021, Yang Li wrote:

> This function had kernel-doc that not used a hash to separate
> the function name from the one line description.
> 
> The warning was found by running scripts/kernel-doc, which is
> caused by using 'make W=1'.
> 
> drivers/hid/intel-ish-hid/ishtp-fw-loader.c:271: warning: This comment
> starts with '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
> 
> Reported-by: Abaci Robot <abaci@...ux.alibaba.com>
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>

Applied, thanks.

-- 
Jiri Kosina
SUSE Labs