Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
MIME-Version: 1.0
References: <20200625170241.224780-1-enric.balletbo@collabora.com>
In-Reply-To: <20200625170241.224780-1-enric.balletbo@collabora.com>
From:   Gwendal Grignou <gwendal@chromium.org>
Date:   Thu, 25 Jun 2020 14:52:31 -0700
Message-ID: <CAPUE2utWQzkK4y_J=Zn779oF0H0WGuF_NkYxSfr2L9B-yMqvHw@mail.gmail.com>
Subject: Re: [PATCH] platform/chrome: cros_ec_spi: Document missing function parameters
To:     Enric Balletbo i Serra <enric.balletbo@collabora.com>
Cc:     linux-kernel <linux-kernel@vger.kernel.org>,
        Collabora Kernel ML <kernel@collabora.com>,
        Guenter Roeck <groeck@chromium.org>,
        Benson Leung <bleung@chromium.org>,
        Dmitry Torokhov <dtor@chromium.org>
Content-Type: text/plain; charset="UTF-8"
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

Reviewed-by: Gwendal Grignou <gwendal@chromium.org>

On Thu, Jun 25, 2020 at 10:02 AM Enric Balletbo i Serra
<enric.balletbo@collabora.com> 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@collabora.com>
> ---
>
>  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)
>  {
> --
> 2.27.0
>