From: Jaroslav Kysela Date: Tue, 2 Jan 2024 09:52:33 +0000 (+0100) Subject: pcm: fix the documentation for snd_pcm_poll_descriptors again X-Git-Tag: v1.2.11~17 X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=d4992c36cc962bd2b3cef7158af173a95177ba2e;p=alsa-lib.git pcm: fix the documentation for snd_pcm_poll_descriptors again As noted in the github issue, the poll descriptors may change depending on the stream parameters. Fixes: cd04da2b ("pcm: clarify documentation of poll descriptor usage") Fixes: https://github.com/alsa-project/alsa-lib/issues/372 Signed-off-by: Jaroslav Kysela --- diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c index bc7e26fd..75e81c03 100644 --- a/src/pcm/pcm.c +++ b/src/pcm/pcm.c @@ -1812,9 +1812,10 @@ static int __snd_pcm_poll_descriptors(snd_pcm_t *pcm, struct pollfd *pfds, * \link ::snd_pcm_poll_descriptors_revents() \endlink . * * It is guaranteed that for the given PCM handle, the output poll - * descriptor structs (and their count) will never change, thus it is - * valid to call the function once and reuse its output for the - * lifetime of the PCM device. + * descriptor structs (and their count) will not change after + * hardware and software parameters setup. Thus it is valid to call + * the function once when all parameters are set and reuse its output + * for the lifetime of the stream parameters. * * The function is thread-safe when built with the proper option. */