From: Andreas Schneider <asn@samba.org>
Date: Mon, 15 Feb 2016 14:51:26 +0000 (+0100)
Subject: README.Coding: Add a boolean example we use very often
X-Git-Tag: tevent-0.9.27~2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=dae1a9fdb5f85ebb1c72f7990959ffaa3003c769;p=thirdparty%2Fsamba.git

README.Coding: Add a boolean example we use very often

Signed-off-by: Andreas Schneider <asn@samba.org>
Reviewed-by: Ralph Boehme <slow@samba.org>
---

diff --git a/README.Coding b/README.Coding
index 29bad1b1ffc..c4e9dfebf98 100644
--- a/README.Coding
+++ b/README.Coding
@@ -312,6 +312,17 @@ lib/replace/, new code should adhere to the following conventions:
   * Boolean values are "true" and "false" (not True or False)
   * Exact width integers are of type [u]int[8|16|32|64]_t
 
+Most of the time a good name for a boolean variable is 'ok'. Here is an
+example we often use:
+
+	bool ok;
+
+	ok = foo();
+	if (!ok) {
+		/* do something */
+	}
+
+It makes the code more readable and is easy to debug.
 
 Typedefs
 --------