diff mbox series

ASoC: rt-sdw-common: fix rt_sdca_index_update_bits function parameter description

Message ID 20241024060205.20201-1-yung-chuan.liao@linux.intel.com (mailing list archive)
State Accepted
Commit 4d9661e28be13f90db43b889fd15f4aad53de7d1
Headers show
Series ASoC: rt-sdw-common: fix rt_sdca_index_update_bits function parameter description | expand

Commit Message

Bard Liao Oct. 24, 2024, 6:02 a.m. UTC 
Fix the mismatch between function parameter and description.
Below warning are reported with W=1.
warning: Function parameter or struct member 'val' not described in
'rt_sdca_index_update_bits'
warning: Excess function parameter 'value' description in
'rt_sdca_index_update_bits'

Signed-off-by: Bard Liao <yung-chuan.liao@linux.intel.com>
Reviewed-by: Shuming Fan <shumingf@realtek.com>
---
 sound/soc/codecs/rt-sdw-common.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Mark Brown Oct. 24, 2024, 5:59 p.m. UTC | #1 
On Thu, 24 Oct 2024 14:02:05 +0800, Bard Liao wrote:
> Fix the mismatch between function parameter and description.
> Below warning are reported with W=1.
> warning: Function parameter or struct member 'val' not described in
> 'rt_sdca_index_update_bits'
> warning: Excess function parameter 'value' description in
> 'rt_sdca_index_update_bits'
> 
> [...]

Applied to

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

Thanks!

[1/1] ASoC: rt-sdw-common: fix rt_sdca_index_update_bits function parameter description
      commit: 4d9661e28be13f90db43b889fd15f4aad53de7d1

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
diff mbox series

Patch

diff --git a/sound/soc/codecs/rt-sdw-common.c b/sound/soc/codecs/rt-sdw-common.c
index 9f51fec383f9..ad61943ce75f 100644
--- a/sound/soc/codecs/rt-sdw-common.c
+++ b/sound/soc/codecs/rt-sdw-common.c
@@ -76,7 +76,7 @@  EXPORT_SYMBOL_GPL(rt_sdca_index_read);
  * @nid: Realtek-defined ID.
  * @reg: register.
  * @mask: Bitmask to change
- * @value: New value for bitmask
+ * @val: New value for bitmask
  *
  * A value of zero will be returned on success, a negative errno will
  * be returned in error cases.