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

[Stefano Sabatini]

On date Friday 2008-10-03 07:15:53 -0400, The Wanderer encoded:
> 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.

Yes, indeed we can avoid that.
 
> > +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.

The codec type of the preset is detected by the first character of the
preset option (a/v/s). I'm mentioning this in the documentation now.

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

I changed it to:
"the codec to which the preset file options will be applied"

now that I explain how the target codec is selected above.

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

I changed the verbs forms from "selected ... is used" to "select
... use", now it sounds slightly better to my non-native English ears.

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

Yes, good catch.

Thanks, regards.
-- 
FFmpeg = Foolish & Free Meaningful Patchable Ecumenical Glue
-------------- next part --------------
A non-text attachment was scrubbed...
Name: document-preset-03.patch
Type: text/x-diff
Size: 1996 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20081004/cf502a77/attachment.patch>