[FFmpeg-cvslog] doc/developer.texi: improve the introductory text

Anton Khirnov git at videolan.org
Thu Nov 17 12:02:09 EET 2022


ffmpeg | branch: master | Anton Khirnov <anton at khirnov.net> | Wed Nov  9 14:59:21 2022 +0100| [26080d1542c3695b6ebca127f180be102dd59af3] | committer: Anton Khirnov

doc/developer.texi: improve the introductory text

Remove confusing references to "external" vs. "internal" developers.

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=26080d1542c3695b6ebca127f180be102dd59af3
---

 doc/developer.texi | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

diff --git a/doc/developer.texi b/doc/developer.texi
index addee0d826..5cf3b19ee0 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -10,13 +10,19 @@
 
 @contents
 
- at chapter Notes for external developers
+ at chapter Introduction
 
-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.
+This text is concerned with the development @emph{of} FFmpeg itself. Information
+on using the FFmpeg libraries in other programs can be found elsewhere, e.g. in:
+ at itemize @bullet
+ at item
+the installed header files
+ at item
+ at url{http://ffmpeg.org/doxygen/trunk/index.html, the Doxygen documentation}
+generated from the headers
+ at item
+the examples under @file{doc/examples}
+ at end itemize
 
 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



More information about the ffmpeg-cvslog mailing list