From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from list by lists.gnu.org with archive (Exim 4.71) id 1cZx8s-0000X4-5u for mharc-qemu-trivial@gnu.org; Sat, 04 Feb 2017 05:00:26 -0500 Received: from eggs.gnu.org ([2001:4830:134:3::10]:37091) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cZx8p-0000Uu-C9 for qemu-trivial@nongnu.org; Sat, 04 Feb 2017 05:00:24 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cZx8o-0002oS-HQ for qemu-trivial@nongnu.org; Sat, 04 Feb 2017 05:00:23 -0500 Received: from mx1.redhat.com ([209.132.183.28]:54396) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1cZx8i-0002n7-GZ; Sat, 04 Feb 2017 05:00:16 -0500 Received: from int-mx10.intmail.prod.int.phx2.redhat.com (int-mx10.intmail.prod.int.phx2.redhat.com [10.5.11.23]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id 88D273B70C; Sat, 4 Feb 2017 10:00:16 +0000 (UTC) Received: from blackfin.pond.sub.org (ovpn-116-50.ams2.redhat.com [10.36.116.50]) by int-mx10.intmail.prod.int.phx2.redhat.com (8.14.4/8.14.4) with ESMTP id v14A0FAC023633 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=NO); Sat, 4 Feb 2017 05:00:16 -0500 Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id AD0A41138646; Sat, 4 Feb 2017 11:00:13 +0100 (CET) From: Markus Armbruster To: Peter Maydell Cc: qemu-devel@nongnu.org, qemu-trivial@nongnu.org, Thomas Huth , patches@linaro.org References: <1486144722-6021-1-git-send-email-peter.maydell@linaro.org> Date: Sat, 04 Feb 2017 11:00:13 +0100 In-Reply-To: <1486144722-6021-1-git-send-email-peter.maydell@linaro.org> (Peter Maydell's message of "Fri, 3 Feb 2017 17:58:42 +0000") Message-ID: <87efze6zte.fsf@dusky.pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 2.68 on 10.5.11.23 X-Greylist: Sender IP whitelisted, not delayed by milter-greylist-4.5.16 (mx1.redhat.com [10.5.110.30]); Sat, 04 Feb 2017 10:00:16 +0000 (UTC) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 209.132.183.28 Subject: Re: [Qemu-trivial] [Qemu-devel] [PATCH] CODING_STYLE: Mention preferred comment form X-BeenThere: qemu-trivial@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 04 Feb 2017 10:00:24 -0000 Peter Maydell writes: > 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 > Signed-off-by: Peter Maydell > --- > 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: Markus Armbruster From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:37077) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cZx8n-0000Ts-CR for qemu-devel@nongnu.org; Sat, 04 Feb 2017 05:00:22 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cZx8i-0002nT-Mx for qemu-devel@nongnu.org; Sat, 04 Feb 2017 05:00:21 -0500 From: Markus Armbruster References: <1486144722-6021-1-git-send-email-peter.maydell@linaro.org> Date: Sat, 04 Feb 2017 11:00:13 +0100 In-Reply-To: <1486144722-6021-1-git-send-email-peter.maydell@linaro.org> (Peter Maydell's message of "Fri, 3 Feb 2017 17:58:42 +0000") Message-ID: <87efze6zte.fsf@dusky.pond.sub.org> MIME-Version: 1.0 Content-Type: text/plain Subject: Re: [Qemu-devel] [PATCH] CODING_STYLE: Mention preferred comment form List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Peter Maydell Cc: qemu-devel@nongnu.org, qemu-trivial@nongnu.org, Thomas Huth , patches@linaro.org Peter Maydell writes: > 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 > Signed-off-by: Peter Maydell > --- > 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: Markus Armbruster