[FFmpeg-devel] [RFC] documentation: add encoders chapter

[Stefano Sabatini]

On date Saturday 2011-02-12 14:16:37 +0100, Janne Grunau encoded:
> On Fri, Feb 11, 2011 at 04:02:45PM -0800, James Zern wrote:
> > Very well.
> 
> > diff --git a/doc/encoders.texi b/doc/encoders.texi
> > new file mode 100644
> > index 0000000..cab98fb
> > --- /dev/null
> > +++ b/doc/encoders.texi
> > @@ -0,0 +1,20 @@
> > + at chapter Encoders
> > + at c man begin ENCODERS
> > +
> > +Encoders are configured elements in FFmpeg which allow the encoding of
> > +multimedia streams.
> > +
> > +When you configure your FFmpeg build, all the supported native encoders
> > +are enabled by default. Encoders requiring an external library must be enabled
> > +manually via the corresponding @code{--enable-lib} option. You can list all
> > +available encoders using the configure option @code{--list-encoders}.
> > +
> > +You can disable all the encoders with the configure option
> > + at code{--disable-encoders} and selectively enable / disable single encoders
> > +with the options @code{--enable-encoder=@var{ENCODER}} /
> > + at code{--disable-encoder=@var{ENCODER}}.
> 
> This is not the best place to describe configure options. Please add a
> sentence like "check configure --help output for details. 

This is consistent with the other texi files, so it should be
(eventually) fixed globally (with another patch).
-- 
FFmpeg = Fascinating and Fundamental Mortal Plastic Egregious Geisha