[FFmpeg-devel] [PATCH] doc/encoders: Add a note for x264 options that use colon

[Stefano Sabatini]

On date Sunday 2012-11-25 06:55:25 +0400, Ivan Pozdeev encoded:
> fef0b37152291254cb4d0141a266f3e31279c6e9
>  doc/encoders.texi |    3 +++
>  1 files changed, 3 insertions(+), 0 deletions(-)
> 
> diff --git a/doc/encoders.texi b/doc/encoders.texi
> index c37f256..9c7dec1 100644
> --- a/doc/encoders.texi
> +++ b/doc/encoders.texi
> @@ -627,6 +627,9 @@ For example to specify libx264 encoding options with @command{ffmpeg}:
>  ffmpeg -i foo.mpg -vcodec libx264 -x264opts keyint=123:min-keyint=20 -an out.mkv
>  @end example
>  

> +For @var{filter} and @var{psy-rd} options that use ":" themselves, use "," instead.
> +They accept it as well since long ago but this is kept undocumented for some reason.
> +

The context of this sentence is not very clear. I'd put the sentence
just below the x264opts entry, something like:

@item x264opts @var{options}
Allow to set any x264 option, see x264 --fullhelp for a list.

@var{options} is a list of @var{key}=@var{value} couples separated by
":". For @var{filter} and @var{psy-rd} options that use ":"
themselves, use "," instead. They accept it as well since long ago but this
is kept undocumented for some reason.

...

Alternatively we may consider escaping as another possibly safer
alternative. Also updating x264 upstream documentation may be useful.

Thanks.
-- 
FFmpeg = Faithless and Faithless Martial Peaceless Eager Ghost