2020-06-25 18:24:57

by Enric Balletbo i Serra

Subject: [PATCH] platform/chrome: cros_ec_spi: Document missing function parameters

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 <[email protected]>
---

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

2020-06-25 23:46:30

by Gwendal Grignou

Subject: Re: [PATCH] platform/chrome: cros_ec_spi: Document missing function parameters

Reviewed-by: Gwendal Grignou <[email protected]>

On Thu, Jun 25, 2020 at 10:02 AM Enric Balletbo i Serra
<[email protected]> 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 <[email protected]>
> ---
>
> 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
>

2020-07-01 09:14:21

by Enric Balletbo i Serra

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 <[email protected]>

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)
> {
>