[FFmpeg-devel] [PATCH] Doxygenate libavutil/mem.h

Stefano Sabatini stefano.sabatini-lala
Thu Nov 1 15:31:40 CET 2007


On date Saturday 2007-10-20 11:55:48 +0200, Stefano Sabatini encoded:
> On date Thursday 2007-10-18 12:12:51 +0200, Stefano Sabatini encoded:
> > On date Tuesday 2007-10-16 01:08:26 +0200, Diego Biurrun encoded:
> > > On Mon, Oct 15, 2007 at 07:42:19PM +0200, Michael Niedermayer wrote:
> [...]
> > > > patch rejected it mixes too many unrelated changes
> > > > some pure spelling corrections some plain wrong
> > > 
> > > I went over the file and fixed a couple of grammar and spelling
> > > mistakes.  Please send in the rest of your changes now.
> > 
> > Hi Diego,
> > 
> > I noticed you changed:
> > 
> >  * Duplicates the string \p s.
> >             ^
> > to: 
> > 
> >  * Duplicate the string \p s.
> > 
> > (in all my previous documentation patches I used the first form).
> > 
> > Please can you say which form you prefer, I really don't mind about
> > it, I just want it to be globally consistent.
> > 
> > Also a note in the programming style doc section regarding this would
> > be nice.
> 
> New patch attached.
> 
> I removed the notes telling:
>  * @note av_mallocz(0) return value is actually undefined, but future
>  * versions might force it to be a non-NULL value.
> 
> which maybe deserve another patch or are simply unappropriate, and
> applied consistently the "Duplicate" style (I'll eventually send
> another patch to "third-personify" the documentation).
> 
> I checked again the implmentation and I saw how it depends on the
> various malloc/free/realloc defined by the C library, which are
> somehow depending on the implementation, so I cannot be sure the
> documentation is perfectly coherent in case of a misbehaving
> implementation.
> 
> I think however that some partially wrong documentation is still
> better than none at all, if you can find some way to make it more
> generic and indipendent on the underlying implementation please
> suggest how to do it.
[...]

New try, some cosmetic changes of the previous version gone into
another patch, small rework of av_realloc docs.

Regards
-- 
Stefano Sabatini
Linux user number 337176 (see http://counter.li.org)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: doxygenate-mem-h-08.patch
Type: text/x-diff
Size: 2247 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20071101/3ed56fe8/attachment.patch>



More information about the ffmpeg-devel mailing list