soundwire: fix the kernel-doc comment
diff mbox series

Message ID 20200715095702.1519554-1-vkoul@kernel.org
State New
Headers show
Series
  • soundwire: fix the kernel-doc comment
Related show

Commit Message

Vinod Koul July 15, 2020, 9:57 a.m. UTC
sdw_startup_stream() and sdw_shutdown_stream() argument has been updated
but not the comments, so update these as well to fix warning with W=1

drivers/soundwire/stream.c:1859: warning: Function parameter or member 'sdw_substream' not described in 'sdw_startup_stream'
drivers/soundwire/stream.c:1859: warning: Excess function parameter 'stream' description in 'sdw_startup_stream'
drivers/soundwire/stream.c:1903: warning: Function parameter or member 'sdw_substream' not described in 'sdw_shutdown_stream'
drivers/soundwire/stream.c:1903: warning: Excess function parameter 'stream' description in 'sdw_shutdown_stream'

Signed-off-by: Vinod Koul <vkoul@kernel.org>
---
 drivers/soundwire/stream.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Pierre-Louis Bossart July 15, 2020, 2:42 p.m. UTC | #1
On 7/15/20 4:57 AM, Vinod Koul wrote:
> sdw_startup_stream() and sdw_shutdown_stream() argument has been updated
> but not the comments, so update these as well to fix warning with W=1
> 
> drivers/soundwire/stream.c:1859: warning: Function parameter or member 'sdw_substream' not described in 'sdw_startup_stream'
> drivers/soundwire/stream.c:1859: warning: Excess function parameter 'stream' description in 'sdw_startup_stream'
> drivers/soundwire/stream.c:1903: warning: Function parameter or member 'sdw_substream' not described in 'sdw_shutdown_stream'
> drivers/soundwire/stream.c:1903: warning: Excess function parameter 'stream' description in 'sdw_shutdown_stream'
> 
> Signed-off-by: Vinod Koul <vkoul@kernel.org>

After sending dozens of patches to fix those issues I added one by 
accident, oh well. Thanks for fixing this.

Reviewed-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Vinod Koul July 16, 2020, 4:26 a.m. UTC | #2
On 15-07-20, 09:42, Pierre-Louis Bossart wrote:
> 
> 
> On 7/15/20 4:57 AM, Vinod Koul wrote:
> > sdw_startup_stream() and sdw_shutdown_stream() argument has been updated
> > but not the comments, so update these as well to fix warning with W=1
> > 
> > drivers/soundwire/stream.c:1859: warning: Function parameter or member 'sdw_substream' not described in 'sdw_startup_stream'
> > drivers/soundwire/stream.c:1859: warning: Excess function parameter 'stream' description in 'sdw_startup_stream'
> > drivers/soundwire/stream.c:1903: warning: Function parameter or member 'sdw_substream' not described in 'sdw_shutdown_stream'
> > drivers/soundwire/stream.c:1903: warning: Excess function parameter 'stream' description in 'sdw_shutdown_stream'
> > 
> > Signed-off-by: Vinod Koul <vkoul@kernel.org>
> 
> After sending dozens of patches to fix those issues I added one by accident,
> oh well. Thanks for fixing this.
> 
> Reviewed-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>

Thanks applied and pushed

Patch
diff mbox series

diff --git a/drivers/soundwire/stream.c b/drivers/soundwire/stream.c
index 6bc2ff29c202..37290a799023 100644
--- a/drivers/soundwire/stream.c
+++ b/drivers/soundwire/stream.c
@@ -1851,7 +1851,7 @@  static int set_stream(struct snd_pcm_substream *substream,
 /**
  * sdw_startup_stream() - Startup SoundWire stream
  *
- * @stream: Soundwire stream
+ * @sdw_substream: Soundwire stream
  *
  * Documentation/driver-api/soundwire/stream.rst explains this API in detail
  */
@@ -1895,7 +1895,7 @@  EXPORT_SYMBOL(sdw_startup_stream);
 /**
  * sdw_shutdown_stream() - Shutdown SoundWire stream
  *
- * @stream: Soundwire stream
+ * @sdw_substream: Soundwire stream
  *
  * Documentation/driver-api/soundwire/stream.rst explains this API in detail
  */