lavu/fifo: clarify interaction of AV_FIFO_FLAG_AUTO_GROW with av_fifo_write()

1 files changed, 4 insertions, 1 deletions

diff --git a/libavutil/fifo.h b/libavutil/fifo.h
index 89872d0972..70f9376d97 100644
--- a/libavutil/fifo.h
+++ b/libavutil/fifo.h
@@ -124,9 +124,12 @@ int av_fifo_grow2(AVFifo *f, size_t inc);
 /**
  * Write data into a FIFO.
  *
- * In case nb_elems > av_fifo_can_write(f), nothing is written and an error
+ * In case nb_elems > av_fifo_can_write(f) and the AV_FIFO_FLAG_AUTO_GROW flag
+ * was not specified at FIFO creation, nothing is written and an error
  * is returned.
  *
+ * Calling function is guaranteed to succeed if nb_elems <= av_fifo_can_write(f).
+ *
  * @param f the FIFO buffer
  * @param buf Data to be written. nb_elems * av_fifo_elem_size(f) bytes will be
  *            read from buf on success.