linux-kernel - Re: [PATCH] platform/chrome: cros_ec_spi: Document missing function parameters

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: <07adffbf-477e-8550-39c2-706d740a77bb@collabora.com>
Date:   Wed, 1 Jul 2020 11:10:52 +0200
From:   Enric Balletbo i Serra <enric.balletbo@...labora.com>
To:     linux-kernel@...r.kernel.org
Cc:     Collabora Kernel ML <kernel@...labora.com>, groeck@...omium.org,
        bleung@...omium.org, dtor@...omium.org, gwendal@...omium.org
Subject: Re: [PATCH] platform/chrome: cros_ec_spi: Document missing function
 parameters

Hi Gwendal,

Thank you for the review.

On 25/6/20 19:02, Enric Balletbo i Serra wrote:
> Kerneldoc expects all kernel function members to be documented.
> 
> Fixes the following W=1 level warnings:
> 
>   cros_ec_spi.c:153: warning: Function parameter or member 'ec_dev' not described in 'receive_n_bytes'
>   cros_ec_spi.c:153: warning: Function parameter or member 'buf' not described in 'receive_n_bytes'
>   cros_ec_spi.c:153: warning: Function parameter or member 'n' not described in 'receive_n_bytes'
> 
> Signed-off-by: Enric Balletbo i Serra <enric.balletbo@...labora.com>

Applied for 5.9

> ---
> 
>  drivers/platform/chrome/cros_ec_spi.c | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/drivers/platform/chrome/cros_ec_spi.c b/drivers/platform/chrome/cros_ec_spi.c
> index f7cf7c6a04507..d17f5c74ae976 100644
> --- a/drivers/platform/chrome/cros_ec_spi.c
> +++ b/drivers/platform/chrome/cros_ec_spi.c
> @@ -148,6 +148,10 @@ static int terminate_request(struct cros_ec_device *ec_dev)
>   * receive_n_bytes - receive n bytes from the EC.
>   *
>   * Assumes buf is a pointer into the ec_dev->din buffer
> + *
> + * @ec_dev: ChromeOS EC device.
> + * @buf: Pointer to the buffer receiving the data.
> + * @n: Number of bytes received.
>   */
>  static int receive_n_bytes(struct cros_ec_device *ec_dev, u8 *buf, int n)
>  {
>