From 1f2f41593be38847883eaf11ca8f5db08adec5a1 Mon Sep 17 00:00:00 2001 From: David Goulet Date: Wed, 12 Sep 2012 15:26:46 -0400 Subject: [PATCH] Update coding style. Add error handling section Signed-off-by: David Goulet --- CodingStyle | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/CodingStyle b/CodingStyle index 6e7adfc4e..77fa90c73 100644 --- a/CodingStyle +++ b/CodingStyle @@ -14,11 +14,32 @@ single-line if/else statements. Please refer to: - 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 you can in the code. Poor -comments WILL be rejected upon merging so please pay attention to this details -because we do! +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! -- 2.34.1