[alsa-lib PATCH] Document strdup allocation in snd_card_get_name family

[Andrew Eikum <aeikum@codeweavers.com>]

[-- Attachment #1: Type: text/plain, Size: 613 bytes --]

This was spotted by Jörg Höhle on the wine-patches ML.

Signed-off-by: Andrew Eikum <aeikum@codeweavers.com>
---

I noticed my documentation patches haven't been making their way into
alsa-lib.git. Am I submitting these wrong? I added the SOB line above,
although I notice not all patches that get into ALSA have it. On the
other hand, alsa-lib.git hasn't been changed since November so perhaps
my patches are sitting in someone's tree waiting to be pushed :)

Please let me know if I can help get these in.

 src/control/cards.c |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)


[-- Attachment #2: 0001-Document-strdup-allocation-in-snd_card_get_name-fami.patch --]
[-- Type: text/x-patch, Size: 922 bytes --]

diff --git a/src/control/cards.c b/src/control/cards.c
index 0bb8f86..b528e33 100644
--- a/src/control/cards.c
+++ b/src/control/cards.c
@@ -166,6 +166,9 @@ int snd_card_get_index(const char *string)
  * \param card Card number
  * \param name Result - card name corresponding to card number
  * \result zero if success, otherwise a negative error code
+ *
+ * The value returned in name is allocated with strdup and should be
+ * freed when no longer used.
  */
 int snd_card_get_name(int card, char **name)
 {
@@ -193,6 +196,9 @@ int snd_card_get_name(int card, char **name)
  * \param card Card number
  * \param name Result - card long name corresponding to card number
  * \result zero if success, otherwise a negative error code
+ *
+ * The value returned in name is allocated with strdup and should be
+ * freed when no longer used.
  */
 int snd_card_get_longname(int card, char **name)
 {

[-- Attachment #3: Type: text/plain, Size: 0 bytes --]