diff options
| author | Diego Biurrun <diego@biurrun.de> | 2013-02-11 18:53:33 +0100 |
|---|---|---|
| committer | Diego Biurrun <diego@biurrun.de> | 2013-02-11 20:17:15 +0100 |
| commit | 3658d2dfd48a764503f1bb43edabef0c8af4d8d9 (patch) | |
| tree | 637920d3e02593a85e00a28bafa255f92a2756d2 | |
| parent | 56dea32f09e71460add14a1b6d0fbe6eb16f02a4 (diff) | |
| download | ffmpeg-3658d2dfd48a764503f1bb43edabef0c8af4d8d9.tar.gz | |
doc: developer: Add a note about reserved system name space
| -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 b3e151347e..a30cc9dfaa 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -200,6 +200,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 |