[FFmpeg-cvslog] r11225 - trunk/libavformat/avformat.h

[Måns Rullgård]

Baptiste Coudurier wrote:
> Hi Diego,
>
> Diego Biurrun wrote:
>> On Mon, Dec 17, 2007 at 02:38:19AM +0100, Michael Niedermayer wrote:
>>> On Sun, Dec 16, 2007 at 11:40:05PM +0000, M?ns Rullg?rd wrote:
>>>> Diego Biurrun <diego at biurrun.de> writes:
>>>>
>>>>> On Sun, Dec 16, 2007 at 10:52:23PM +0000, M?ns Rullg?rd wrote:
>>>>>> Michael Niedermayer <michaelni at gmx.at> writes:
>>>>>>
>>>>>>> On Sun, Dec 16, 2007 at 06:22:09PM +0100, Diego Biurrun wrote:
>>>>>>>> On Sat, Dec 15, 2007 at 05:54:59PM +0100, michael wrote:
>>>>>>>>> Log:
>>>>>>>>> document how to free the result of av_alloc_format_context()
>>>>>>>>>
>>>>>>>>> --- trunk/libavformat/avformat.h	(original)
>>>>>>>>> +++ trunk/libavformat/avformat.h	Sat Dec 15 17:54:58 2007
>>>>>>>>> @@ -569,7 +569,11 @@ int av_open_input_file(AVFormatContext *
>>>>>>>>> +/**
>>>>>>>>> + * Allocate an AVFormatContext.
>>>>>>>>> + * can be freed with av_free() but dont forget to free everything you
>>>>>>>>> + * explicitly allocated as well!
>>>>>>>> Could you please make an effort to avoid obvious misspellings ("dont")?
>>>>>>>> It took some work to fix these things up in FFmpeg and it would be a
>>>>>>>> pity to let it go to waste again.
>>>>>>> feel free to improve the precommit check script
>>>>>> I have to say, this attitude of yours is starting to get quite tiresome.
>>>>> Very much so.  I don't understand why you are such a complete perfectionist
>>>>> about what code is acceptable for FFmpeg and at the same time disregard
>>>>> the quality of the (Doxygen) documentation.
>>> because "dont" is as readable with as well as without some little speck
>>> between n and t, buggy, slow, bloated, ... code though has a quite noticeable
>>> effect, take a look at our bugtracker how many bugs are there about spelling
>>> and grammer and how many are there about other things
>>
>> There have been numerous (as in infinite) complaints about lack of FFmpeg
>> documentation, both developer docs and user docs.
>>
>> "Dont" may be as readable to you as "do not" and maybe it is to others
>> that have gotten used to reading your prose, but it sure does not extend
>> to the general case.  Especially not to people with poor English skill.
>> Unfortunately most readers are not native speakers and have to struggle
>> quite a bit to understand even good written English.
>
> Nonetheless, I prefer using "don't" than "do not", and "it's" than "it
> is", and I'd like to be able to write this way in commit logs if
> possible. I think it is reasonable.
>
> Is it ok ?

I'm fine with that, as long as you apostrophise correctly.

-- 
M?ns Rullg?rd
mans at mansr.com