[FFmpeg-devel] [PATCH] -fs parameter human friendly

[The Wanderer]

Michael Niedermayer wrote:

> On Mon, Aug 11, 2008 at 11:43:53PM +0200, Stefano Sabatini wrote:

>> + * Values are expressed in
>> + * bits, unless the 'B' postfix is used, in this case the values are
>> + * assumed to be in bytes.
> 
> what?

I would read this as meaning "if a value does not have the 'B' suffix,
it is assumed to be expressed in bits; if it does have that suffix, it
is assumed to be expressed in bytes". The current phrasing seems
relatively clear to me (even in my current mildly bleary state of mind),
although I would say "in which case" instead of "in this case".

>> + * @param tail if non-NULL put at this address the pointer to the
>> + * character just after the part of the string successfully parsed
> 
> parse error

I interpret this as meaning something like "if the 'tail' parameter is
not NULL, then after the function returns, dereferencing that pointer
will give a pointer to the first character 'name' parameter which was
not parsed into the return value". I'm not sure offhand of how to
rephrase it for better clarity without getting inappropriately verbose,
particularly since it reads fairly comprehensibly to me as it stands.

>> + * @return the value of the parsed string as a numer of bits
> 
> numer!? bits?

"number", obviously - and I interpret this as meaning that the return
value will always be expressed in bits, no matter what units the input
string used for its number.

-- 
       The Wanderer

Warning: Simply because I argue an issue does not mean I agree with any
side of it.

Secrecy is the beginning of tyranny.