Difference between revisions of "CodingGuidelines"

From XiphWiki
Jump to: navigation, search
Line 4: Line 4:
 
** 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 =
+
== See also ==
 
*[[MIT approach to design and implementation]]
 
*[[MIT approach to design and implementation]]

Revision as of 11:26, 28 February 2007

  • 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