[FFmpeg-devel] [PATCH 02/12] doc: Explain the various logevel settings

[Stefano Sabatini]

On date Saturday 2013-03-30 15:32:49 -0400, Derek Buitenhuis encoded:
> Signed-off-by: Derek Buitenhuis <derek.buitenhuis at gmail.com>
> ---
>  doc/avtools-common-opts.texi |   13 +++++++++++++
>  1 file changed, 13 insertions(+)
> 
> diff --git a/doc/avtools-common-opts.texi b/doc/avtools-common-opts.texi
> index 111812d..7ee41c7 100644
> --- a/doc/avtools-common-opts.texi
> +++ b/doc/avtools-common-opts.texi
> @@ -120,13 +120,26 @@ Set the logging level used by the library.
>  @var{loglevel} is a number or a string containing one of the following values:
>  @table @samp
>  @item quiet
> +Show nothing at all; be silent.

>  @item panic
> +Deprecated. Does nothing.

Tool docs are not the place where to deprecate symbols.

libavutil/log.h
/**
 * Something went really wrong and we will crash now.
 */
#define AV_LOG_FATAL

Translated to English this could sound like:

@item panic
Only show critical errors leading to the crash of the process.

>  @item fatal
> +Only show fatal errors. These are errors after which the process absolutely
> +cannot continue after.

Technically not correct, since this will also show panic errors (and
in general log messages with a lower level).

Possibly more correct, but longer:

Only show fatal errors, in addition to the ones shown with
@samp{panic}. These are errors after which the process absolutely
cannot continue after.

>  @item error
> +Show all errors. These errors will cause problems, but the process can
> +recover and continue.

Ditto.

>  @item warning
> +Show all warnings and errors. Anything that doesn't go quite right shall
> +be shown.

"Doesn't go quite right" is a bit vague. I suggest:

Show all warnings and errors. Any message related to possibly
incorrect or unexpected events will be shown.


>  @item info
> +Show information from libavcodec, libavformat, and other libraries during
> +processing, if they provide it. This is in addition to warnings and errors.
> +This is the default value.
>  @item verbose
> +Same as @code{info}, except more verbose.
>  @item debug
> +Show everything, including debugging information.
>  @end table

Thanks for working on this.
-- 
FFmpeg = Formidable & Forgiving Mere Portable Erratic Gem