CodingStyle

   1 LTTng-Tools Coding Style
   2
   3 Last Update: 23/07/2012
   4
   5 C Style:
   6 -------------
   7
   8 The coding style used for this project follows the the Linux kernel guide
   9 lines, except that brackets "{", "}" should typically be used even for
  10 single-line if/else statements. Please refer to:
  11
  12 - doc/kernel-CodingStyle.txt (copied from Linux 3.4.4 git tree).
  13
  14 - Linux kernel scripts/checkpatch.pl for a script which verify the patch
  15   coding style.
  16
  17 Commenting:
  18 -------------
  19
  20 Every function MUST have a comment above it even if the function is trivial.
  21
  22 Please add non-trivial comments/documentation as much you can in the code. Poor
  23 comments WILL be rejected upon merging so please pay attention to this details
  24 because we do!