CODING_STYLE: trivial update
v5 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.
v5:
* mostly address function variants
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 | 47 +++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 43 insertions(+), 4 deletions(-)
Signature · 1 line
2.19.1
PATCH v5 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 various styles.
Add this rule in CODING_STYLE to make sure this is clear to every one.
---
v5:
* different rules -> various styles
* describe function variants separately
* take struct out
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 | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+)
CODING_STYLE +39 -0
@@ -29,6 +29,45 @@ 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: + + - if/else + - while/for + - function definition & call + +When breaking up a long line to fit within line width, we need a proper indent +for the following lines. + +In case of if/else, while/for, align the secondary lines just after the +opening parenthesis of the first. + +For example: + + if (a == 1 && + b == 2) { + + while (a == 1 && + b == 2) { + +In case of function, there are several variants: + + * 4 spaces indent from the beginning + * align the secondary lines just after the opening parenthesis of the + first + +For example: + + do_something(x, y, + z); + + do_something(x, y, + z); + + do_something(x, do_another(y, + z); + 2. Line width Lines should be 80 characters; try not to make them longer.
Signature · 1 line
2.19.1
Re: [Qemu-devel] [PATCH v5 1/2] CODING_STYLE: specify the indent rule for multiline code
Quoted 64 lines · Wei Yang
We didn't specify the indent rule for multiline code here, which may mislead users. And in current code, the code use various styles.
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]>---
v5:
* different rules -> various styles
* describe function variants separately
* take struct out
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 | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+)CODING_STYLE +28
-0@@ -29,6 +29,45 @@ 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: + + - if/else + - while/for + - function definition & call + +When breaking up a long line to fit within line width, we need a proper indent +for the following lines. + +In case of if/else, while/for, align the secondary lines just after the +opening parenthesis of the first. + +For example: + + if (a == 1 && + b == 2) { + + while (a == 1 && + b == 2) { + +In case of function, there are several variants: + + * 4 spaces indent from the beginning + * align the secondary lines just after the opening parenthesis of the + first +
CODING_STYLE Spaces of course are superior to tabs because: · line 69
Quoted 10 lines
CODING_STYLE +10
-0+For example: + + do_something(x, y, + z); + + do_something(x, y, + z); + + do_something(x, do_another(y, + z);
Should we close another parenthesis after the "z"?
The rest LGTM!
Thanks,
Stefano
Re: [Qemu-devel] [PATCH v5 1/2] CODING_STYLE: specify the indent rule for multiline code
Quoted 69 lines · Stefano Garzarella
Quoted 68 lines · Wei Yang
We didn't specify the indent rule for multiline code here, which may mislead users. And in current code, the code use various styles.
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]>---
v5:
* different rules -> various styles
* describe function variants separately
* take struct out
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 | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+)CODING_STYLE +32
-0@@ -29,6 +29,45 @@ 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: + + - if/else + - while/for + - function definition & call + +When breaking up a long line to fit within line width, we need a proper indent +for the following lines. + +In case of if/else, while/for, align the secondary lines just after the +opening parenthesis of the first. + +For example: + + if (a == 1 && + b == 2) { + + while (a == 1 && + b == 2) { + +In case of function, there are several variants: + + * 4 spaces indent from the beginning + * align the secondary lines just after the opening parenthesis of the + first + +For example: + + do_something(x, y, + z);
Quoted 9 lines
CODING_STYLE Spaces of course are superior to tabs because: · line 69
Quoted 6 lines
CODING_STYLE +6
-0+ + do_something(x, y, + z); + + do_something(x, do_another(y, + z);Should we close another parenthesis after the "z"?
:-(
Quoted 4 lines
The rest LGTM!
Thanks,
Stefano
Signature · 2 lines
Wei Yang Help you, Help me
PATCH v5 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
@@ -147,10 +147,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