CodingGuidelines
From XiphWiki
(Difference between revisions)
(this page just got rescued from web.archive, please format it/link to it) |
|||
| 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]] | ||
Revision as of 18: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)