[FFmpeg-devel] [PATCH] doc: add a tutorial for writing filters.

[Clément Bœsch]

On Sun, May 18, 2014 at 10:39:18PM +0200, Stefano Sabatini wrote:
> On date Saturday 2014-05-17 14:20:21 +0200, Clément Bœsch encoded:
> > ---
> >  doc/writing_filters.txt | 424 ++++++++++++++++++++++++++++++++++++++++++++++++
> 
> Foreword: this is much appreciated, I have a vague feeling that we
> should keep it in the wiki or it would be painful to keep it updated
> when the API changes.
> 

The logic I was following is that the need for updating this document when
an API change occurs is more likely to not be missed if it's tracked into
the repository. For example, if ff_get_video_buffer() is going to change,
the developer changing the code will likely git grep the symbol and ends
up in that file. AFAIK, every wiki doc gets pretty quickly outdated when
it's not the main documentation source. Especially when related to code.

> Note that we already have a filter design document, so I would rather
> put the effort of the keeping this one updated on the community rather
> than on the developers (OTOH the design document should be updated by
> developers).

That's right, we have filter_design.txt, but while it definitely has some
qualities, it hasn't the same purpose. I was trying here to provide the
fastest way of getting new developers to work on a template without
the need to try to pick up the pieces by themselves.

BTW, I think the reference permissions section in filter_design.txt is to
the best outdated.

[...]

Your comments are honored locally, thanks

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <https://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20140518/5f7606c7/attachment.asc>