[FFmpeg-cvslog] doc/developer: update sections about external development
Stefano Sabatini
git at videolan.org
Thu Jul 11 00:50:20 CEST 2013
ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Fri Jul 5 10:22:03 2013 +0200| [e7a6962e7650e3c105b8658788c7a3ee9f5f1f2b] | committer: Stefano Sabatini
doc/developer: update sections about external development
Replace the sections "API" and "Integrating libavcodec or libavformat"
with updated / more accurate text.
See thread:
Subject: [FFmpeg-devel] [PATCH] doc/developer: merge and update sections about external development
Date: Fri, 5 Jul 2013 11:07:07 +0200
> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=e7a6962e7650e3c105b8658788c7a3ee9f5f1f2b
---
doc/developer.texi | 40 +++++++++++++++++-----------------------
1 file changed, 17 insertions(+), 23 deletions(-)
diff --git a/doc/developer.texi b/doc/developer.texi
index 5972d87..af7e7de 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -11,29 +11,23 @@
@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, but
- 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 Notes for external developers
+
+This document is mostly useful for internal FFmpeg developers.
+External developers 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-devel
+mailing list following the guidelines illustrated in the remainder of
+this document.
+
+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
More information about the ffmpeg-cvslog
mailing list