[FFmpeg-devel] [PATCH] doc: update loglevel option documentation

[Lou Logan]

On Tue, Apr 3, 2018, at 12:30 AM, Tobias Rapp wrote:
> Updates documentation after the changes to loglevel flag prefix parsing
> in 4b736bc921ed96ad6d312ce0cbe0de29b9e3fe81.
> 
> Signed-off-by: Tobias Rapp <t.rapp at noa-archive.com>
> ---
>  doc/fftools-common-opts.texi | 26 ++++++++++++++++++--------
>  1 file changed, 18 insertions(+), 8 deletions(-)
[..]
> +Flags can also be used alone by adding a '+'/'-' prefix to set/reset a
> +single flag without affecting other flags or changing the log level. When
> +setting both, flags and level, a '+' separator is expected between last
> +flag and before level.

Confusing. We have the  "-loglevel" option itself, the "level" flag to add the current loglevel prefix to the message line (I would have preferred if it were named "prefix"), the "loglevel" value, and we also use the generic phrase "log level" in the docs.

Also potentially confusing is that the "-/+" prefix is used to set/reset individual flags, but "+" is also used as the separator between flags and loglevel.

Your quoted paragraph above is unclear to me. Correct me if I'm wrong, but I'm thinking it should be worded something like:

Flags can also be used alone by adding a '+'/'-' prefix to set/reset a
single flag without affecting other @var{flags} or changing @var{loglevel}. When
setting both @var{flags} and @var{loglevel}, a '+' separator is expected between the last
@var{flags} value and before @var{loglevel}.

Lastly, an example utilizing all flags and loglevel will make usage much more clear for general users.