[FFmpeg-trac] #2332(documentation:closed): Better documenting of boolean options

FFmpeg trac at avcodec.org
Sun Mar 10 13:52:31 CET 2013

#2332: Better documenting of boolean options
             Reporter:  burek        |                    Owner:
                 Type:  enhancement  |                   Status:  closed
             Priority:  wish         |                Component:
              Version:  unspecified  |  documentation
             Keywords:               |               Resolution:  fixed
             Blocking:               |               Blocked By:
Analyzed by developer:  1            |  Reproduced by developer:  1
Changes (by saste):

 * analyzed:  0 => 1
 * status:  reopened => closed
 * resolution:   => fixed
 * reproduced:  0 => 1


 Replying to [comment:2 saste]:
 > Replying to [ticket:2332 burek]:
 > > This will help users who get to the docs page and use CTRL+F to just
 find the option they are interested in, without reading the documentation
 page like a book, from the beginning to the end (hence, they usually skip
 the intro part that explains the "-nofoo" logic).
 > Most boolean options are off by default, so it is clear that selecting
 -foo will enable it. For the few options which are on by default, we may
 mention that -nofoo will disable the options, like it is done for example
 with -stdin. This seems easier, requires less doc churnup and addresses
 the problem for a lazy user grepping for -nostats.

 Partially fixed in:
 commit f185a040b0d5f6766c8016cc84b415d414d38246
 Author: Stefano Sabatini <stefasab at gmail.com>
 Date:   Sun Mar 10 11:51:00 2013 +0100

     doc/ffplay,ffmpeg: mention the corresponding negated option for -stats

     This helps lazy users who didn't read the part about boolean options,
     case they grep for "-nostats".

     -stdin and -stats are the only booleans option enabled by default.
     is a partial fix for Trac ticket #2332, a complete overhaul of boolean
     options documentation is probably overkill.

Ticket URL: <https://ffmpeg.org/trac/ffmpeg/ticket/2332#comment:4>
FFmpeg <http://ffmpeg.org>
FFmpeg issue tracker

More information about the FFmpeg-trac mailing list