diff mbox series

[FFmpeg-devel,1/4] doc/developer.texi: improve the introductory text

Message ID 20221114091309.15755-1-anton@khirnov.net
State Accepted
Commit 26080d1542c3695b6ebca127f180be102dd59af3
Headers show
Series [FFmpeg-devel,1/4] doc/developer.texi: improve the introductory text | expand


Context Check Description
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Anton Khirnov Nov. 14, 2022, 9:13 a.m. UTC
Remove confusing references to "external" vs. "internal" developers.
 doc/developer.texi | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)
diff mbox series


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 @@ 
-@chapter Notes for external developers
+@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:
+@itemize @bullet
+the installed header files
+@url{http://ffmpeg.org/doxygen/trunk/index.html, the Doxygen documentation}
+generated from the headers
+the examples under @file{doc/examples}
+@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