From 0d0673857b5b2a50f6aef62e0f042795d9893690 Mon Sep 17 00:00:00 2001 From: Ben Pfaff Date: Fri, 1 Mar 2013 11:02:31 -0800 Subject: [PATCH] CodingStyle: Mention our common return value conventions. CC: Andy Zhou Signed-off-by: Ben Pfaff --- CodingStyle | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CodingStyle b/CodingStyle index ee7a0e6d4..22f0f458a 100644 --- a/CodingStyle +++ b/CodingStyle @@ -249,6 +249,18 @@ details. (Some compilers also assume that the "if" branch is the more common case, so this can be a real form of optimization as well.) +RETURN VALUES + + For functions that return a success or failure indication, prefer +one of the following return value conventions: + + * An "int" where 0 indicates success and a positive errno value + indicates a reason for failure. + + * A "bool" where true indicates success and false indicates + failure. + + MACROS Don't define an object-like macro if an enum can be used instead. -- 2.43.0