* [PATCH] platform/chrome: cros_ec_rpmsg: Document missing struct parameters
@ 2020-06-25 17:03 Enric Balletbo i Serra
2020-06-25 21:52 ` Gwendal Grignou
2020-07-01 9:11 ` Enric Balletbo i Serra
0 siblings, 2 replies; 3+ messages in thread
From: Enric Balletbo i Serra @ 2020-06-25 17:03 UTC (permalink / raw)
To: linux-kernel; +Cc: Collabora Kernel ML, groeck, bleung, dtor, gwendal
Kerneldoc expects all kernel structure member to be documented.
Fixes the following W=1 level warnings:
cros_ec_rpmsg.c:49: warning: Function parameter or member 'ept' not described in 'cros_ec_rpmsg'
cros_ec_rpmsg.c:49: warning: Function parameter or member 'has_pending_host_event' not described in 'cros_ec_rpmsg'
cros_ec_rpmsg.c:49: warning: Function parameter or member 'probe_done' not described in 'cros_ec_rpmsg'
Signed-off-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
---
drivers/platform/chrome/cros_ec_rpmsg.c | 3 +++
1 file changed, 3 insertions(+)
diff --git a/drivers/platform/chrome/cros_ec_rpmsg.c b/drivers/platform/chrome/cros_ec_rpmsg.c
index ff08c3d12873a..ad0a30afd7423 100644
--- a/drivers/platform/chrome/cros_ec_rpmsg.c
+++ b/drivers/platform/chrome/cros_ec_rpmsg.c
@@ -38,6 +38,9 @@ struct cros_ec_rpmsg_response {
* @rpdev: rpmsg device we are connected to
* @xfer_ack: completion for host command transfer.
* @host_event_work: Work struct for pending host event.
+ * @ept: The rpmsg endpoint of this channel.
+ * @has_pending_host_event: Boolean used to check if there is a pending event.
+ * @probe_done: Flag to indicate that probe is done.
*/
struct cros_ec_rpmsg {
struct rpmsg_device *rpdev;
--
2.27.0
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] platform/chrome: cros_ec_rpmsg: Document missing struct parameters
2020-06-25 17:03 [PATCH] platform/chrome: cros_ec_rpmsg: Document missing struct parameters Enric Balletbo i Serra
@ 2020-06-25 21:52 ` Gwendal Grignou
2020-07-01 9:11 ` 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:03 AM Enric Balletbo i Serra
<enric.balletbo@collabora.com> wrote:
>
> Kerneldoc expects all kernel structure member to be documented.
>
> Fixes the following W=1 level warnings:
>
> cros_ec_rpmsg.c:49: warning: Function parameter or member 'ept' not described in 'cros_ec_rpmsg'
> cros_ec_rpmsg.c:49: warning: Function parameter or member 'has_pending_host_event' not described in 'cros_ec_rpmsg'
> cros_ec_rpmsg.c:49: warning: Function parameter or member 'probe_done' not described in 'cros_ec_rpmsg'
>
> Signed-off-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
> ---
>
> drivers/platform/chrome/cros_ec_rpmsg.c | 3 +++
> 1 file changed, 3 insertions(+)
>
> diff --git a/drivers/platform/chrome/cros_ec_rpmsg.c b/drivers/platform/chrome/cros_ec_rpmsg.c
> index ff08c3d12873a..ad0a30afd7423 100644
> --- a/drivers/platform/chrome/cros_ec_rpmsg.c
> +++ b/drivers/platform/chrome/cros_ec_rpmsg.c
> @@ -38,6 +38,9 @@ struct cros_ec_rpmsg_response {
> * @rpdev: rpmsg device we are connected to
> * @xfer_ack: completion for host command transfer.
> * @host_event_work: Work struct for pending host event.
> + * @ept: The rpmsg endpoint of this channel.
> + * @has_pending_host_event: Boolean used to check if there is a pending event.
> + * @probe_done: Flag to indicate that probe is done.
> */
> struct cros_ec_rpmsg {
> struct rpmsg_device *rpdev;
> --
> 2.27.0
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] platform/chrome: cros_ec_rpmsg: Document missing struct parameters
2020-06-25 17:03 [PATCH] platform/chrome: cros_ec_rpmsg: Document missing struct parameters Enric Balletbo i Serra
2020-06-25 21:52 ` Gwendal Grignou
@ 2020-07-01 9:11 ` Enric Balletbo i Serra
1 sibling, 0 replies; 3+ messages in thread
From: Enric Balletbo i Serra @ 2020-07-01 9:11 UTC (permalink / raw)
To: linux-kernel; +Cc: Collabora Kernel ML, groeck, bleung, dtor, gwendal
Hi Gwendal,
Thank you for your review.
On 25/6/20 19:03, Enric Balletbo i Serra wrote:
> Kerneldoc expects all kernel structure member to be documented.
>
> Fixes the following W=1 level warnings:
>
> cros_ec_rpmsg.c:49: warning: Function parameter or member 'ept' not described in 'cros_ec_rpmsg'
> cros_ec_rpmsg.c:49: warning: Function parameter or member 'has_pending_host_event' not described in 'cros_ec_rpmsg'
> cros_ec_rpmsg.c:49: warning: Function parameter or member 'probe_done' not described in 'cros_ec_rpmsg'
>
> Signed-off-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
Applied for 5.9
> ---
>
> drivers/platform/chrome/cros_ec_rpmsg.c | 3 +++
> 1 file changed, 3 insertions(+)
>
> diff --git a/drivers/platform/chrome/cros_ec_rpmsg.c b/drivers/platform/chrome/cros_ec_rpmsg.c
> index ff08c3d12873a..ad0a30afd7423 100644
> --- a/drivers/platform/chrome/cros_ec_rpmsg.c
> +++ b/drivers/platform/chrome/cros_ec_rpmsg.c
> @@ -38,6 +38,9 @@ struct cros_ec_rpmsg_response {
> * @rpdev: rpmsg device we are connected to
> * @xfer_ack: completion for host command transfer.
> * @host_event_work: Work struct for pending host event.
> + * @ept: The rpmsg endpoint of this channel.
> + * @has_pending_host_event: Boolean used to check if there is a pending event.
> + * @probe_done: Flag to indicate that probe is done.
> */
> struct cros_ec_rpmsg {
> struct rpmsg_device *rpdev;
>
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-07-01 9:11 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:03 [PATCH] platform/chrome: cros_ec_rpmsg: Document missing struct parameters Enric Balletbo i Serra
2020-06-25 21:52 ` Gwendal Grignou
2020-07-01 9:11 ` 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.