ALSA: jack: Update documention to reflect other userspace interfaces
PATCH 1/1 ALSA: jack: Update documention to reflect other userspace interfaces
Since this is a generic API which should support any userspace interface for reporting jacks update the documentation a little to make that a bit clearer.
Signed-off-by Mark Brown <[email protected]>
--- sound/core/jack.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
sound/core/jack.c +4 -1
@@ -155,7 +155,7 @@ EXPORT_SYMBOL(snd_jack_new);* @jack: The jack to configure * @parent: The device to set as parent for the jack. * -* Set the parent for the jack input device in the device tree. This +* Set the parent for the jack devices in the device tree. This * function is only valid prior to registration of the jack. If no * parent is configured then the parent device will be the sound card. */
@@ -179,6 +179,9 @@ EXPORT_SYMBOL(snd_jack_set_parent);* mapping is provided but keys are enabled in the jack type then * BTN_n numeric buttons will be reported. * +* If jacks are not reporting via the input API this call will have no +* effect. +* * Note that this is intended to be use by simple devices with small * numbers of keys that can be reported. It is also possible to * access the input device directly - devices with complex input
Signature · 1 line
1.7.10
At Mon, 7 May 2012 17:10:21 +0100,
Quoted 6 lines · Mark Brown
Since this is a generic API which should support any userspace interface for reporting jacks update the documentation a little to make that a bit clearer.
Signed-off-by Mark Brown <[email protected]>
Applied now. Thanks.
Takashi
Quoted 30 lines
--- sound/core/jack.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)sound/core/jack.c +4
-1@@ -155,7 +155,7 @@ EXPORT_SYMBOL(snd_jack_new);* @jack: The jack to configure * @parent: The device to set as parent for the jack. * -* Set the parent for the jack input device in the device tree. This +* Set the parent for the jack devices in the device tree. This * function is only valid prior to registration of the jack. If no * parent is configured then the parent device will be the sound card. */ @@ -179,6 +179,9 @@ EXPORT_SYMBOL(snd_jack_set_parent);* mapping is provided but keys are enabled in the jack type then * BTN_n numeric buttons will be reported. * +* If jacks are not reporting via the input API this call will have no +* effect. +* * Note that this is intended to be use by simple devices with small * numbers of keys that can be reported. It is also possible to * access the input device directly - devices with complex input Signature · 1 line
1.7.10