From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:36293) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fSzqv-00011s-4H for qemu-devel@nongnu.org; Wed, 13 Jun 2018 03:05:58 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fSzqo-0002T9-Hs for qemu-devel@nongnu.org; Wed, 13 Jun 2018 03:05:57 -0400 Date: Wed, 13 Jun 2018 09:05:37 +0200 From: Cornelia Huck Message-ID: <20180613090537.0b811eb8.cohuck@redhat.com> In-Reply-To: <20180612124729.0e630825@w520.home> References: <20180611141716.3813-1-peter.maydell@linaro.org> <650048df-f4b1-b351-f877-be8c84197ba2@linaro.org> <85642e2a-f00a-3d85-8525-0ae89e4d71c9@redhat.com> <20180612124729.0e630825@w520.home> MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII 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: Alex Williamson Cc: Thomas Huth , Richard Henderson , Peter Maydell , qemu-devel@nongnu.org, qemu-trivial@nongnu.org, Kevin Wolf , patches@linaro.org, Markus Armbruster , Philippe =?UTF-8?B?TWF0aGlldS1EYXVkw6k=?= , Stefan Hajnoczi , John Snow , Richard Henderson On Tue, 12 Jun 2018 12:47:29 -0600 Alex Williamson wrote: > On Tue, 12 Jun 2018 20:12:02 +0200 > Thomas Huth wrote: > > > On 12.06.2018 19:30, Richard Henderson wrote: > > > On 06/11/2018 04: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 :-) > > > > > > Honestly, I don't like this except for "important" comments. > > > > > > A "small" comment, e.g. one that doesn't quite fit on a single line, now takes > > > 4 lines instead of 2. Which is really annoying and IMO tends to break flow. > > > > > > If you don't like > > > > > > /* gnu > > > style */ > > > > > > or > > > > > > /* whatever > > > * this is */ > > > > > > could you live with > > > > > > // c99/c++ > > > // comments > > > > FWIW: > > > > +1 for one or two of those compact styles for two- or three-line comments. > > or four-line or single paragraphs or comments that rhyme with > "orange"... If the comment is too large for a single line, then take > some time to say it more concisely, or maybe it does deserve enough > thought to frame a nice paragraph for it. We're well into personal > style here, so either this is important enough to make some people > unhappy or we should leave it to maintainer preference and consistency > within a file/area. Thanks, +1 to maintainer judgment and consistency. (And FWIW, c++ style comments are what I use when I comment something out for debugging, so I don't like them in regular code :)