[FFmpeg-devel] [PATCH] doc/developer: merge and update sections about external development

[Stefano Sabatini]

On date Monday 2013-07-08 12:13:23 +0000, Paul B Mahol encoded:
> On 7/5/13, Stefano Sabatini <stefasab at gmail.com> wrote:
> > ---
> >  doc/developer.texi | 39 ++++++++++++++++-----------------------
> >  1 file changed, 16 insertions(+), 23 deletions(-)
> >
> > diff --git a/doc/developer.texi b/doc/developer.texi
> > index 5972d87..dfe3c75 100644
> > --- a/doc/developer.texi
> > +++ b/doc/developer.texi
> > @@ -11,29 +11,22 @@
> >
> >  @chapter Developers Guide
> >
> > - at section API
> > - at itemize @bullet
> > - at item libavcodec is the library containing the codecs (both encoding and
> > -decoding). Look at @file{doc/examples/decoding_encoding.c} to see how to
> > use
> > -it.
> > -
> > - at item libavformat is the library containing the file format handling (mux
> > and
> > -demux code for several formats). Look at @file{ffplay.c} to use it in a
> > -player. See @file{doc/examples/muxing.c} to use it to generate audio or
> > video
> > -streams.
> > -
> > - at end itemize
> > -
> > - at section Integrating libavcodec or libavformat in your program
> > -
> > -You can integrate all the source code of the libraries to link them
> > -statically to avoid any version problem. All you need is to provide a
> > -'config.mak' and a 'config.h' in the parent directory. See the defines
> > -generated by ./configure to understand what is needed.
> > -
> > -You can use libavcodec or libavformat in your commercial program,
> > - at emph{any patch you make must be published}. The best way to proceed is
> > -to send your patches to the FFmpeg mailing list.
> > + at section Note for external developers
> > +
> > +This document is mostly useful for internal FFmpeg developers.
> > +External developer who need to use the API in their application should
> > +refer to the API doxygen documentation in the public headers, and
> > +check the examples in @file{doc/examples} and in the source code to
> > +see how the public API is employed.
> > +
> > +You can use the FFmpeg libraries in your commercial program, but you
> > +are encouraged to @emph{publish any patch you make}. In this case the
> > +best way to proceed is to send your patches to the FFmpeg mailing
> > +list.
> > +
> > +For more detailed legal information about the use of FFmpeg in
> > +external programs read the @file{LICENSE} file in the source tree and
> > +consult @url{http://ffmpeg.org/legal.html}.
> >
> >  @section Contributing
> >
> 
> I do not see anything merged, just some stuff removed and new stuf added.

I don't mind changing the log if required, but I need someone to
review/approve the text.
-- 
FFmpeg = Frenzy & Forgiving Mournful Philosophical Evil Governor