X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=CodingStyle;h=6ff931b150cc920ded9e7ba6807059a8fa814922;hp=77fa90c733be38f090d937d05950ffc47ef29122;hb=HEAD;hpb=1f2f41593be38847883eaf11ca8f5db08adec5a1 diff --git a/CodingStyle b/CodingStyle deleted file mode 100644 index 77fa90c73..000000000 --- a/CodingStyle +++ /dev/null @@ -1,45 +0,0 @@ -LTTng-Tools Coding Style - -Last Update: 23/07/2012 - -C Style: -------------- - -The coding style used for this project follows the the Linux kernel guide -lines, except that brackets "{", "}" should typically be used even for -single-line if/else statements. Please refer to: - -- doc/kernel-CodingStyle.txt (copied from Linux 3.4.4 git tree). - -- Linux kernel scripts/checkpatch.pl for a script which verify the patch - coding style. - -Error handling: -------------- - -We ask to use one single return point in a function. For that, we uses the -"goto" statement for the error handling creating one single point for error -handling and return code. See the following example: - -int some_function(...) -{ - int ret; - [...] - - if (ret != 0) { - goto error; - } - - [...] -error: - return ret; -} - -Commenting: -------------- - -Every function MUST have a comment above it even if the function is trivial. - -Please add non-trivial comments/documentation as much as you can in the code. -Poor comments WILL be rejected upon merging so please pay attention to this -details because we do!