ALSA: jack: Update documention to reflect other userspace interfaces
authorMark Brown <broonie@opensource.wolfsonmicro.com>
Mon, 7 May 2012 16:10:21 +0000 (17:10 +0100)
committerTakashi Iwai <tiwai@suse.de>
Mon, 7 May 2012 16:11:37 +0000 (18:11 +0200)
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 <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
sound/core/jack.c

index 471e1e3b0a996da3fec0d21c82a55b87f3460469..a06b1651fcba02f9003f5b9a07ad2c72fb2dea14 100644 (file)
@@ -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