[FFmpeg-devel] [PATCH] doc/ffmpeg: fix/extend documentation for the -filter option

[Stefano Sabatini]

On date Saturday 2013-01-12 18:04:21 +0100, Alexander Strasser encoded:
> Stefano Sabatini wrote:
> > On date Saturday 2013-01-12 03:54:16 +0100, Alexander Strasser encoded:
> > > Hi Stefano!
> > > 
> > > Stefano Sabatini wrote:
> > > > ---
> > > >  doc/ffmpeg.texi |   26 +++++++++++++++-----------
> > > >  ffmpeg_opt.c    |    6 +++---
> > > >  2 files changed, 18 insertions(+), 14 deletions(-)
> > > > 
> > > > diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
> > > > index 57c5a1c..c39afe3 100644
> > > > --- a/doc/ffmpeg.texi
> > > > +++ b/doc/ffmpeg.texi
> > > > @@ -334,10 +334,18 @@ Stop writing to the stream after @var{framecount} frames.
> > > >  Use fixed quality scale (VBR). The meaning of @var{q} is
> > > >  codec-dependent.
> > > >  
> > > > + at anchor{filter_option}
> > > >  @item -filter[:@var{stream_specifier}] @var{filter_graph} (@emph{output,per-stream})
> > > > +Create a filtergraph and use it to filter the stream.
> > > 
> > >   May I suggest to use:
> > >   "Create @var{filter_graph} and use it to filter the stream."
> > > 
> > >   If you do not like it, IMHO please use filter graph instead of filtergraph.
> > 
> > Adopted a different another variant.
> > 
> [...]
> >  
> > + at anchor{filter_option}
> >  @item -filter[:@var{stream_specifier}] @var{filter_graph} (@emph{output,per-stream})
> > +Create a filter graph specified by @var{filter_graph} and use it to
> > +filter the stream.
> 
>   It's OK but it would be more logical to use "_the_ filter graph specified..."
> as it is the filter graph specified by the user and not just any graph.
> 
>   Note that I tried to avoid the long construction with the redundant
> mentioning of filter graph. I was sure the reader would instantly see
> that the placeholder named filter_graph represents a, ehm, filter graph :)
> 
>   [...]
> 
>   Should be good enough now!

Applied with the suggested change, thanks for the review.
-- 
FFmpeg = Faithless and Faithless MultiPurpose Eretic Gospel