[FFmpeg-devel] [PATCH 3/3] doc/filters: Refractor

Timothy Gu timothygu99 at gmail.com
Tue Sep 24 02:22:18 CEST 2013


On Monday, September 23, 2013, Alexander Strasser wrote:

> On 2013-09-22 15:56 -0700, Timothy Gu wrote:
> > On Sun, Sep 22, 2013 at 3:14 PM, Paul B Mahol <onemda at gmail.com<javascript:;>>
> wrote:
> > > On 9/22/13, Stefano Sabatini <stefasab at gmail.com <javascript:;>>
> wrote:
> > >> Typo in the subject, also it could be more descriptive
> > >> (e.g. doc/filters: split filters.texi into several dedicated
> > >> files).
> > >>
> > >> Also, we're used not to upcase the first word after the module name.
> > >>
> > >> On date Saturday 2013-09-21 15:39:37 -0700, Timothy Gu encoded:
> > >>> I am not sure if anyone would want to deal with an 10000-line file,
> > >>> bigger
> > >>> than virtually every file in libavcodec (except for some data table
> > >>> files).
> > >>>
> > >>> Signed-off-by: Timothy Gu <timothygu99 at gmail.com <javascript:;>>
> > >>> ---
> > >>> Michael, will this work for you for the merging?
> > >>>
> > >>> The patch is too big to be sent this way. If anyone is interested,
> the
> > >>> whole
> > >>> thing is attached as MIME.
> > >>
> > >> Not against if Michael is fine with it.
> > >
> > > Now each time I need to read/add/fix/modify/improve/extend filter
> documentation
> > > I will need to think twice which file to open.
> >
> > It is already this case for codecs and (de)muxers.
>
>   A quick random and stupid idea:
>   Make a sub dir and put a file <name>.texi in it for each filter.
>
>   Please flame me before someone actually tries it.


I don't think this is stupid, but IMO the *optimal* way of documenting such
a complicated project like FFmpeg. But it is extremely hard for merging
from the fork.

[...]

Timothy


More information about the ffmpeg-devel mailing list