[FFmpeg-cvslog] r15316 - trunk/doc/swscale.txt

[Ramiro Polla]

Ramiro Polla wrote:
> Michael Niedermayer wrote:
>> On Sun, Sep 14, 2008 at 12:37:11AM -0300, Ramiro Polla wrote:
>>> michael wrote:
>>>> Author: michael
>>>> Date: Sun Sep 14 04:38:47 2008
>>>> New Revision: 15316
>>>>
>>>> Log:
>>>> The official guide to swscale for confused developers.
>>> Is this supposed to confuse the developers? =)
>> No, it was supposed to help confused developers.
>>
>>
>>> I wanted to fix some typos I saw on the first few lines, but by the time 
>>> I got to the end, I was so scared I didn't know where to start... I 
>>> think this should be sent to ffmpeg-devel for review before diego and 
>>> everyone else starts committing fixes for the myriad of low-hanging 
>>> typos... They're not only cosmetical-like typos, but they render some 
>>> parts incomprehensible.
>> If you tell me what parts are incomprehensible i can try to improve them.
> 
> [...]
>> +Main path
>> +    The main path is used when no special converter can be used, the code
>> +    is designed as a destination line pull architecture.
> 
>  > That is for each
>> +    output line the vertical scaler pulls lines from a ring buffer that
>> +    when the line is unavailable pulls it from the horizontal scaler and
>> +    input converter of the current slice.
> 
> "...a ring buffer that when the line is unavailable pulls it..."? I 
> think you meant "...a ring buffer, and when the line is unavailable 
> pulls it...".
> 
>> +    When no more output can be generated as lines from a next slice would
>> +    be needed then all remaining lines in the current slice are converted
>> +    and horizontally scaled and put in the ring buffer.
> 
> I see now that a pair of commas would ease the understanding of this 
> part a lot (if that's what you meant):
> 
> When no more output can be generated, as lines from a next slice would 
> be needed, then all remaining lines in the current slice are converted 
> and horizontally scaled and put in the ring buffer.
> 
> Those are the only two IMO that require closer inspection to understand 
> the sentence itself.  The rest is trivial...

And here is a patch to for what else I could find. It mainly adds a 
bunch of punctuation, splits long sentences (I think it's more readable 
this way, what do other people think of it?), and changes an "its" to 
"it is".
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: swscale.diff
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-cvslog/attachments/20080914/db625d7c/attachment.asc>