Re: [PATCH] docs: sound: describe 'chan_map' member in snd_dec_opus

[Kriish Sharma]

Apologies my previous message to the list was sent in HTML format

> Thanks for the feedback. Do you prefer me to send a v2 with the Fixes tag and nested struct documentation?

On Sat, Sep 27, 2025 at 6:28 PM Kriish Sharma
<kriish.sharma2006@xxxxxxxxx> wrote:
>
> Thanks for the feedback. Do you prefer me to send a v2 with the Fixes tag and nested struct documentation?
>
> On Sat, Sep 27, 2025 at 5:29 PM Bagas Sanjaya <bagasdotme@xxxxxxxxx> wrote:
>>
>> On Sat, Sep 27, 2025 at 10:17:34AM +0200, Takashi Iwai wrote:
>> > On Fri, 26 Sep 2025 18:26:58 +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.
>> > >
>> > > Signed-off-by: Kriish Sharma <kriish.sharma2006@xxxxxxxxx>
>> >
>> > Adding Alexey to Cc, as it was added by his patch.
>> >
>> > If any, please resubmit with a proper subject line (e.g. "ALSA:
>> > compress: ....") as well as the Fixes tag pointing to the affecting
>> > commit.
>>
>> In this case, the Fixes: tag should be:
>>
>> Fixes: 5d36370f3431 ("ALSA: compress: add raw opus codec define and opus decoder structs")
>>
>> Thanks.
>>
>> --
>> An old man doll... just what I always wanted! - Clara