[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for mul
From: |
Thomas Huth |
Subject: |
Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments |
Date: |
Tue, 5 Jun 2018 06:33:22 +0200 |
User-agent: |
Mozilla/5.0 (X11; Linux x86_64; rv:52.0) Gecko/20100101 Thunderbird/52.7.0 |
On 05.06.2018 03:17, Alex Williamson wrote:
> On Mon, 4 Jun 2018 17:21:40 +0100
> Peter Maydell <address@hidden> wrote:
>
>> The codebase has a bit of a mix of
>> /* multiline comments
>> * like this
>> */
>> and
>> /* multiline comments like this
>> in the GNU Coding Standards style */
>>
>> State a preference for the former.
>>
>> Signed-off-by: Peter Maydell <address@hidden>
>> ---
>> I admit that to some extent I'm imposing my aesthetic
>> preferences here; pretty sure we have a lot more style
>> 1 comments than style 2, though.
>> ---
>> CODING_STYLE | 13 +++++++++++++
>> 1 file changed, 13 insertions(+)
>>
>> diff --git a/CODING_STYLE b/CODING_STYLE
>> index 12ba58ee293..fb1d1f1cd62 100644
>> --- a/CODING_STYLE
>> +++ b/CODING_STYLE
>> @@ -124,6 +124,19 @@ 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 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 */
Anyway, could we either use that dense format or the kernel-style
multi-lines-comment format, please? Mixing it asymmetrically is just ugly.
Thomas
- [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments, Peter Maydell, 2018/06/04
- Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments, John Snow, 2018/06/04
- Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments, Philippe Mathieu-Daudé, 2018/06/04
- Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments, Alex Williamson, 2018/06/04
- Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments,
Thomas Huth <=
- Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments, Cornelia Huck, 2018/06/05
- Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments, Peter Maydell, 2018/06/05
- Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments, Thomas Huth, 2018/06/05
- Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments, Cornelia Huck, 2018/06/05
- Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments, Markus Armbruster, 2018/06/07
- Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments, Kevin Wolf, 2018/06/11
Re: [Qemu-devel] [PATCH] CODING_STYLE: Define our preferred form for multiline comments, Stefan Hajnoczi, 2018/06/07