2020-06-25 18:23:06

by Enric Balletbo i Serra

Subject: [PATCH] platform/chrome: cros_ec_rpmsg: Document missing struct parameters

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

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

2020-06-25 23:46:08

by Gwendal Grignou

Subject: Re: [PATCH] platform/chrome: cros_ec_rpmsg: Document missing struct parameters

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

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

2020-07-01 09:12:41

by Enric Balletbo i Serra

Subject: Re: [PATCH] platform/chrome: cros_ec_rpmsg: Document missing struct parameters

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

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;
>