* [PATCH] platform/chrome: cros_ec_spi: Document missing function parameters
@ 2020-06-25 17:02 Enric Balletbo i Serra
2020-06-25 21:52 ` Gwendal Grignou
2020-07-01 9:10 ` Enric Balletbo i Serra
0 siblings, 2 replies; 3+ messages in thread
From: Enric Balletbo i Serra @ 2020-06-25 17:02 UTC (permalink / raw)
To: linux-kernel; +Cc: Collabora Kernel ML, groeck, bleung, dtor, gwendal
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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] platform/chrome: cros_ec_spi: Document missing function parameters
2020-06-25 17:02 [PATCH] platform/chrome: cros_ec_spi: Document missing function parameters Enric Balletbo i Serra
@ 2020-06-25 21:52 ` Gwendal Grignou
2020-07-01 9:10 ` Enric Balletbo i Serra
1 sibling, 0 replies; 3+ messages in thread
From: Gwendal Grignou @ 2020-06-25 21:52 UTC (permalink / raw)
To: Enric Balletbo i Serra
Cc: linux-kernel, Collabora Kernel ML, Guenter Roeck, Benson Leung,
Dmitry Torokhov
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
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] platform/chrome: cros_ec_spi: Document missing function parameters
2020-06-25 17:02 [PATCH] platform/chrome: cros_ec_spi: Document missing function parameters Enric Balletbo i Serra
2020-06-25 21:52 ` Gwendal Grignou
@ 2020-07-01 9:10 ` Enric Balletbo i Serra
1 sibling, 0 replies; 3+ messages in thread
From: Enric Balletbo i Serra @ 2020-07-01 9:10 UTC (permalink / raw)
To: linux-kernel; +Cc: Collabora Kernel ML, groeck, bleung, dtor, gwendal
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@collabora.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)
> {
>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-07-01 9:10 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-06-25 17:02 [PATCH] platform/chrome: cros_ec_spi: Document missing function parameters Enric Balletbo i Serra
2020-06-25 21:52 ` Gwendal Grignou
2020-07-01 9:10 ` Enric Balletbo i Serra
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.