Difference between revisions of "CodingGuidelines"

From XiphWiki
Jump to: navigation, search
(this page just got rescued from web.archive, please format it/link to it)
 
 
(3 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
** m4 files defining internal macros (that is, those which won't be installed on user's machines) should be prefixed with xiph_ (eg xiph_compiler.m4)
 
** m4 files defining internal macros (that is, those which won't be installed on user's machines) should be prefixed with xiph_ (eg xiph_compiler.m4)
 
** macros should prefix shell variables local to themselves with xt_ (eg xt_save_CFLAGS) to avoid namespace pollution. Shell variables exported by a macro should be capitalised (eg SHOUT_LIBS)
 
** macros should prefix shell variables local to themselves with xt_ (eg xt_save_CFLAGS) to avoid namespace pollution. Shell variables exported by a macro should be capitalised (eg SHOUT_LIBS)
 +
 +
== See also ==
 +
*[[MIT approach to design and implementation]]
 +
*[[How to do a release]]
 +
 +
[[Category:Developers stuff]]

Latest revision as of 23:01, 6 February 2008

  • autoconf
    • All macros names should contain the XIPH_ prefix, and otherwise follow the autoconf naming conventions where applicable
    • m4 files defining internal macros (that is, those which won't be installed on user's machines) should be prefixed with xiph_ (eg xiph_compiler.m4)
    • macros should prefix shell variables local to themselves with xt_ (eg xt_save_CFLAGS) to avoid namespace pollution. Shell variables exported by a macro should be capitalised (eg SHOUT_LIBS)

See also