From: Jaroslav Kysela <perex@perex.cz>
Date: Wed, 28 Nov 2001 16:51:31 +0000 (+0000)
Subject: Updated documentation for snd_pcm_mmap_commit()
X-Git-Tag: android-x86-9.0-r1~2614
X-Git-Url: http://git.osdn.net/view?a=commitdiff_plain;h=e0aaf895d86a6a874533e4d61e93ccf922914f5f;p=android-x86%2Fexternal-alsa-lib.git

Updated documentation for snd_pcm_mmap_commit()
---

diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c
index ede542ec..ba9b56de 100644
--- a/src/pcm/pcm.c
+++ b/src/pcm/pcm.c
@@ -4853,8 +4853,12 @@ int snd_pcm_mmap_begin(snd_pcm_t *pcm,
  * \param size area portion size in frames
  * \return 0 on success otherwise a negative error code
  *
- * To call this with offset/frames values different from that returned
- * by snd_pcm_mmap_begin() has undefined effects and it has to be avoided.
+ * You should pass this function the offset value that
+ * snd_pcm_mmap_begin() returned. The frames parameter should hold the
+ * number of frames you have written or read to/from the audio
+ * buffer. The frames parameter must never exceed the configuous frames
+ * count that snd_pcm_mmap_begin() returned. Each call to snd_pcm_mmap_begin()
+ * must be followed by a call to snd_pcm_mmap_commit().
  *
  * Example:
 \code