ALSA: docs: Extend module parameters description
authorIvan Orlov <ivan.orlov0322@gmail.com>
Mon, 1 May 2023 10:16:34 +0000 (14:16 +0400)
committerTakashi Iwai <tiwai@suse.de>
Wed, 3 May 2023 06:06:37 +0000 (08:06 +0200)
commit1604f51b401bfd881ab5c6401eaedac97f2166ca
treedaca1f711a4cddbfd732c39132622e5188cb2c04
parent7e2d06628aab6324e1ac885910a52f4c038d4043
ALSA: docs: Extend module parameters description

Common ALSA module parameters look a little bit confusing because of the
description lacking, and it took me a while to understand the purpose of
their existence. To figure it out I asked the question about them to the
"alsa-devel" mailing list, and Takashi Iwai answered me with the text I
appended to the ALSA documentation in this patch.

These common module parameters aren't used a lot nowadays, but as I
understand they are important for providing compatibility with some
existing user-space apps. So in my opinion it is a good idea to document
why we need them.

Signed-off-by: Ivan Orlov <ivan.orlov0322@gmail.com>
Link: https://lore.kernel.org/r/20230501101634.476297-1-ivan.orlov0322@gmail.com
Signed-off-by: Takashi Iwai <tiwai@suse.de>
Documentation/sound/alsa-configuration.rst