From: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Date: Thu, 19 May 2016 15:57:44 +0000 (-0400)
Subject: Update coding style document for macro style
X-Git-Tag: v2.9.0-rc1~157
X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=commitdiff_plain;h=264ede77f8835472105bb4c84c33c5d0dd12f619

Update coding style document for macro style

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/CodingStyle b/CodingStyle
index 1d8bd9b43..6ff931b15 100644
--- a/CodingStyle
+++ b/CodingStyle
@@ -31,14 +31,22 @@ enum my_enum {
 #define DEFAULT_VALUE_OF_SOME_SORT   6
 #define THE_ANSWER                   42
 
-Use space to indent the '\' at the end but tabs at the beginning.
+Use either a single space or tabs to indent the '\' at the end of lines.
+Use tabs at the beginning of lines.
 
-#define a_macro(x)      \
-	do {                \
-		fsync();        \
+Either:
+
+#define a_macro(x) \
+	do { \
+		fsync(); \
 	} while (0)
 
-It's really the only time we use spaces. For everything else, there is TABS! :)
+or
+
+#define a_macro(x)		\
+	do {			\
+		fsync();	\
+	} while (0)
 
 Here is a pretty cool vim macro that will highlight your whitespaces and spaces
 before tab. This helps a *LOT* when coding.