Re: [PATCH v2] ALSA: compress: document 'chan_map' member in snd_dec_opus
From: Takashi Iwai
Date: Sun Sep 28 2025 - 02:29:21 EST
On Sat, 27 Sep 2025 16:27:08 +0200,
Kriish Sharma wrote:
>
> When building kernel docs, the following warning appeared:
>
> WARNING: ./include/uapi/sound/compress_params.h:364
> struct member 'chan_map' not described in 'snd_dec_opus'
>
> The inline struct 'snd_dec_opus_ch_map' inside 'snd_dec_opus' was not
> properly documented. This patch documents the 'chan_map' member and its
> fields (stream_count, coupled_count, channel_map), resolving the warning.
>
> Fixes: 5d36370f3431 ("ALSA: compress: add raw opus codec define and opus decoder structs")
> Suggested-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
> Signed-off-by: Kriish Sharma <kriish.sharma2006@xxxxxxxxx>
>
> v2:
> - Use proper subject prefix ("ALSA: compress: ...")
> - Add Fixes tag for the commit that introduced snd_dec_opus
> - Add Suggested-by tag (Bagas Sanjaya)
Thanks, applied now.
Takashi