From: Jaroslav Kysela <perex@perex.cz>
Date: Mon, 16 Jun 2008 11:23:22 +0000 (+0200)
Subject: pcm: fix comment for snd_pcm_avail_update()
X-Git-Tag: v1.0.17~3
X-Git-Url: https://git.alsa-project.org/?a=commitdiff_plain;h=5e9120758682531b71d789a15c046688242657d7;p=alsa-lib.git

pcm: fix comment for snd_pcm_avail_update()

In some cases, value might be used for r/w ops, too.

Signed-off-by: Jaroslav Kysela <perex@perex.cz>
---

diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c
index 3f4c033a..ee2300ec 100644
--- a/src/pcm/pcm.c
+++ b/src/pcm/pcm.c
@@ -2385,16 +2385,13 @@ int snd_pcm_wait_nocheck(snd_pcm_t *pcm, int timeout)
 #endif
 
 /**
- * \brief Return number of frames ready to be read/written
+ * \brief Return number of frames ready to be read (capture) / written (playback)
  * \param pcm PCM handle
  * \return a positive number of frames ready otherwise a negative
  * error code
  *
  * On capture does all the actions needed to transport to application
  * level all the ready frames across underlying layers.
- *
- * Using of this function is useless for the standard read/write
- * operations. Use it only for mmap access. See to #snd_pcm_delay.
  */
 snd_pcm_sframes_t snd_pcm_avail_update(snd_pcm_t *pcm)
 {