Skip to contentSkip to conversation

CODING_STYLE: trivial update

PATCH Superseded Wei Yang 3 participants 5 messages Feb 20, 2019 – Feb 23, 2019

v3 of 6 Superseded Latest is v6 →

lore
Share & tools
lore

Wei Yang

author
#0 lore raw

v3 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.

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 | 31 +++++++++++++++++++++++++++----
 1 file changed, 27 insertions(+), 4 deletions(-)
Signature · 1 line
2.19.1
author
#1 lore raw

PATCH v3 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.

---
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

c1

---
 CODING_STYLE | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
CODING_STYLE +23 -0
index ec075dedc4..1359f9ab81 100644
@@ -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
#2 lore raw

Re: [Qemu-devel] [PATCH v3 1/2] CODING_STYLE: specify the indent rule for multiline code

Quoted 32 lines · On Wed, 20 Feb 2019 11:15:56 +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.

Add this rule in CODING_STYLE to make sure this is clear to every one.

---
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

c1

---
 CODING_STYLE | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
CODING_STYLE +0 -0
index ec075dedc4..1359f9ab81 100644
@@ -29,6 +29,29 @@ Spaces of course are superior to tabs because:
 
 Do not leave whitespace dangling off the ends of lines.
 

CODING_STYLE Spaces of course are superior to tabs because: · line 41

Quoted 10 lines
CODING_STYLE +10 -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 widths, align the secondary

s/widths/width/

CODING_STYLE Spaces of course are superior to tabs because: · line 54

Quoted 13 lines
CODING_STYLE +13 -0
+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);
+

there is also another widely used acceptable pattern
func_name(arg1, arg2,

      arg3)

where we indent relative to function name start (sound weird to me but I'm not sure how to word it properly)

Quoted 3 lines
CODING_STYLE +0 -0
 2. Line width
 
 Lines should be 80 characters; try not to make them longer.
#3 lore raw

Re: [Qemu-devel] [PATCH v3 1/2] CODING_STYLE: specify the indent rule for multiline code

Quoted 63 lines · Igor Mammedov
Quoted 32 lines · On Wed, 20 Feb 2019 11:15:56 +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.

Add this rule in CODING_STYLE to make sure this is clear to every one.

---
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

c1

---
 CODING_STYLE | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
CODING_STYLE +0 -0
index ec075dedc4..1359f9ab81 100644
@@ -29,6 +29,29 @@ Spaces of course are superior to tabs because:
 
 Do not leave whitespace dangling off the ends of lines.
 

CODING_STYLE Spaces of course are superior to tabs because: · line 41

Quoted 10 lines
CODING_STYLE +10 -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 widths, align the secondary

s/widths/width/

CODING_STYLE Spaces of course are superior to tabs because: · line 54

Quoted 13 lines
CODING_STYLE +13 -0
+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);
+

there is also another widely used acceptable pattern
func_name(arg1, arg2,

Quoted 5 lines
     arg3)

where we indent relative to function name start (sound weird to me but I'm not sure how to word it properly)

Hmm... we may need to add this exception case.

Quoted 4 lines
Quoted 3 lines
CODING_STYLE +0 -0
 2. Line width
 
 Lines should be 80 characters; try not to make them longer.
Signature · 2 lines
Wei Yang
Help you, Help me
author
#4 lore raw

PATCH v3 2/2 CODING_STYLE: indent example code as all others

In reply to Wei Yang

All 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
index 1359f9ab81..b1f5414b73 100644
@@ -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