[FFmpeg-devel] [PATCH] Document the preset files system

[The Wanderer]

Stefano Sabatini wrote:

> On date Wednesday 2008-10-01 19:20:28 -0400, The Wanderer encoded:
> 
>> Stefano Sabatini wrote:

> I also reworded other parts of the paragraph, please check it again.

> +If no such file is found applying the previous rule, then ffmpeg will

It looks like I wasn't clear about this. I meant "If no such file is
found, then ffmpeg will" et cetera; the phrase "applying the previous
rule" is what looked awkward, and what I was trying to avoid.

> +search for a file named @var{codec_name}- at var{arg}.ffpreset in the
> +above-mentioned directories, where @var{codec_name} is the name of the
> +currently selected codec with the codec type specified by the preset
> +option. For example, if you selected the video codec with
> + at code{-vcodec libx264} and @code{-vpre max} is used, then it will
> +search for the file @file{libx264-max.ffpreset}.

How does the preset option specify the codec type? I don't think it
does, and this seems confusing to me. If you really think mentioning how
the currently-selected codec is specified (that is, 'where it comes
from') is important, I'd suggest something like "the currently selected
codec (either the default codec or the one specified on the command
line)", but that seems unwieldy to me and it might be better to just
remove the part of the sentence after "currently selected codec".

There's something awkward about the "is used", but nothing I'm coming up
with in short order is being significantly better, and it's not worth
holding up the patch over IMO.

> +Finally, if the above rules failed and the argument specifies an
> +absolute pathname, it will search for that filename. This way you can
> +specify the absolute and complete filename of the preset file, for
> +example @file{./ffpresets/libx264-max.ffpreset}.

The use of "it" here when both previous paragraphs used "ffmpeg" seems a
touch odd. There's nothing grammatically wrong with it (although it
would be possible to argue that the antecedent would be "the argument"
rather than "ffmpeg"), but I think keeping these parallel might be
better.

-- 
       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.