Commit 25ac5bbe authored by Peter Maydell's avatar Peter Maydell Committed by Michael Tokarev

CODING_STYLE: Mention preferred comment form

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: 's avatarThomas Huth <thuth@redhat.com>
Signed-off-by: 's avatarPeter Maydell <peter.maydell@linaro.org>
Reviewed-by: 's avatarMarkus Armbruster <armbru@redhat.com>
Reviewed-by: 's avatarFam Zheng <famz@redhat.com>
Reviewed-by: 's avatarLaurent Vivier <laurent@vivier.eu>
Reviewed-by: 's avatarStefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: 's avatarMichael Tokarev <mjt@tls.msk.ru>
parent a6e3707e
......@@ -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.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment