snd/soc: correct trivial kernel-doc inconsistency
diff mbox series

Message ID 20200626053953.68797-1-colton.w.lewis@protonmail.com
State New
Headers show
Series
  • snd/soc: correct trivial kernel-doc inconsistency
Related show

Commit Message

Colton Lewis June 26, 2020, 5:40 a.m. UTC
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 26, 2020, 2:35 p.m. UTC | #1
On 6/26/20 12:40 AM, Colton Lewis wrote:
> 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>

Reviewed-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.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.
>
Mark Brown June 26, 2020, 3:16 p.m. UTC | #2
On Fri, 26 Jun 2020 05:40:24 +0000, Colton Lewis wrote:
> 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'

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next

Thanks!

[1/1] snd/soc: correct trivial kernel-doc inconsistency
      commit: b6d6e9ea8fb9d477f07e6e4ad8b8a38a47f6870e

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark

Patch
diff mbox series

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.