[FFmpeg-devel] [PATCH 2/4] doc/protocols: update options

[Andriy Gelman]

On Sat, 10. Apr 12:40, Gyan Doshi wrote:
> 
> 
> On 2021-04-10 11:45, Andriy Gelman wrote:
> > On Sun, 15. Nov 13:20, Andriy Gelman wrote:
> > > From: Andriy Gelman <andriy.gelman at gmail.com>
> > > 
> > > Define listen_timeout. Set user-agent and timeout to deprecated.
> > > 
> > > Signed-off-by: Andriy Gelman <andriy.gelman at gmail.com>
> > > ---
> > >   doc/protocols.texi | 13 +++++++++++--
> > >   1 file changed, 11 insertions(+), 2 deletions(-)
> > > 
> > > diff --git a/doc/protocols.texi b/doc/protocols.texi
> > > index b4efa14509..fd866f57a5 100644
> > > --- a/doc/protocols.texi
> > > +++ b/doc/protocols.texi
> > > @@ -1102,11 +1102,16 @@ Set minimum local UDP port. Default value is 5000.
> > >   Set maximum local UDP port. Default value is 65000.
> > >   @item timeout
> > > -Set maximum timeout (in seconds) to wait for incoming connections.
> > > +This option is deprecated. Use @option{listen_timeout} instead. Set maximum timeout (in seconds) to wait for incoming connections.
> > >   A value of -1 means infinite (default). This option implies the
> > >   @option{rtsp_flags} set to @samp{listen}.
> > > + at item listen_timeout
> > > +Set maximum timeout (in seconds) to establish an initial connection. Setting
> > > + at samp{listen_timeout} > 0 sets @option{rtsp_flags} to @samp{listen}. Default is -1
> > > +which means an infinite timeout when @samp{listen} mode is set.
> > > +
> > >   @item reorder_queue_size
> > >   Set number of packets to buffer for handling of reordered packets.
> > > @@ -1114,7 +1119,11 @@ Set number of packets to buffer for handling of reordered packets.
> > >   Set socket TCP I/O timeout in microseconds.
> > >   @item user-agent
> > > -Override User-Agent header. If not specified, it defaults to the
> > > +This option is deprecated. Use @option{user_agent} instead. Override User-Agent header. If not specified, it defaults to the
> > > +libavformat identifier string.
> > > +
> > > + at item user_agent
> > > +User-Agent header. If not specified, it defaults to the
> > >   libavformat identifier string.
> > >   @end table
> > Because user-agent will be removed soon. Is it even worth updating the
> > documentation for user-agent and timeout?
> > or should I resend with only the listen_timeout added?

> 
> Let it be. If users can set it, they may want to look it up.
> We'll remove it some time after when the option's gone.
> 

Thanks, I've applied the patch.

-- 
Andriy