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

[Alexander Strasser]

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.

  Applies to the following hunks too.

>  @var{filter_graph} is a description of the filter graph to apply to
> -the stream. Use @code{-filters} to show all the available filters
> -(including also sources and sinks).
> +the stream, and must have a single input and a single output of the
> +same type of the stream. In the filtergraph, the input is associated
                                   ^^^^^^^^^^^
  I would say filter graph instead.

> +to the label @code{in}, and the output to the label @code{out}. See
> +the ffmpeg-filters manual for more information about the filtergraph
> +syntax.
> +
> +Use @code{-filters} to show all the available filters (including also
> +sources and sinks).
>  
>  See also the @option{-filter_complex} option if you want to create filter graphs
>  with multiple inputs and/or outputs.

[...]

  LGTM

  Alexander