Re: [Qemu-devel] [PATCH 2/2] CODING_STYLE: indent example code as all others
On 2/19/19 11:20 PM, Wei Yang wrote:
> On Tue, Feb 19, 2019 at 07:55:31PM +0100, Philippe Mathieu-Daudé wrote:
>> On 2/19/19 6:56 PM, Eric Blake wrote:
>>> On 2/19/19 11:38 AM, Philippe Mathieu-Daudé wrote:
>>>
> +if (a == 1) {
> +/* Reads like: "If a equals 1" */
I guess you found a bug in the documentation :)
Since 8c06fbdf36bf4d the style asked is:
We now require Linux-kernel-style multiline comments:
/*
* line one
* line two
*/
> +do_something();
>>>
>>> We only require winged multiline comments when the comment is actually
>>> multiline. In this case, the comment is a one-liner, and is just fine
>>> as written.
>>
>> Hmm I have a series where I moved code and changed from /* one line */
>> to the multi-line style, I wonder why and remember checkpatch errors.
>> Maybe a side-effect from what b94e809d3e fixed.
>>
>> Anyway, Wei do you mind adding a multi-line example here too?
>>
>
> A multi-line example for multiline comments?
>
> This looks not relavant to this sectioin. I am afraid I will not add
> this example here. Sorry for that.
No worries, R-b stands.
>> With/without multi-line example:
>> Reviewed-by: Philippe Mathieu-Daudé
>>
>> Thanks!
>>
>> Phil.
>
Re: [Qemu-devel] [PATCH 2/2] CODING_STYLE: indent example code as all others
On Tue, Feb 19, 2019 at 07:55:31PM +0100, Philippe Mathieu-Daudé wrote:
>On 2/19/19 6:56 PM, Eric Blake wrote:
>> On 2/19/19 11:38 AM, Philippe Mathieu-Daudé wrote:
>>
+if (a == 1) {
+/* Reads like: "If a equals 1" */
>>>
>>> I guess you found a bug in the documentation :)
>>>
>>> Since 8c06fbdf36bf4d the style asked is:
>>>
>>> We now require Linux-kernel-style multiline comments:
>>> /*
>>> * line one
>>> * line two
>>> */
>>>
+do_something();
>>
>> We only require winged multiline comments when the comment is actually
>> multiline. In this case, the comment is a one-liner, and is just fine
>> as written.
>
>Hmm I have a series where I moved code and changed from /* one line */
>to the multi-line style, I wonder why and remember checkpatch errors.
>Maybe a side-effect from what b94e809d3e fixed.
>
>Anyway, Wei do you mind adding a multi-line example here too?
>
A multi-line example for multiline comments?
This looks not relavant to this sectioin. I am afraid I will not add
this example here. Sorry for that.
>With/without multi-line example:
>Reviewed-by: Philippe Mathieu-Daudé
>
>Thanks!
>
>Phil.
--
Wei Yang
Help you, Help me
Re: [Qemu-devel] [PATCH 2/2] CODING_STYLE: indent example code as all others
On Tue, Feb 19, 2019 at 06:38:54PM +0100, Philippe Mathieu-Daudé wrote:
>On 2/19/19 2:31 AM, Wei Yang wrote:
>> All the example code are indented with four spaces except this one.
>>
>> Fix this by adding four spaces here.
>>
>> Signed-off-by: Wei Yang
>> ---
>> CODING_STYLE | 8
>> 1 file changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/CODING_STYLE b/CODING_STYLE
>> index 73f66ca185..27581d80c1 100644
>> --- a/CODING_STYLE
>> +++ b/CODING_STYLE
>> @@ -134,10 +134,10 @@ block to a separate function altogether.
>> When comparing a variable for (in)equality with a constant, list the
>> constant on the right, as in:
>>
>> -if (a == 1) {
>> -/* Reads like: "If a equals 1" */
>> -do_something();
>> -}
>> +if (a == 1) {
>> +/* Reads like: "If a equals 1" */
I don't get your point.
You mean to put it into multiline comments?
>
>I guess you found a bug in the documentation :)
>
>Since 8c06fbdf36bf4d the style asked is:
>
>We now require Linux-kernel-style multiline comments:
>/*
> * line one
> * line two
> */
>
>> +do_something();
>> +}
>>
>> Rationale: Yoda conditions (as in 'if (1 == a)') are awkward to read.
>> Besides, good compilers already warn users when '==' is mis-typed as '=',
>>
--
Wei Yang
Help you, Help me
Re: [Qemu-devel] [PATCH 2/2] CODING_STYLE: indent example code as all others
On 2/19/19 6:56 PM, Eric Blake wrote:
> On 2/19/19 11:38 AM, Philippe Mathieu-Daudé wrote:
>
>>> +if (a == 1) {
>>> +/* Reads like: "If a equals 1" */
>>
>> I guess you found a bug in the documentation :)
>>
>> Since 8c06fbdf36bf4d the style asked is:
>>
>> We now require Linux-kernel-style multiline comments:
>> /*
>> * line one
>> * line two
>> */
>>
>>> +do_something();
>
> We only require winged multiline comments when the comment is actually
> multiline. In this case, the comment is a one-liner, and is just fine
> as written.
Hmm I have a series where I moved code and changed from /* one line */
to the multi-line style, I wonder why and remember checkpatch errors.
Maybe a side-effect from what b94e809d3e fixed.
Anyway, Wei do you mind adding a multi-line example here too?
With/without multi-line example:
Reviewed-by: Philippe Mathieu-Daudé
Thanks!
Phil.
Re: [Qemu-devel] [PATCH 2/2] CODING_STYLE: indent example code as all others
On 2/19/19 11:38 AM, Philippe Mathieu-Daudé wrote:
>> +if (a == 1) {
>> +/* Reads like: "If a equals 1" */
>
> I guess you found a bug in the documentation :)
>
> Since 8c06fbdf36bf4d the style asked is:
>
> We now require Linux-kernel-style multiline comments:
> /*
> * line one
> * line two
> */
>
>> +do_something();
We only require winged multiline comments when the comment is actually
multiline. In this case, the comment is a one-liner, and is just fine
as written.
--
Eric Blake, Principal Software Engineer
Red Hat, Inc. +1-919-301-3226
Virtualization: qemu.org | libvirt.org
Re: [Qemu-devel] [PATCH 2/2] CODING_STYLE: indent example code as all others
On 2/18/19 7:31 PM, Wei Yang wrote: > All the example code are indented with four spaces except this one. > > Fix this by adding four spaces here. > > Signed-off-by: Wei Yang > --- > CODING_STYLE | 8 > 1 file changed, 4 insertions(+), 4 deletions(-) Reviewed-by: Eric Blake -- Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3226 Virtualization: qemu.org | libvirt.org
Re: [Qemu-devel] [PATCH 2/2] CODING_STYLE: indent example code as all others
On 2/19/19 2:31 AM, Wei Yang wrote:
> All the example code are indented with four spaces except this one.
>
> Fix this by adding four spaces here.
>
> Signed-off-by: Wei Yang
> ---
> CODING_STYLE | 8
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/CODING_STYLE b/CODING_STYLE
> index 73f66ca185..27581d80c1 100644
> --- a/CODING_STYLE
> +++ b/CODING_STYLE
> @@ -134,10 +134,10 @@ block to a separate function altogether.
> When comparing a variable for (in)equality with a constant, list the
> constant on the right, as in:
>
> -if (a == 1) {
> -/* Reads like: "If a equals 1" */
> -do_something();
> -}
> +if (a == 1) {
> +/* Reads like: "If a equals 1" */
I guess you found a bug in the documentation :)
Since 8c06fbdf36bf4d the style asked is:
We now require Linux-kernel-style multiline comments:
/*
* line one
* line two
*/
> +do_something();
> +}
>
> Rationale: Yoda conditions (as in 'if (1 == a)') are awkward to read.
> Besides, good compilers already warn users when '==' is mis-typed as '=',
>
