[FFmpeg-devel] [RFC]Slightly extend the -r input option documentation

[Carl Eugen Hoyos]

On Monday 16 June 2014 07:49:34 pm Lou Logan wrote:
> On Mon, 16 Jun 2014 17:18:23 +0200, Carl Eugen Hoyos wrote:
> > diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
> > index 68fd12f..5a6e74b 100644
> > --- a/doc/ffmpeg.texi
> > +++ b/doc/ffmpeg.texi
> > @@ -473,6 +473,8 @@ Set frame rate (Hz value, fraction or abbreviation).
> >
> >  As an input option, ignore any timestamps stored in the file and instead
> >  generate timestamps assuming constant frame rate @var{fps}.
> > +This is not the same as the framerate option used for some input formats
> > +(it used to be the same in older versions of FFmpeg).
>
> A sentence explaining the difference would be informative.

I can't really explain, instead I added a line that in doubt, 
users should use -framerate.
Better suggestions welcome!

> Otherwise, I 
> can only comment on the doc formatting:
>
>   This is not the same as the @option{-framerate} option...
>
> Or whatever texinfo command you think is appropriate.

I tried to implement the other comments.

Thank you, Carl Eugen
-------------- next part --------------
diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index 68fd12f..6f3c2c3 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -473,6 +473,9 @@ Set frame rate (Hz value, fraction or abbreviation).
 
 As an input option, ignore any timestamps stored in the file and instead
 generate timestamps assuming constant frame rate @var{fps}.
+This is not the same as the @option{-framerate} option used for some input formats
+like image2 or v4l2 (it used to be the same in older versions of FFmpeg).
+If in doubt use @option{-framerate} instead of the input option @option{-r}.
 
 As an output option, duplicate or drop input frames to achieve constant output
 frame rate @var{fps}.