[FFmpeg-devel] [PATCH] Add vfilters.texi to documentation

[Michael Niedermayer]

On Thu, Oct 08, 2009 at 12:52:20AM +0200, Stefano Sabatini wrote:
> On date Wednesday 2009-10-07 23:49:04 +0200, Michael Niedermayer encoded:
> > On Wed, Oct 07, 2009 at 11:21:40PM +0200, Stefano Sabatini wrote:
> > > Hi,
> > > 
> > > in attachment a slightly modified version of the doc/vfilter.texi file
> > > in the soc repo.
> > > 
> > > I plan to add documentation for the various filters here as long as
> > > I (and possible others) will add them.
> > > 
> > > Regards.
> > > -- 
> > > FFmpeg = Freak and Frightening Mortal Proud Extreme God
> > 
> > >  vfilters.texi |   73 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
> > >  1 file changed, 73 insertions(+)
> > > 0ea092e9ac925920244e41dae36fe19cd26535d5  add-vfilter-doc.patch
> > > Index: ffmpeg/doc/vfilters.texi
> > > ===================================================================
> > > --- /dev/null	1970-01-01 00:00:00.000000000 +0000
> > > +++ ffmpeg/doc/vfilters.texi	2009-10-07 23:18:45.000000000 +0200
> > > @@ -0,0 +1,73 @@
> > > +\input texinfo @c -*- texinfo -*-
> > > +
> > > + at settitle Video Filters Documentation
> > > + at titlepage
> > > + at sp 7
> > > + at center @titlefont{Video Filters Documentation}
> > > + at sp 3
> > > + at end titlepage
> > > +
> > > +
> > > + at chapter Introduction
> > > +
> > 
> > > +Libavfilter is the filtering API of FFmpeg. It is the substitute of the
> > > +now deprecated 'vhooks' and started as a Google Summer of Code project.
> > 
> > > +To get libavfilter you must download it into some directory of your choice by:
> > > + at example
> > > +   svn checkout svn://svn.ffmpeg.org/soc/libavfilter
> > > + at end example
> > > +
> > > +And then read @url{http://svn.ffmpeg.org/soc/libavfilter/README?view=co}
> > > +to learn how to integrate it into ffmpeg and ffplay.
> > 
> > This sounds like that this is the intended final place on where lavfi would be
> 
> I'm aware of it but then that's currently the place to go for getting
> intergration with ffmpeg and ffplay, in the transition phase I believe
> is better to provide a pointer for getting the people to try out the
> real thing.
> 
> What about to add something like the following:
> 
> |Integration in the main SVN repository is a work in progress, so you
> |need to access to the libavfilter SOC repository.
> |
> |To get the libavfilter SOC repository you must download it ...

Id rather say something along the lines of:
Integrating libavfilter into the main ffmpeg repository is a work in
progress. If you wish to try the unfinished development code of libavfilter
then get it from X and do Y. But note that there may still be serious bugs
in the code and its API and ABI should not be considered stable yet!

[...]
-- 
Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB

When you are offended at any man's fault, turn to yourself and study your
own failings. Then you will forget your anger. -- Epictetus
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
URL: <http://lists.mplayerhq.hu/pipermail/ffmpeg-devel/attachments/20091008/770b5955/attachment.pgp>