# HG changeset patch
# User reimar
# Date 1252398656 0
# Node ID 732dfbf675240043dabac95fc639a07d0b57298f
# Parent  98fdef0c35a1561e73b68d501ff5be28a86a1155
Try to clarify that anyone using get_bits must check for buffer overrun
themselves, get_bits does not do anything in that regard.

diff -r 98fdef0c35a1 -r 732dfbf67524 get_bits.h
--- a/get_bits.h	Sun Sep 06 18:24:25 2009 +0000
+++ b/get_bits.h	Tue Sep 08 08:30:56 2009 +0000
@@ -489,6 +489,9 @@
  * @param buffer bitstream buffer, must be FF_INPUT_BUFFER_PADDING_SIZE bytes larger then the actual read bits
  * because some optimized bitstream readers read 32 or 64 bit at once and could read over the end
  * @param bit_size the size of the buffer in bits
+ *
+ * While GetBitContext stores the buffer size, for performance reasons you are
+ * responsible for checking for the buffer end yourself (take advantage of the padding)!
  */
 static inline void init_get_bits(GetBitContext *s,
                    const uint8_t *buffer, int bit_size)