summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.Coding15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.Coding b/README.Coding
index 73ceb5028c..da6bb38207 100644
--- a/README.Coding
+++ b/README.Coding
@@ -214,3 +214,18 @@ or
if (!x) {
fprintf(stderr, "Unable to alloc memory!\n");
}
+
+
+Primitive Data Types
+--------------------
+
+Samba has large amounts of historical code which makes use of data types
+commonly supported by the C99 standard. However, at the time such types
+as boolean and exact width integers did not exist and Samba developers
+were forced to provide their own. Now that these types are guaranteed to
+be available either as part of the compiler C99 support or from lib/replace/,
+new code should adhere to the following conventions:
+
+ * Booleans are of type "bool" (not BOOL)
+ * Boolean values are "true" and "false" (not True or False)
+ * Exact width integers are of type [u]int[8|16|32|64]_t