[FFmpeg-devel] [PATCH] doc/demuxers/mpegts: update documentation

[Michael Niedermayer]

On Fri, Aug 14, 2015 at 11:15:43AM +0200, Stefano Sabatini wrote:
> On date Friday 2015-08-14 00:16:31 +0200, Michael Niedermayer encoded:
> > On Thu, Aug 13, 2015 at 01:26:30PM +0200, Stefano Sabatini wrote:
> > > The description is yet crappy, it merely copies the description of the
> > > added and undocumented options and their value range. More descriptive
> > > documentation is welcome.
> > > ---
> > >  doc/demuxers.texi | 19 +++++++++++++++++++
> > >  1 file changed, 19 insertions(+)
> > > 
> > > diff --git a/doc/demuxers.texi b/doc/demuxers.texi
> > > index e45e1af..e4f5f8f 100644
> > > --- a/doc/demuxers.texi
> > > +++ b/doc/demuxers.texi
> > > @@ -414,13 +414,32 @@ ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
> > >  
> > >  MPEG-2 transport stream demuxer.
> > >  
> > > +This demuxer accepts the following options:
> > >  @table @option
> > > + at item resync_size
> > > +Set size limit for looking up a new synchronization. Default value is
> > > +65536.
> > >  
> > >  @item fix_teletext_pts
> > >  Overrides teletext packet PTS and DTS values with the timestamps calculated
> > >  from the PCR of the first program which the teletext stream is part of and is
> > >  not discarded. Default value is 1, set this option to 0 if you want your
> > >  teletext packet PTS and DTS values untouched.
> > > +
> > > + at item ts_packetsize
> > > +Output option carrying the raw packet size in bytes.
> > > +Show the detected raw packet size, cannot be set by the user.
> > > +
> > 
> > > + at item scan_all_pmts
> > > +Scan and combine all PMTs. The value is an integer with value from -1
> > > +to 1, default value is -1.
> > 
> > -1 -> auto
> > 1 -> enabled
> > 0->disabled
> > 
> > > + at item skip_changes
> > > +Skip changing / adding streams / programs when set to 1.
> > > +Default value is 0.
> > > +
> > > + at item skip_clear
> > > +Skip clearing programs if set to 1. Default value is 0.
> > >  @end table
> > 
> 
> > these 2 are intended to be used internally by libavformat
> > i guess applications could use them too but they are not marked as
> > demuxer or muxer options and they arent in the help output presented
> > to users
> 
> Uhm, so I think I'll skip them.
> 
> Thanks, updated.
> -- 
> FFmpeg = Faithless and Fierce Multipurpose Power Exuberant Gymnast

>  demuxers.texi |   13 +++++++++++++
>  1 file changed, 13 insertions(+)
> 69139cef59232f0c319defb217a375194acba585  0002-doc-demuxers-mpegts-update-documentation.patch
> From 81cbdd00f9a2ce5a2a8ec6666e6148315e4255ec Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefasab at gmail.com>
> Date: Thu, 13 Aug 2015 13:19:20 +0200
> Subject: [PATCH] doc/demuxers/mpegts: update documentation
> 
> The description is yet crappy, it merely copies the description of the
> added and undocumented options and their value range. More descriptive
> documentation is welcome.
> ---
>  doc/demuxers.texi | 13 +++++++++++++
>  1 file changed, 13 insertions(+)

LGTM

for scan_all_pmts, named identifers could be added, thats unrelated
to this patch though

thanks


[...]

-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

No human being will ever know the Truth, for even if they happen to say it
by chance, they would not even known they had done so. -- Xenophanes
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 181 bytes
Desc: Digital signature
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20150814/13ccf57f/attachment.sig>