[FFmpeg-devel] [PATCH] Improve documentation for flush_put_bits()

[Michael Niedermayer]

On Sat, Nov 28, 2009 at 11:13:43AM +0100, Stefano Sabatini wrote:
> On date Saturday 2009-04-11 15:18:20 +0200, Diego Biurrun encoded:
> > On Sat, Apr 11, 2009 at 01:14:37PM +0200, Stefano Sabatini wrote:
> > > --- ffmpeg.orig/libavcodec/bitstream.h	2009-04-11 11:14:07.000000000 +0200
> > > +++ ffmpeg/libavcodec/bitstream.h	2009-04-11 13:08:10.000000000 +0200
> > > @@ -129,7 +129,8 @@
> > >  
> > >  /**
> > > - * Pads the end of the output stream with zeros.
> > > + * Flushes the content of the bitstream writer internal buffer, padded
> > > + * with zeros, to the bitstream.
> > >   */
> > >  static inline void flush_put_bits(PutBitContext *s)
> > 
> > Still sounds awkward to me.  I don't have a good alternative for "flush
> > to the bitstream" though.  Maybe some of the native speakers can help.
> 
> What about "Writes"? ;-)
> 
> Patch updated (yes I'm trying to clean up my inbox...).
> 
> Regards.
> -- 
> FFmpeg = Forgiving Fast Mystic Picky Eccentric Gadget

>  put_bits.h |    3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 9e2ae4d031847644108cda96609b78f146fcf27f  fix-for-flush-put-bits-doc.patch
> Index: ffmpeg/libavcodec/put_bits.h
> ===================================================================
> --- ffmpeg.orig/libavcodec/put_bits.h	2009-11-28 11:03:02.000000000 +0100
> +++ ffmpeg/libavcodec/put_bits.h	2009-11-28 11:10:40.000000000 +0100
> @@ -91,7 +91,8 @@
>  }
>  
>  /**
> - * Pads the end of the output stream with zeros.
> + * Writes the content of the bitstream writer internal buffer, padded
> + * with zeros up to the next byte boundary, to the bitstream.

not every writer has a internal buffer

[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

Complexity theory is the science of finding the exact solution to an
approximation. Benchmarking OTOH is finding an approximation of the exact
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20091128/65462ce4/attachment.pgp>