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

[Derek Buitenhuis]

On 2013-03-30 5:05 PM, Stefano Sabatini wrote:
>>  @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.

Problem is, this isn't even true. It's literally used nowhere in Libav, and ONLY
in vf_sub, as a proxy for libass's warning levels. This is just a lie.

>>  @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).

Panic errors don't actually exist in the codebase.

> 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.

See above.

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

See above.

>>  @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.

Fixed locally.

>>  @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.

o/

- Derek