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

Alexander Strasser eclipse7 at gmx.net
Wed Sep 25 00:12:32 CEST 2013

On 2013-09-24 11:02 +0200, Stefano Sabatini wrote:
> On date Monday 2013-09-23 17:22:18 -0700, Timothy Gu encoded:
> > On Monday, September 23, 2013, Alexander Strasser wrote:
> [...]
> > >   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.
> Let me note that this would complicate the build system (you need to
> write an index of the filters).

  Agreed; complexity should be limited though.

> Not that this would be particularly
> difficult, but I would like to know which problems this would address
> rather than doing changes for their own sake.

  It makes every filter documentation source easily accessible. This
makes it comfortable to read and edit the source for the filter one
is interested in at any time. It simplifies all kinds of things like
doing side-by-side comparisons or comparing documentation length of
the various filters. Last but not least it avoids creating giant length

> Also in that case there would be no reason to do it *only* for filters
> (filters are not special).

  Well, who said it should be done *only* for filters. Ideally it should
be done for all components where we run into the same problem. The point
is that documentations for filters is necessary and very helpful and
very large ATM. But it isn't large enough yet. We will see more filters
and there is room for improvement for the filters we have already.

  So wouldn't you agree that the filter collection is kind of special
in regard to documentation compared to all other component collections?

  Having said that I still believe my proposal is not without problems
and I hope I made that clear right from the start.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 198 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20130925/f38db1c6/attachment.asc>

More information about the ffmpeg-devel mailing list