[alsa-devel] [PATCH - snd_pcm_sw_params_set_xfer_align doc update 1add notes regarding snd_pcm_sw_params_set_xfer_align's deprecation and

[Aaron J. Grier]

Signed-off-by: Aaron J. Grier <agrier at poofygoof.com>

diff --git a/src/pcm/pcm.c b/src/pcm/pcm.c
index ee2300e..a937b40 100644
--- a/src/pcm/pcm.c
+++ b/src/pcm/pcm.c
@@ -5694,6 +5694,17 @@ int snd_pcm_sw_params_get_period_event(const snd_pcm_sw_params_t *params, int *v
  * \param params Software configuration container
  * \param val Chunk size (frames are attempted to be transferred in chunks)
  * \return 0 otherwise a negative error code
+ *
+ * "There is no replacement; the transfer alignment always is one
+ * frame[.]" -- Clemens Ladisch <clemens at ladisch.de>
+ *
+ * "Note that the transfer alignment was really buggy, and didn't work
+ * at all like what you imagined from its name." -- Takashi Iwai
+ * <tiwai at suse.de>
+ *
+ * If fixed-size transfers are required, use \ref snd_pcm_avail_update
+ * if to determine the number of frames available before reading or
+ * writing.
  */
 #ifndef DOXYGEN
 int snd_pcm_sw_params_set_xfer_align(snd_pcm_t *pcm ATTRIBUTE_UNUSED, snd_pcm_sw_params_t *params ATTRIBUTE_UNUSED, snd_pcm_uframes_t val ATTRIBUTE_UNUSED)
-- 
1.5.4.1