diff options
| author | Michael Niedermayer <michaelni@gmx.at> | 2013-02-12 17:10:36 +0400 |
|---|---|---|
| committer | Michael Niedermayer <michaelni@gmx.at> | 2013-02-12 17:10:36 +0400 |
| commit | a63dc846b502462c724c4791f830878301b0277a (patch) | |
| tree | 0750587022235543da53b185169cccb63a25b3f8 /doc/developer.texi | |
| parent | 08db519e1275d301417be0013ef3eb03e9381935 (diff) | |
| parent | fd1abf42693308ff99b9473c2387d5142f8b3f0e (diff) | |
Merge remote-tracking branch 'qatar/master'
* qatar/master:
lavu: avoid clashing definition of E
doc: developer: Add a note about reserved system name space
Conflicts:
libavutil/internal.h
Merged-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'doc/developer.texi')
| -rw-r--r-- | doc/developer.texi | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/developer.texi b/doc/developer.texi index 1c29ae0e14..c11a5ef7d0 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -169,6 +169,14 @@ For externally visible symbols, each library has its own prefix. Check the existing code and choose names accordingly. @end itemize +Furthermore, name space reserved for the system should not be invaded. +Identifiers ending in @code{_t} are reserved by +@url{http://pubs.opengroup.org/onlinepubs/007904975/functions/xsh_chap02_02.html#tag_02_02_02, POSIX}. +Also avoid names starting with @code{__} or @code{_} followed by an uppercase +letter as they are reserved by the C standard. Names starting with @code{_} +are reserved at the file level and may not be used for externally visible +symbols. If in doubt, just avoid names starting with @code{_} altogether. + @subsection Miscellaneous conventions @itemize @bullet @item |