[FFmpeg-devel] [PATCH] doc/filters: update documentation

[Clément Bœsch]

On Wed, Jul 11, 2012 at 05:48:22PM +0200, Stefano Sabatini wrote:
> In particular, assume existence of audio and sink filters.
> ---
>  doc/filters.texi |   13 ++++++-------
>  1 files changed, 6 insertions(+), 7 deletions(-)
> 
> diff --git a/doc/filters.texi b/doc/filters.texi
> index 4332fd3..d3aab95 100644
> --- a/doc/filters.texi
> +++ b/doc/filters.texi
> @@ -33,22 +33,21 @@ ffmpeg -i input -vf "[in] split [T1], fifo, [T2] overlay=0:H/2 [out]; [T1] fifo,
>  The result will be that in output the top half of the video is mirrored
>  onto the bottom half.
>  
> -Video filters are loaded using the @var{-vf} option passed to
> +Filters are loaded using the @var{-vf} and @var{-af} option passed to
>  @command{ffmpeg} or to @command{ffplay}. Filters in the same linear
>  chain are separated by commas. In our example, @var{split, fifo,
>  overlay} are in one linear chain, and @var{fifo, crop, vflip} are in
>  another. The points where the linear chains join are labeled by names
>  enclosed in square brackets. In our example, that is @var{[T1]} and
> - at var{[T2]}. The magic labels @var{[in]} and @var{[out]} are the points
> + at var{[T2]}. The labels @var{[in]} and @var{[out]} are the points

Maybe you should say "special" if you don't like harry potter. It looks
important to specify they are specific labels.

>  where video is input and output.
>  
>  Some filters take in input a list of parameters: they are specified
> -after the filter name and an equal sign, and are separated each other
> -by a semicolon.
> +after the filter name and an equal sign.
>  
> -There exist so-called @var{source filters} that do not have a video
> -input, and we expect in the future some @var{sink filters} that will
> -not have video output.
> +There exist so-called @var{source filters} that do not have an
> +audio/video input, and @var{sink filters} that will not have audio/video
> +output.
>  

LGTM otherwise.

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20120711/8ee1f94b/attachment.asc>