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] [thread-next>] [day] [month] [year] [list]

Message-ID: <42b7c12f-659b-409a-f4e3-c7a0560b3ce6@infradead.org>
Date:   Wed, 15 Dec 2021 20:08:04 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Yang Li <yang.lee@...ux.alibaba.com>,
        srinivas.pandruvada@...ux.intel.com
Cc:     jikos@...nel.org, 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

Hi,

On 12/15/21 20:01, Yang Li wrote:
> This function had kernel-doc that not used a hash to separate

                               that did not use a dash or hyphen to separate

Patch looks good. Thanks.

> 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>
> ---
>  drivers/hid/intel-ish-hid/ishtp-fw-loader.c | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/hid/intel-ish-hid/ishtp-fw-loader.c b/drivers/hid/intel-ish-hid/ishtp-fw-loader.c
> index 0e1183e96147..e24988586710 100644
> --- a/drivers/hid/intel-ish-hid/ishtp-fw-loader.c
> +++ b/drivers/hid/intel-ish-hid/ishtp-fw-loader.c
> @@ -268,7 +268,8 @@ static int get_firmware_variant(struct ishtp_cl_data *client_data,
>  }
>  
>  /**
> - * loader_cl_send()	Send message from host to firmware
> + * loader_cl_send() - Send message from host to firmware
> + *
>   * @client_data:	Client data instance
>   * @out_msg:		Message buffer to be sent to firmware
>   * @out_size:		Size of out going message
> 

-- 
~Randy