From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:41337) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fSPjJ-0000uU-GM for qemu-devel@nongnu.org; Mon, 11 Jun 2018 12:31:42 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fSPjG-0003VV-AL for qemu-devel@nongnu.org; Mon, 11 Jun 2018 12:31:41 -0400 References: <20180611141716.3813-1-peter.maydell@linaro.org> From: John Snow Message-ID: <67eed517-2f84-eaf9-25db-cdacee70c2aa@redhat.com> Date: Mon, 11 Jun 2018 12:31:29 -0400 MIME-Version: 1.0 In-Reply-To: <20180611141716.3813-1-peter.maydell@linaro.org> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit Subject: Re: [Qemu-devel] [PATCH v2] CODING_STYLE: Define our preferred form for multiline comments List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Peter Maydell , qemu-devel@nongnu.org, qemu-trivial@nongnu.org Cc: Kevin Wolf , Thomas Huth , patches@linaro.org, Cornelia Huck , =?UTF-8?Q?Philippe_Mathieu-Daud=c3=a9?= , Markus Armbruster , Alex Williamson , Stefan Hajnoczi , Richard Henderson On 06/11/2018 10:17 AM, Peter Maydell wrote: > The codebase has a bit of a mix of different multiline > comment styles. State a preference for the Linux kernel > style: > /* > * Star on the left for each line. > * Leading slash-star and trailing star-slash > * each go on a line of their own. > */ > > Signed-off-by: Peter Maydell > --- > This is not my personal favourite, but seemed to be the > closest we had to consensus in the mail thread for v1; > I can live with it in order to avoid getting patches which > use the styles I like even less :-) "Same." Well, at least it's not asymmetric. Reviewed-by: John Snow > --- > CODING_STYLE | 17 +++++++++++++++++ > 1 file changed, 17 insertions(+) > > diff --git a/CODING_STYLE b/CODING_STYLE > index 12ba58ee293..2d84f5f26d1 100644 > --- a/CODING_STYLE > +++ b/CODING_STYLE > @@ -124,6 +124,23 @@ 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. > > +Multiline comments blocks should have a row of stars on the left, > +and the initial /* and terminating */ both on their own lines: > + /* > + * like > + * this > + */ > +This is the same format required by the Linux kernel coding style. > + > +(Some of the existing comments in the codebase use the GNU Coding > +Standards form which does not have stars on the left, or other > +variations; avoid these when writing new comments, but don't worry > +about converting to the preferred form unless you're editing that > +comment anyway.) > + > +Rationale: Consistency, and ease of visually picking out a multiline > +comment from the surrounding code. > + > 8. trace-events style > > 8.1 0x prefix >