[FFmpeg-devel] [PATCH] doc: add missing hyphen prefix

[Tobias Rapp]

On 22.02.2019 12:43, Hendrik Leppkes wrote:
> On Fri, Feb 22, 2019 at 12:29 PM Nicolas George <george at nsup.org> wrote:
>>
>> Lou Logan (12019-02-21):
>>> For consistency. Fixes #7740.
>>>
>>> Signed-off-by: Lou Logan <lou at lrcd.com>
>>
>> I do not think this is correct: the dash is not part of the option name,
>> it is part of the Unix command-line tradition. For consistency, it
>> should be removed when it is there, possibly replaced by the word
>> "option" if necessary.
>>
> 
> I agree. You don't pass the dash when yo use avoptions through API,
> for example, so this would only add to the confusion.

In my understanding the main source of documentation for API users are 
the Doxygen HTML output files while the Texinfo output is for both, 
command-line and API users -- with a slight bias towards command-line, 
at least from looking at all the ffmpeg/ffplay examples.

The current dash prefixes allow me to jump to specific options more 
easily (Ctrl+F "-b" for example). I agree that this is not a strong 
argument, but wanted to mention it anyway :-)

Regards,
Tobias