[FFmpeg-devel] [PATCH] doc/ffplay, ffmpeg: mention the corresponding negated option for -stats

[Clément Bœsch]

On Sun, Mar 10, 2013 at 11:56:23AM +0100, Stefano Sabatini wrote:
> This helps lazy users who didn't read the part about boolean options, in
> case they grep for "-nostats", which is together with "-nostdin" the only
> boolean option enabled by default.
> 
> This is a partial fix for Trac ticket #2332, a complete overhaul of
> boolean docs is probably overkill.
> ---
>  doc/ffmpeg.texi |    3 ++-
>  doc/ffplay.texi |    8 ++++++--
>  2 files changed, 8 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
> index 7563107..d52df9b 100644
> --- a/doc/ffmpeg.texi
> +++ b/doc/ffmpeg.texi
> @@ -361,7 +361,8 @@ want to create filter graphs with multiple inputs and/or outputs.
>  Specify the preset for matching stream(s).
>  
>  @item -stats (@emph{global})
> -Print encoding progress/statistics. On by default.
> +Print encoding progress/statistics. It is on by default, to explicitly
> +disable it you need to specify @code{-nostats}.
>  
>  @item -progress @var{url} (@emph{global})
>  Send program-friendly progress information to @var{url}.
> diff --git a/doc/ffplay.texi b/doc/ffplay.texi
> index 8d6abee..5f17902 100644
> --- a/doc/ffplay.texi
> +++ b/doc/ffplay.texi
> @@ -93,9 +93,13 @@ Read @var{input_file}.
>  @item -pix_fmt @var{format}
>  Set pixel format.
>  This option has been deprecated in favor of private options, try -pixel_format.
> +
>  @item -stats
> -Show the stream duration, the codec parameters, the current position in
> -the stream and the audio/video synchronisation drift.
> +Print several playback statistics, in particular show the stream
> +duration, the codec parameters, the current position in the stream and
> +the audio/video synchronisation drift. It is on by default, to
> +explicitly disable it you need to specify @code{-nostats}.
> +
>  @item -bug
>  Work around bugs.
>  @item -fast

Fine with me.

-- 
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/20130310/a1142f38/attachment.asc>