[PATCH] ASoC: soc-acpi: Add missing kernel doc

[PATCH] ASoC: soc-acpi: Add missing kernel doc

[Charles Keepax]

The UID field in snd_soc_acpi_link_adr is not documented, add kernel doc
for it.

Signed-off-by: Charles Keepax <ckeepax@opensource.cirrus.com>
---
 include/sound/soc-acpi.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/include/sound/soc-acpi.h b/include/sound/soc-acpi.h
index 630bf7367fe69..6d31d535e8f6d 100644
--- a/include/sound/soc-acpi.h
+++ b/include/sound/soc-acpi.h
@@ -151,6 +151,7 @@ struct snd_soc_acpi_link_adr {
  * all firmware/topology related fields.
  *
  * @id: ACPI ID (usually the codec's) used to find a matching machine driver.
+ * @uid: ACPI Unique ID, can be used to disambiguate matches.
  * @comp_ids: list of compatible audio codecs using the same machine driver,
  * firmware and topology
  * @link_mask: describes required board layout, e.g. for SoundWire.
-- 
2.30.2

Re: [PATCH] ASoC: soc-acpi: Add missing kernel doc

[Mark Brown]

On Thu, 03 Aug 2023 17:23:12 +0100, Charles Keepax wrote:
> The UID field in snd_soc_acpi_link_adr is not documented, add kernel doc
> for it.
> 
> 

Applied to

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

Thanks!

[1/1] ASoC: soc-acpi: Add missing kernel doc
      commit: 9f0d4d47c7915ce21bde4a4974a7a6307e244a6d

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