fix pcm_set_params() documentation

The documentation for the latency parameter of pcm_set_params() says
that the value 0 uses an optimal value.  This is wrong, as there is no
special handling for 0, and the result will be a buffer of minimal size.
Therefore, remove that incorrect statement.

Signed-off-by: Clemens Ladisch <clemens@ladisch.de>

diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c
index b44956fb1b9a6695004687d8e67952f460b32976..209c5bb0103a7b815c7b91c9e90d1ac5e46111db 100644 (file)
--- a/src/pcm/pcm.c
+++ b/src/pcm/pcm.c
@@ -7257,7 +7257,7 @@ int snd_pcm_recover(snd_pcm_t *pcm, int err, int silent)
  * \param channels required PCM channels
  * \param rate required sample rate in Hz
  * \param soft_resample 0 = disallow alsa-lib resample stream, 1 = allow resampling
- * \param latency required overall latency in us (0 = optimum latency for players)
+ * \param latency required overall latency in us
  * \return 0 on success otherwise a negative error code
  */
 int snd_pcm_set_params(snd_pcm_t *pcm,