[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Qemu-devel] [PULL 05/14] CODING_STYLE: Mention preferred comment form

From: Michael Tokarev
Subject: [Qemu-devel] [PULL 05/14] CODING_STYLE: Mention preferred comment form
Date: Tue, 28 Feb 2017 09:44:48 +0300

From: Peter Maydell <address@hidden>

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 <address@hidden>
Signed-off-by: Peter Maydell <address@hidden>
Reviewed-by: Markus Armbruster <address@hidden>
Reviewed-by: Fam Zheng <address@hidden>
Reviewed-by: Laurent Vivier <address@hidden>
Reviewed-by: Stefan Hajnoczi <address@hidden>
Signed-off-by: Michael Tokarev <address@hidden>
 CODING_STYLE | 7 +++++++
 1 file changed, 7 insertions(+)

index f53180b..2fa0c0b 100644
@@ -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.

reply via email to

[Prev in Thread] Current Thread [Next in Thread]