[FFmpeg-cvslog] doc/dev: clarify public symbols prefixes.
Clément Bœsch
git at videolan.org
Wed Feb 13 20:19:41 CET 2013
ffmpeg | branch: master | Clément Bœsch <ubitux at gmail.com> | Wed Feb 13 20:19:32 2013 +0100| [15e7533ca1a1a5d6bf0b35cf67b9e0a0bae7ee27] | committer: Clément Bœsch
doc/dev: clarify public symbols prefixes.
> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=15e7533ca1a1a5d6bf0b35cf67b9e0a0bae7ee27
---
doc/developer.texi | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/doc/developer.texi b/doc/developer.texi
index c11a5ef..5acdce9 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -165,8 +165,13 @@ prefix should be used, e.g. @samp{ff_w64_demuxer}.
For variables and functions used internally across multiple libraries, use
@code{avpriv_}. For example, @samp{avpriv_aac_parse_header}.
@item
-For externally visible symbols, each library has its own prefix. Check
-the existing code and choose names accordingly.
+Each library has its own prefix for public symbols, in addition to the
+commonly used @code{av_} (@code{avformat_} for libavformat,
+ at code{avcodec_} for libavcodec, @code{swr_} for libswresample, etc).
+Check the existing code and choose names accordingly.
+Note that some symbols without these prefixes are also exported for
+retro-compatibility reasons. These exceptions are declared in the
+ at code{lib<name>/lib<name>.v} files.
@end itemize
Furthermore, name space reserved for the system should not be invaded.
More information about the ffmpeg-cvslog
mailing list