CODING_STYLE: trivial update
v2 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.
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 | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-)
Signature · 1 line
2.19.1
PATCH v2 1/2 CODING_STYLE: specify the indent rule for multiline code
We didn't specify the indent rule for multiline code here, which may misleading 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.
---
v2:
* rephrase changelog suggested by Eric Blake
- remove one redundant line
- fix some awkward grammar
- add { ; at the end of example
--- CODING_STYLE | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+)
CODING_STYLE +23 -0
@@ -29,6 +29,29 @@ 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 widths, 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); + 2. Line width Lines should be 80 characters; try not to make them longer.
Signature · 1 line
2.19.1
Re: [Qemu-devel] [PATCH v2 1/2] CODING_STYLE: specify the indent rule for multiline code
Quoted 2 lines · Wei Yang
We didn't specify the indent rule for multiline code here, which may misleading users. And in current code, the code use different rules.
s/misleading/mislead/
Quoted 16 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]>---
v2:
* rephrase changelog suggested by Eric Blake
- remove one redundant line
- fix some awkward grammar
- add { ; at the end of example--- CODING_STYLE | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+)
CODING_STYLE Spaces of course are superior to tabs because: · line 53
Quoted 3 lines
CODING_STYLE +3
-0+ + do_something(arg1, arg2 + arg3);
Missing a comma after arg2. With that fixed,
Signature · 3 lines
Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3226 Virtualization: qemu.org | libvirt.org
Re: [Qemu-devel] [PATCH v2 1/2] CODING_STYLE: specify the indent rule for multiline code
Quoted 22 lines · Eric Blake
Quoted 2 lines · Wei Yang
We didn't specify the indent rule for multiline code here, which may misleading users. And in current code, the code use different rules.
s/misleading/mislead/
Quoted 15 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]>---
v2:
* rephrase changelog suggested by Eric Blake
- remove one redundant line
- fix some awkward grammar
- add { ; at the end of example--- CODING_STYLE | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+)
Quoted 6 lines
CODING_STYLE Spaces of course are superior to tabs because: · line 53
Quoted 3 lines
CODING_STYLE +3
-0+ + do_something(arg1, arg2 + arg3);Missing a comma after arg2. With that fixed,
Reviewed-by Eric Blake <[email protected]>
You are right.
Quoted 5 lines
Signature · 4 lines
-- Eric Blake, Principal Software Engineer Red Hat, Inc. +1-919-301-3226 Virtualization: qemu.org | libvirt.org
Signature · 2 lines
Wei Yang Help you, Help me
PATCH v2 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
@@ -131,10 +131,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