From: Peter Maydell <peter.mayd...@linaro.org>
Our defacto coding style strongly prefers /* */ style comments
over the single-line // style, and checkpatch enforces this,
but we don't actually document this. Mention it in CODING_STYLE.
Suggested-by: Thomas Huth <th...@redhat.com>
Signed-off-by: Peter Maydell <peter.mayd...@linaro.org>
Reviewed-by: Markus Armbruster <arm...@redhat.com>
Reviewed-by: Fam Zheng <f...@redhat.com>
Reviewed-by: Laurent Vivier <laur...@vivier.eu>
Reviewed-by: Stefan Hajnoczi <stefa...@redhat.com>
Signed-off-by: Michael Tokarev <m...@tls.msk.ru>
---
CODING_STYLE | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/CODING_STYLE b/CODING_STYLE
index f53180b..2fa0c0b 100644
--- a/CODING_STYLE
+++ b/CODING_STYLE
@@ -116,3 +116,10 @@ if (a == 1) {
Rationale: Yoda conditions (as in 'if (1 == a)') are awkward to read.
Besides, good compilers already warn users when '==' is mis-typed as '=',
even when the constant is on the right.
+
+7. Comment style
+
+We use traditional C-style /* */ comments and avoid // comments.
+
+Rationale: The // form is valid in C99, so this is purely a matter of
+consistency of style. The checkpatch script will warn you about this.
--
2.1.4
