[2/2] remoteproc: qcom_sysmon: Solve function header bitrot issues

Message ID 20200715123551.4011154-2-lee.jones@linaro.org
State Accepted
Commit 5b435ca38b2ce785b60b4d3c230f0a21121d6728
Headers show
Series
  • Untitled series #44555
Related show

Commit Message

Lee Jones July 15, 2020, 12:35 p.m.
Looks as though 'name' has now been moved into 'struct sysmod_event'
which is passed in instead.  However, the parameter descriptions were
not updated at the same time.  Let's do that now.

Fixes the following W=1 kernel build warning(s):

 drivers/remoteproc/qcom_sysmon.c:78: warning: Function parameter or member 'event' not described in 'sysmon_send_event'
 drivers/remoteproc/qcom_sysmon.c:78: warning: Excess function parameter 'name' description in 'sysmon_send_event'
 drivers/remoteproc/qcom_sysmon.c:350: warning: Function parameter or member 'event' not described in 'ssctl_send_event'
 drivers/remoteproc/qcom_sysmon.c:350: warning: Excess function parameter 'name' description in 'ssctl_send_event'

Cc: Andy Gross <agross@kernel.org>
Cc: linux-arm-msm@vger.kernel.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/remoteproc/qcom_sysmon.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

-- 
2.25.1

Comments

Bjorn Andersson July 15, 2020, 7:21 p.m. | #1
On Wed 15 Jul 05:35 PDT 2020, Lee Jones wrote:

> Looks as though 'name' has now been moved into 'struct sysmod_event'

> which is passed in instead.  However, the parameter descriptions were

> not updated at the same time.  Let's do that now.

> 

> Fixes the following W=1 kernel build warning(s):

> 

>  drivers/remoteproc/qcom_sysmon.c:78: warning: Function parameter or member 'event' not described in 'sysmon_send_event'

>  drivers/remoteproc/qcom_sysmon.c:78: warning: Excess function parameter 'name' description in 'sysmon_send_event'

>  drivers/remoteproc/qcom_sysmon.c:350: warning: Function parameter or member 'event' not described in 'ssctl_send_event'

>  drivers/remoteproc/qcom_sysmon.c:350: warning: Excess function parameter 'name' description in 'ssctl_send_event'

> 

> Cc: Andy Gross <agross@kernel.org>

> Cc: linux-arm-msm@vger.kernel.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>


Thanks Lee, both patches applied.

Regards,
Bjorn

> ---

>  drivers/remoteproc/qcom_sysmon.c | 4 ++--

>  1 file changed, 2 insertions(+), 2 deletions(-)

> 

> diff --git a/drivers/remoteproc/qcom_sysmon.c b/drivers/remoteproc/qcom_sysmon.c

> index 8d8996d714f07..9eb2f6bccea63 100644

> --- a/drivers/remoteproc/qcom_sysmon.c

> +++ b/drivers/remoteproc/qcom_sysmon.c

> @@ -71,7 +71,7 @@ static LIST_HEAD(sysmon_list);

>  /**

>   * sysmon_send_event() - send notification of other remote's SSR event

>   * @sysmon:	sysmon context

> - * @name:	other remote's name

> + * @event:	sysmon event context

>   */

>  static void sysmon_send_event(struct qcom_sysmon *sysmon,

>  			      const struct sysmon_event *event)

> @@ -343,7 +343,7 @@ static void ssctl_request_shutdown(struct qcom_sysmon *sysmon)

>  /**

>   * ssctl_send_event() - send notification of other remote's SSR event

>   * @sysmon:	sysmon context

> - * @name:	other remote's name

> + * @event:	sysmon event context

>   */

>  static void ssctl_send_event(struct qcom_sysmon *sysmon,

>  			     const struct sysmon_event *event)

> -- 

> 2.25.1

>

Patch

diff --git a/drivers/remoteproc/qcom_sysmon.c b/drivers/remoteproc/qcom_sysmon.c
index 8d8996d714f07..9eb2f6bccea63 100644
--- a/drivers/remoteproc/qcom_sysmon.c
+++ b/drivers/remoteproc/qcom_sysmon.c
@@ -71,7 +71,7 @@  static LIST_HEAD(sysmon_list);
 /**
  * sysmon_send_event() - send notification of other remote's SSR event
  * @sysmon:	sysmon context
- * @name:	other remote's name
+ * @event:	sysmon event context
  */
 static void sysmon_send_event(struct qcom_sysmon *sysmon,
 			      const struct sysmon_event *event)
@@ -343,7 +343,7 @@  static void ssctl_request_shutdown(struct qcom_sysmon *sysmon)
 /**
  * ssctl_send_event() - send notification of other remote's SSR event
  * @sysmon:	sysmon context
- * @name:	other remote's name
+ * @event:	sysmon event context
  */
 static void ssctl_send_event(struct qcom_sysmon *sysmon,
 			     const struct sysmon_event *event)