soundwire: fix the kernel-doc comment
Vinod Koul
maintainerPATCH 1/1 soundwire: fix the kernel-doc comment
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'
--- drivers/soundwire/stream.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
drivers/soundwire/stream.c +2 -2
@@ -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 */
Signature · 1 line
2.26.2
Quoted 9 lines · Vinod Koul
sdw_startup_stream()andsdw_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 <[email protected]>
After sending dozens of patches to fix those issues I added one by accident, oh well. Thanks for fixing this.
Quoted 11 lines · Pierre-Louis Bossart
Quoted 8 lines · Vinod Koul
sdw_startup_stream()andsdw_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'
Quoted 6 lines
Quoted 1 line
Signed-off-by Vinod Koul <[email protected]>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 <[email protected]>
Thanks applied and pushed
Signature · 1 line
~Vinod