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

2019-02-22 Thread Lou Logan
On Fri, Feb 22, 2019, at 4:57 AM, Nicolas George wrote: > > That would be an argument for using something way more specific than a > dash. Like what? Do you have an example? > Anyway, that kind of marking would belong in the definition of the macro > @option, not in the body of the documentation.

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

2019-02-22 Thread Lou Logan
On Fri, Feb 22, 2019, at 4:21 AM, Nicolas George wrote: > > There are other users than API and command-line. Think of a GUI that > presents all options as editable fields. That seems like an empty argument. Which GUI? Do you have an example? I don't see how some unnamed third-party GUI should hav

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

2019-02-22 Thread Lou Logan
On Fri, Feb 22, 2019, at 2:29 AM, Nicolas George wrote: > > 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 d

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

2019-02-22 Thread Tobias Rapp
On 22.02.2019 14:57, Nicolas George wrote: Gyan (12019-02-22):     '-key'  will be easier to search for these users as well. It's also a low-cost arrangement. I trust adept API users will quickly suss out that the hyphen represents CLI. GUI users won't be entering the key string, only the value

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

2019-02-22 Thread Nicolas George
Gyan (12019-02-22): >     '-key'  will be easier to search for these users as well. It's also a > low-cost arrangement. I trust adept API users will quickly suss out that the > hyphen represents CLI. GUI users won't be entering the key string, only the > values*, and casual CLI users will immediate

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

2019-02-22 Thread Gyan
On 22-02-2019 06:50 PM, Nicolas George wrote: Tobias Rapp (12019-02-22): 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 fr

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

2019-02-22 Thread Nicolas George
Tobias Rapp (12019-02-22): > 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 example

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

2019-02-22 Thread Tobias Rapp
On 22.02.2019 12:43, Hendrik Leppkes wrote: On Fri, Feb 22, 2019 at 12:29 PM Nicolas George wrote: Lou Logan (12019-02-21): For consistency. Fixes #7740. Signed-off-by: Lou Logan I do not think this is correct: the dash is not part of the option name, it is part of the Unix command-line t

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

2019-02-22 Thread Hendrik Leppkes
On Fri, Feb 22, 2019 at 12:29 PM Nicolas George wrote: > > Lou Logan (12019-02-21): > > For consistency. Fixes #7740. > > > > Signed-off-by: Lou Logan > > 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

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

2019-02-22 Thread Nicolas George
Lou Logan (12019-02-21): > For consistency. Fixes #7740. > > Signed-off-by: Lou Logan 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 "opt

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

2019-02-22 Thread Gyan
On 22-02-2019 06:12 AM, Lou Logan wrote: For consistency. Fixes #7740. Signed-off-by: Lou Logan --- Does this need to be checked for errant added hypens, like before entries in a value table? If not, LGTM. Gyan ___ ffmpeg-devel mailing list ffm