diff mbox series

snd/soc: correct trivial kernel-doc inconsistency

Message ID 4574918.31r3eYUQgx@laptop.coltonlewis.name (mailing list archive)
State New, archived
Headers show
Series snd/soc: correct trivial kernel-doc inconsistency | expand

Commit Message

Colton Lewis June 21, 2020, 2:09 a.m. UTC 
Can some please accept or comment on this patch?

----------  Forwarded Message  ----------

Subject: [PATCH] snd/soc: correct trivial kernel-doc inconsistency
Date: Saturday, June 13, 2020, 9:29:08 PM CDT
From: Colton Lewis <colton.w.lewis@protonmail.com>
To: lgirdwood@gmail.com
CC: trivial@kernel.org, Colton Lewis <colton.w.lewis@protonmail.com>



Silence documentation build warning by correcting kernel-doc comment
for snd_soc_runtime_action.

./sound/soc/soc-pcm.c:220: warning: Function parameter or member 'action' not described in 'snd_soc_runtime_action'

Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
---
 sound/soc/soc-pcm.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Pierre-Louis Bossart June 24, 2020, 3:20 p.m. UTC | #1 
On 6/20/20 9:09 PM, Colton Lewis wrote:
> Can some please accept or comment on this patch?

It's a valid fix, I added the same change in the SOF tree yesterday but 
you beat me to it.

Reviewed-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>

You probably want to resend and CC: Takashi and Mark.

> 
> ----------  Forwarded Message  ----------
> 
> Subject: [PATCH] snd/soc: correct trivial kernel-doc inconsistency
> Date: Saturday, June 13, 2020, 9:29:08 PM CDT
> From: Colton Lewis <colton.w.lewis@protonmail.com>
> To: lgirdwood@gmail.com
> CC: trivial@kernel.org, Colton Lewis <colton.w.lewis@protonmail.com>
> 
> 
> 
> Silence documentation build warning by correcting kernel-doc comment
> for snd_soc_runtime_action.
> 
> ./sound/soc/soc-pcm.c:220: warning: Function parameter or member 'action' not described in 'snd_soc_runtime_action'
> 
> Signed-off-by: Colton Lewis <colton.w.lewis@protonmail.com>
> ---
>   sound/soc/soc-pcm.c | 1 +
>   1 file changed, 1 insertion(+)
> 
> diff --git a/sound/soc/soc-pcm.c b/sound/soc/soc-pcm.c
> index 2c114b4542ce..9ab376844ac1 100644
> --- a/sound/soc/soc-pcm.c
> +++ b/sound/soc/soc-pcm.c
> @@ -208,6 +208,7 @@ static inline void dpcm_remove_debugfs_state(struct snd_soc_dpcm *dpcm)
>    * PCM runtime components
>    * @rtd: ASoC PCM runtime that is activated
>    * @stream: Direction of the PCM stream
> + * @action: Activate stream if 1. Deactivate if -1.
>    *
>    * Increments/Decrements the active count for all the DAIs and components
>    * attached to a PCM runtime.
>
diff mbox series

Patch

diff --git a/sound/soc/soc-pcm.c b/sound/soc/soc-pcm.c
index 2c114b4542ce..9ab376844ac1 100644
--- a/sound/soc/soc-pcm.c
+++ b/sound/soc/soc-pcm.c
@@ -208,6 +208,7 @@  static inline void dpcm_remove_debugfs_state(struct snd_soc_dpcm *dpcm)
  * PCM runtime components
  * @rtd: ASoC PCM runtime that is activated
  * @stream: Direction of the PCM stream
+ * @action: Activate stream if 1. Deactivate if -1.
  *
  * Increments/Decrements the active count for all the DAIs and components
  * attached to a PCM runtime.