diff options
author | Clément Bœsch <ubitux@gmail.com> | 2013-02-13 20:19:32 +0100 |
---|---|---|
committer | Clément Bœsch <ubitux@gmail.com> | 2013-02-13 20:19:32 +0100 |
commit | 15e7533ca1a1a5d6bf0b35cf67b9e0a0bae7ee27 (patch) | |
tree | 3b940bf5f62f3dbd9353e8bc4bb4081e0140072b | |
parent | 5dd78ef34e2070b17164d646781c0cf9a8e0550f (diff) | |
download | ffmpeg-15e7533ca1a1a5d6bf0b35cf67b9e0a0bae7ee27.tar.gz |
doc/dev: clarify public symbols prefixes.
-rw-r--r-- | doc/developer.texi | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/developer.texi b/doc/developer.texi index c11a5ef7d0..5acdce9643 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, +@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 +@code{lib<name>/lib<name>.v} files. @end itemize Furthermore, name space reserved for the system should not be invaded. |