* [Qemu-devel] [PATCH v4 0/2] CODING_STYLE: trivial update
@ 2019-02-25 1:25 Wei Yang
2019-02-25 1:25 ` [Qemu-devel] [PATCH v4 1/2] CODING_STYLE: specify the indent rule for multiline code Wei Yang
2019-02-25 1:25 ` [Qemu-devel] [PATCH v4 2/2] CODING_STYLE: indent example code as all others Wei Yang
0 siblings, 2 replies; 6+ messages in thread
From: Wei Yang @ 2019-02-25 1:25 UTC (permalink / raw)
To: qemu-devel, qemu-trivial
Cc: mjt, imammedo, philmd, eblake, peter.maydell, Wei Yang
The first one is suggested by Igor Mammedov to provide rule for multiline
code.
The second is a trivial fix to make example code all indented with 4 spaces.
v4:
* one exception case for function
v3:
* fix typo in both changelog and example
v2:
* adjust Patch 1 as suggested by Eric
Wei Yang (2):
CODING_STYLE: specify the indent rule for multiline code
CODING_STYLE: indent example code as all others
CODING_STYLE | 37 +++++++++++++++++++++++++++++++++----
1 file changed, 33 insertions(+), 4 deletions(-)
--
2.19.1
^ permalink raw reply [flat|nested] 6+ messages in thread
* [Qemu-devel] [PATCH v4 1/2] CODING_STYLE: specify the indent rule for multiline code
2019-02-25 1:25 [Qemu-devel] [PATCH v4 0/2] CODING_STYLE: trivial update Wei Yang
@ 2019-02-25 1:25 ` Wei Yang
2019-02-28 14:36 ` Igor Mammedov
2019-02-25 1:25 ` [Qemu-devel] [PATCH v4 2/2] CODING_STYLE: indent example code as all others Wei Yang
1 sibling, 1 reply; 6+ messages in thread
From: Wei Yang @ 2019-02-25 1:25 UTC (permalink / raw)
To: qemu-devel, qemu-trivial
Cc: mjt, imammedo, philmd, eblake, peter.maydell, Wei Yang
We didn't specify the indent rule for multiline code here, which may
mislead users. And in current code, the code use different rules.
Add this rule in CODING_STYLE to make sure this is clear to every one.
Signed-off-by: Wei Yang <richardw.yang@linux.intel.com>
Suggested-by: Igor Mammedov <imammedo@redhat.com>
---
v4:
* widths -> width
* add an exception example for function
v3:
* misleading -> mislead
* add comma after arg2 in example
v2:
* rephrase changelog suggested by Eric Blake
- remove one redundant line
- fix some awkward grammar
- add { ; at the end of example
---
CODING_STYLE | 29 +++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)
diff --git a/CODING_STYLE b/CODING_STYLE
index ec075dedc4..1bccf4f865 100644
--- a/CODING_STYLE
+++ b/CODING_STYLE
@@ -29,6 +29,35 @@ Spaces of course are superior to tabs because:
Do not leave whitespace dangling off the ends of lines.
+1.1 Multiline Indent
+
+There are several places where indent is necessary:
+
+ - struct definition
+ - if/else
+ - while/for
+ - function definition & call
+
+When breaking up a long line to fit within line width, align the secondary
+lines just after the opening parenthesis of the first.
+
+For example:
+
+ if (a == 1 &&
+ b == 2) {
+
+ while (a == 1 &&
+ b == 2) {
+
+ do_something(arg1, arg2,
+ arg3);
+
+One exception for function is indenting following lines relative to function
+name start:
+
+ do_something(arg1, arg2,
+ arg3);
+
2. Line width
Lines should be 80 characters; try not to make them longer.
--
2.19.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [Qemu-devel] [PATCH v4 2/2] CODING_STYLE: indent example code as all others
2019-02-25 1:25 [Qemu-devel] [PATCH v4 0/2] CODING_STYLE: trivial update Wei Yang
2019-02-25 1:25 ` [Qemu-devel] [PATCH v4 1/2] CODING_STYLE: specify the indent rule for multiline code Wei Yang
@ 2019-02-25 1:25 ` Wei Yang
2019-02-28 15:19 ` Igor Mammedov
1 sibling, 1 reply; 6+ messages in thread
From: Wei Yang @ 2019-02-25 1:25 UTC (permalink / raw)
To: qemu-devel, qemu-trivial
Cc: mjt, imammedo, philmd, eblake, peter.maydell, Wei Yang
All the example code are indented with four spaces except this one.
Fix this by adding four spaces here.
Signed-off-by: Wei Yang <richardw.yang@linux.intel.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
---
CODING_STYLE | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/CODING_STYLE b/CODING_STYLE
index 1bccf4f865..e6d21dcd67 100644
--- a/CODING_STYLE
+++ b/CODING_STYLE
@@ -137,10 +137,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" */
+ 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 '=',
--
2.19.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [Qemu-devel] [PATCH v4 1/2] CODING_STYLE: specify the indent rule for multiline code
2019-02-25 1:25 ` [Qemu-devel] [PATCH v4 1/2] CODING_STYLE: specify the indent rule for multiline code Wei Yang
@ 2019-02-28 14:36 ` Igor Mammedov
2019-03-01 1:27 ` Wei Yang
0 siblings, 1 reply; 6+ messages in thread
From: Igor Mammedov @ 2019-02-28 14:36 UTC (permalink / raw)
To: Wei Yang; +Cc: qemu-devel, qemu-trivial, mjt, philmd, eblake, peter.maydell
On Mon, 25 Feb 2019 09:25:29 +0800
Wei Yang <richardw.yang@linux.intel.com> wrote:
> We didn't specify the indent rule for multiline code here, which may
> mislead users. And in current code, the code use different rules.
diffrent from what? I'd use "various styles"
>
> Add this rule in CODING_STYLE to make sure this is clear to every one.
>
> Signed-off-by: Wei Yang <richardw.yang@linux.intel.com>
> Suggested-by: Igor Mammedov <imammedo@redhat.com>
>
> ---
> v4:
> * widths -> width
> * add an exception example for function
> v3:
> * misleading -> mislead
> * add comma after arg2 in example
> v2:
> * rephrase changelog suggested by Eric Blake
> - remove one redundant line
> - fix some awkward grammar
> - add { ; at the end of example
> ---
> CODING_STYLE | 29 +++++++++++++++++++++++++++++
> 1 file changed, 29 insertions(+)
>
> diff --git a/CODING_STYLE b/CODING_STYLE
> index ec075dedc4..1bccf4f865 100644
> --- a/CODING_STYLE
> +++ b/CODING_STYLE
> @@ -29,6 +29,35 @@ Spaces of course are superior to tabs because:
>
> Do not leave whitespace dangling off the ends of lines.
>
> +1.1 Multiline Indent
> +
> +There are several places where indent is necessary:
> +
> + - struct definition
> + - if/else
> + - while/for
> + - function definition & call
> +
> +When breaking up a long line to fit within line width, align the secondary
> +lines just after the opening parenthesis of the first.
Probably it's not true for struct/function, they could use 4 spaces indent
relative to previous line. I'd drop struct as it just follow generic block
4 spaces rule. And describe possible function variants separately
> +
> +For example:
> +
> + if (a == 1 &&
> + b == 2) {
> +
> + while (a == 1 &&
> + b == 2) {
> +
> + do_something(arg1, arg2,
> + arg3);
> +
> +One exception for function is indenting following lines relative to function
> +name start:
it's not really exception and used not only with functions, it's basically
generic 4 spaces indent. Another variant I've seen used is
foo(x, y(z,
h);
and variations of that
> +
> + do_something(arg1, arg2,
> + arg3);
> +
> 2. Line width
>
> Lines should be 80 characters; try not to make them longer.
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [Qemu-devel] [PATCH v4 2/2] CODING_STYLE: indent example code as all others
2019-02-25 1:25 ` [Qemu-devel] [PATCH v4 2/2] CODING_STYLE: indent example code as all others Wei Yang
@ 2019-02-28 15:19 ` Igor Mammedov
0 siblings, 0 replies; 6+ messages in thread
From: Igor Mammedov @ 2019-02-28 15:19 UTC (permalink / raw)
To: Wei Yang; +Cc: qemu-devel, qemu-trivial, mjt, philmd, eblake, peter.maydell
On Mon, 25 Feb 2019 09:25:30 +0800
Wei Yang <richardw.yang@linux.intel.com> 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 <richardw.yang@linux.intel.com>
> Reviewed-by: Eric Blake <eblake@redhat.com>
> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Reviewed-by: Igor Mammedov <imammedo@redhat.com>
> ---
> CODING_STYLE | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/CODING_STYLE b/CODING_STYLE
> index 1bccf4f865..e6d21dcd67 100644
> --- a/CODING_STYLE
> +++ b/CODING_STYLE
> @@ -137,10 +137,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" */
> + 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 '=',
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [Qemu-devel] [PATCH v4 1/2] CODING_STYLE: specify the indent rule for multiline code
2019-02-28 14:36 ` Igor Mammedov
@ 2019-03-01 1:27 ` Wei Yang
0 siblings, 0 replies; 6+ messages in thread
From: Wei Yang @ 2019-03-01 1:27 UTC (permalink / raw)
To: Igor Mammedov, g
Cc: Wei Yang, qemu-devel, qemu-trivial, mjt, philmd, eblake, peter.maydell
On Thu, Feb 28, 2019 at 03:36:14PM +0100, Igor Mammedov wrote:
>On Mon, 25 Feb 2019 09:25:29 +0800
>Wei Yang <richardw.yang@linux.intel.com> wrote:
>
>> We didn't specify the indent rule for multiline code here, which may
>> mislead users. And in current code, the code use different rules.
>diffrent from what? I'd use "various styles"
>
>>
>> Add this rule in CODING_STYLE to make sure this is clear to every one.
>>
>> Signed-off-by: Wei Yang <richardw.yang@linux.intel.com>
>> Suggested-by: Igor Mammedov <imammedo@redhat.com>
>>
>> ---
>> v4:
>> * widths -> width
>> * add an exception example for function
>> v3:
>> * misleading -> mislead
>> * add comma after arg2 in example
>> v2:
>> * rephrase changelog suggested by Eric Blake
>> - remove one redundant line
>> - fix some awkward grammar
>> - add { ; at the end of example
>> ---
>> CODING_STYLE | 29 +++++++++++++++++++++++++++++
>> 1 file changed, 29 insertions(+)
>>
>> diff --git a/CODING_STYLE b/CODING_STYLE
>> index ec075dedc4..1bccf4f865 100644
>> --- a/CODING_STYLE
>> +++ b/CODING_STYLE
>> @@ -29,6 +29,35 @@ Spaces of course are superior to tabs because:
>>
>> Do not leave whitespace dangling off the ends of lines.
>>
>> +1.1 Multiline Indent
>> +
>> +There are several places where indent is necessary:
>> +
>> + - struct definition
>> + - if/else
>> + - while/for
>> + - function definition & call
>> +
>> +When breaking up a long line to fit within line width, align the secondary
>> +lines just after the opening parenthesis of the first.
> Probably it's not true for struct/function, they could use 4 spaces indent
> relative to previous line. I'd drop struct as it just follow generic block
> 4 spaces rule. And describe possible function variants separately
>
That sounds reasonable. Let me adjust this.
>
>> +
>> +For example:
>> +
>> + if (a == 1 &&
>> + b == 2) {
>> +
>> + while (a == 1 &&
>> + b == 2) {
>> +
>> + do_something(arg1, arg2,
>> + arg3);
>> +
>> +One exception for function is indenting following lines relative to function
>> +name start:
>it's not really exception and used not only with functions, it's basically
>generic 4 spaces indent. Another variant I've seen used is
> foo(x, y(z,
> h);
>and variations of that
>
>
>> +
>> + do_something(arg1, arg2,
>> + arg3);
>> +
>> 2. Line width
>>
>> Lines should be 80 characters; try not to make them longer.
--
Wei Yang
Help you, Help me
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2019-03-01 1:35 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-02-25 1:25 [Qemu-devel] [PATCH v4 0/2] CODING_STYLE: trivial update Wei Yang
2019-02-25 1:25 ` [Qemu-devel] [PATCH v4 1/2] CODING_STYLE: specify the indent rule for multiline code Wei Yang
2019-02-28 14:36 ` Igor Mammedov
2019-03-01 1:27 ` Wei Yang
2019-02-25 1:25 ` [Qemu-devel] [PATCH v4 2/2] CODING_STYLE: indent example code as all others Wei Yang
2019-02-28 15:19 ` Igor Mammedov
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.