Permalink
Browse files

Added 'Coding rules' section in ybc.c

  • Loading branch information...
1 parent 65a8b2e commit 9edb3602744a884795105cc9781629b35e4618ab @valyala committed Apr 1, 2012
Showing with 6 additions and 0 deletions.
  1. +6 −0 ybc.c
View
6 ybc.c
@@ -15,6 +15,12 @@
* - public macros and constants start with YBC_
* - private functions and structures start with m_
* - private macros and constants start with M_
+ *
+ * Coding rules:
+ * - All variables, which are expected to be immutable in the given code block,
+ * MUST be declared as constants! This provides the following benefits:
+ * + It prevents from accidental modification of the given variable.
+ * + It may help dumb compilers with 'constant propagation' optimizations.
******************************************************************************/

0 comments on commit 9edb360

Please sign in to comment.