CODING_STYLE: trivial update
v4 cover CODING_STYLE: trivial update
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(-)
Signature · 1 line
2.19.1
PATCH v4 1/2 CODING_STYLE: specify the indent rule for multiline code
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.
---
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(+)
CODING_STYLE +29 -0
@@ -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.
Signature · 1 line
2.19.1
Re: [Qemu-devel] [PATCH v4 1/2] CODING_STYLE: specify the indent rule for multiline code
Quoted 2 lines · On Mon, 25 Feb 2019 09:25:29 +0800 Wei Yang <[email protected]>…
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"
Quoted 31 lines
Add this rule in
CODING_STYLEto make sure this is clear to every one.Signed-off-by Wei Yang <[email protected]>Suggested-by Igor Mammedov <[email protected]>---
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(+)CODING_STYLE +1
-0@@ -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
CODING_STYLE Spaces of course are superior to tabs because: · line 42
Quoted 10 lines
CODING_STYLE +10
-0+ +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
Quoted 4 lines
CODING_STYLE +4
-0+ +For example: + + if (a == 1 &&
CODING_STYLE Spaces of course are superior to tabs because: · line 56
Quoted 10 lines
CODING_STYLE +10
-0+ 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
Quoted 7 lines
CODING_STYLE +4
-0+ + do_something(arg1, arg2, + arg3); + 2. Line width Lines should be 80 characters; try not to make them longer.
Re: [Qemu-devel] [PATCH v4 1/2] CODING_STYLE: specify the indent rule for multiline code
Quoted 37 lines · Igor Mammedov
Quoted 2 lines · On Mon, 25 Feb 2019 09:25:29 +0800 Wei Yang <[email protected]>…
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"
Quoted 30 lines
Add this rule in
CODING_STYLEto make sure this is clear to every one.Signed-off-by Wei Yang <[email protected]>Suggested-by Igor Mammedov <[email protected]>---
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(+)CODING_STYLE +0
-0@@ -29,6 +29,35 @@ Spaces of course are superior to tabs because: Do not leave whitespace dangling off the ends of lines.
Quoted 15 lines
CODING_STYLE Spaces of course are superior to tabs because: · line 42
Quoted 11 lines
CODING_STYLE +11
-0+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.
Quoted 29 lines
Quoted 5 lines
CODING_STYLE +4
-0+ +For example: + + if (a == 1 &&CODING_STYLE Spaces of course are superior to tabs because: · line 56
Quoted 10 lines
CODING_STYLE +10
-0+ 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
Quoted 7 lines
CODING_STYLE +4
-0+ + do_something(arg1, arg2, + arg3); + 2. Line width Lines should be 80 characters; try not to make them longer.
Signature · 2 lines
Wei Yang Help you, Help me
PATCH v4 2/2 CODING_STYLE: indent example code as all others
In reply to Wei YangAll the example code are indented with four spaces except this one.
Fix this by adding four spaces here.
--- CODING_STYLE | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
CODING_STYLE +4 -4
@@ -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 '=',
Signature · 1 line
2.19.1
Re: [Qemu-devel] [PATCH v4 2/2] CODING_STYLE: indent example code as all others
Quoted 7 lines · On Mon, 25 Feb 2019 09:25:30 +0800 Wei Yang <[email protected]>…
All the example code are indented with four spaces except this one.
Fix this by adding four spaces here.
Signed-off-by Wei Yang <[email protected]>Reviewed-by Eric Blake <[email protected]>Reviewed-by Philippe Mathieu-Daudé <[email protected]>
Quoted 23 lines
--- CODING_STYLE | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)CODING_STYLE +4
-4@@ -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 '=',