From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:59086) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1fQ87t-0004zG-T7 for qemu-devel@nongnu.org; Tue, 05 Jun 2018 05:19:38 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1fQ87s-00061h-VA for qemu-devel@nongnu.org; Tue, 05 Jun 2018 05:19:37 -0400 Received: from mail-ot0-x243.google.com ([2607:f8b0:4003:c0f::243]:44443) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1fQ87s-00060z-Ou for qemu-devel@nongnu.org; Tue, 05 Jun 2018 05:19:36 -0400 Received: by mail-ot0-x243.google.com with SMTP id w13-v6so1924334ote.11 for ; Tue, 05 Jun 2018 02:19:36 -0700 (PDT) MIME-Version: 1.0 In-Reply-To: <20180605094613.52bcf85d.cohuck@redhat.com> References: <20180604162140.20688-1-peter.maydell@linaro.org> <20180604191756.1ae61871@w520.home> <52a5446f-4624-fd45-ce7d-492269aa5c3f@redhat.com> <20180605094613.52bcf85d.cohuck@redhat.com> From: Peter Maydell Date: Tue, 5 Jun 2018 10:19:15 +0100 Message-ID: Content-Type: text/plain; charset="UTF-8" Subject: Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Cornelia Huck Cc: Thomas Huth , QEMU Developers On 5 June 2018 at 08:46, Cornelia Huck wrote: > On Tue, 5 Jun 2018 06:33:22 +0200 > Thomas Huth wrote: >> On 05.06.2018 03:17, Alex Williamson wrote: >> > On Mon, 4 Jun 2018 17:21:40 +0100 >> > Peter Maydell wrote: >> >> +Multiline comments blocks should have a row of stars on the left >> >> +and the terminating */ on its own line: >> >> + /* like >> >> + * this >> >> + */ >> >> +Putting the initial /* on its own line is accepted, but not required. >> > >> > Could we say "at maintainer discretion", or is that always implied? The >> > asymmetry of the proposed standard is not my favorite and a mostly >> > blank line before and after further supports standing out from >> > surrounding code. >> I also don't like the asymmetry. I'd prefer more dense comments, though: >> >> /* like >> * this */ Wow, I think that looks terrible :-) >> Anyway, could we either use that dense format or the kernel-style >> multi-lines-comment format, please? Mixing it asymmetrically is just ugly. > > I'd vote for the kernel style, then. I don't particularly object to the kernel style (though it's not how I personally default to writing comments). I just didn't want to rule a huge chunk of our existing comments as out-of-standard for what I see as a relatively minor divergence in form -- we do have a lot of no-leading-separate-/* comments. I can live with mandating kernel-style if it means we can rule out GNU-form and other weirdnesses though :-) thanks -- PMM