From: Fam Zheng <famz@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: qemu-devel@nongnu.org, qemu-trivial@nongnu.org,
Thomas Huth <thuth@redhat.com>,
patches@linaro.org
Subject: Re: [Qemu-trivial] [Qemu-devel] [PATCH] CODING_STYLE: Mention preferred comment form
Date: Sat, 4 Feb 2017 22:48:54 +0800 [thread overview]
Message-ID: <20170204144854.GC15362@lemon> (raw)
In-Reply-To: <1486144722-6021-1-git-send-email-peter.maydell@linaro.org>
On Fri, 02/03 17:58, Peter Maydell wrote:
> 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 <thuth@redhat.com>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
> 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.
Reviewed-by: Fam Zheng <famz@redhat.com>
next prev parent reply other threads:[~2017-02-04 14:49 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-02-03 17:58 [Qemu-trivial] [PATCH] CODING_STYLE: Mention preferred comment form Peter Maydell
2017-02-04 10:00 ` [Qemu-trivial] [Qemu-devel] " Markus Armbruster
2017-02-04 14:48 ` Fam Zheng [this message]
2017-02-05 18:02 ` [Qemu-trivial] " Laurent Vivier
2017-02-13 14:00 ` [Qemu-trivial] [Qemu-devel] " Stefan Hajnoczi
2017-02-15 10:17 ` [Qemu-trivial] " Michael Tokarev
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20170204144854.GC15362@lemon \
--to=famz@redhat.com \
--cc=patches@linaro.org \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=qemu-trivial@nongnu.org \
--cc=thuth@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).