[FFmpeg-cvslog] doc: developer: Add a note about reserved system name space

Diego Biurrun git at videolan.org
Tue Feb 12 14:21:13 CET 2013


ffmpeg | branch: master | Diego Biurrun <diego at biurrun.de> | Mon Feb 11 18:53:33 2013 +0100| [3658d2dfd48a764503f1bb43edabef0c8af4d8d9] | committer: Diego Biurrun

doc: developer: Add a note about reserved system name space

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=3658d2dfd48a764503f1bb43edabef0c8af4d8d9
---

 doc/developer.texi |    8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/doc/developer.texi b/doc/developer.texi
index b3e1513..a30cc9d 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
+ at 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



More information about the ffmpeg-cvslog mailing list