coding_guide.txt

   1 1. Coding Style
   2
   3         You should follow the style of the file you're editing. In general, we
   4         try to follow the rules below.
   5
   6         1) indent with tabs, and a tab is always 8 characters wide
   7         2) opening braces are on the same line as the if statement
   8         3) no braces in an if-body with just one statement
   9         4) if one of the branches of an if-else codition has braces, than the
  10            other branch should also have braces
  11         5) there is always an empty line between variable declarations and the code
  12
  13         static int
  14         my_function(void)
  15         {
  16                 int a = 0;
  17                 if (a)
  18                         b();
  19                 else
  20                         c();
  21                 if (a) {
  22                         b();
  23                         c();
  24                 } else {
  25                         d();
  26                 }
  27         }
  28
  29         6) lines should be less than 80 characters wide
  30         7) when breaking lines with functions calls, the parameters are aligned
  31            with the opening parenthesis
  32         8) when assigning a variable with the result of a function call, if the
  33            line would be longer we break it around the equal '=' sign if it makes sense
  34
  35         long_variable_name =
  36                 function_with_a_really_long_name(parameter1, parameter2,
  37                                                  parameter3, parameter4);
  38         x = function_with_a_really_long_name(parameter1, parameter2,
  39                                              parameter3, parameter4);