Skip to contentSkip to conversation

Get coding style closer to the real world

PATCH In review Alexander Graf 5 participants 6 messages Nov 30, 2009 – Dec 5, 2009

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Get coding style closer to the real world

Currently we have this stupid role of disallowing:

if (r)

      break;

By disallowing this we clutter the code, making it less readable without buying us anything. In fact, nobody actually sticks to this because it'd show just how much bad taste the programmer doing this would have.

So IMHO we should change the coding style, so we can finally focus on programming again and don't focus on useless coding style rules.

---
 CODING_STYLE |   23 ++++++++++++++++++-----
 1 files changed, 18 insertions(+), 5 deletions(-)
CODING_STYLE +18 -5
index a579cb1..806a1f8 100644
@@ -51,11 +51,24 @@ QEMU coding style.
 
 4. Block structure
 
-Every indented statement is braced; even if the block contains just one
-statement.  The opening brace is on the line that contains the control
-flow statement that introduces the new block; the closing brace is on the
-same line as the else keyword, or on a line by itself if there is no else
-keyword.  Example:
+Usually indented statements are braced; even if the block contains just one
+statement. When braces reduce readability, they are not mandatory.
+
+Examples:
+
+    if (a == 5)
+        break;
+
+    if (b == 6) {
+        c = do_something();
+        /* Probably more code to be added here later */
+    }
+
+The opening brace is on the line that contains the control flow statement
+that introduces the new block; the closing brace is on the same line as
+the else keyword, or on a line by itself if there is no else keyword.
+
+Example:
 
     if (a == 5) {
         printf("a was 5.\n");
Signature · 1 line
1.6.0.2
#1 lore raw
Quoted 5 lines · Alexander Graf

Currently we have this stupid role of disallowing:

if (r)

      break;
Quoted 8 lines

By disallowing this we clutter the code, making it less readable without buying us anything. In fact, nobody actually sticks to this because it'd show just how much bad taste the programmer doing this would have.

So IMHO we should change the coding style, so we can finally focus on programming again and don't focus on useless coding style rules.

ACK

#2 lore raw
In reply to Alexander Graf
Quoted 4 lines · Alexander Graf

Currently we have this stupid role of disallowing:

if (r)

      break;

This has been discussed to death several times, in several different paces, and with no clear resolution or consensus, so I'm going to make an executive decision:

The coding style stays as-is. Braces are required. Please ensure that all patches follow the coding style. There may be exceptions, but there should be a *good* reason for deviation.

If there are real problems or ambiguities in the coding style then I am willing to consider fixing it. This particular change meets neither criteria.

By picking a single coding style we've pretty much guaranteed that most people will disagree with some of it. IMO consistency is more important.

Paul

#3 lore raw
Quoted 8 lines · Paul Brook
Quoted 5 lines · Alexander Graf

Currently we have this stupid role of disallowing:

if (r)

      break;
Quoted 9 lines

This has been discussed to death several times, in several different paces, and with no clear resolution or consensus, so I'm going to make an executive decision:

The coding style stays as-is. Braces are required. Please ensure that all patches follow the coding style. There may be exceptions, but there should be a *good* reason for deviation.

If there are real problems or ambiguities in the coding style then I am willing to consider fixing it. This particular change meets neither criteria.

By picking a single coding style we've pretty much guaranteed that most people will disagree with some of it. IMO consistency is more important.

I agree 100%.

Regards,

Anthony Liguori

Quoted 4 lines

Paul

#4 lore raw
Quoted 9 lines · Anthony Liguori
Quoted 8 lines · Paul Brook
Quoted 4 lines · Alexander Graf

Currently we have this stupid role of disallowing:

if (r)

      break;

This has been discussed to death several times, in several different paces, and with no clear resolution or consensus, so I'm going to make an executive decision:

Quoted 8 lines
Quoted 6 lines

The coding style stays as-is. Braces are required. Please ensure that all patches follow the coding style. There may be exceptions, but there should be a *good* reason for deviation.

If there are real problems or ambiguities in the coding style then I am willing to consider fixing it. This particular change meets neither criteria.

By picking a single coding style we've pretty much guaranteed that most people will disagree with some of it. IMO consistency is more important.

I agree 100%.

+1'ed, and I note that although brace-happy code looks more cluttered it is a bit safer and produces cleaner patches.

Signature · 1 line
Do not meddle in the internals of kernels, for they are subtle and quick to panic.
#5 lore raw
In reply to Paul Brook
Quoted 15 lines · Paul Brook
Quoted 4 lines · Alexander Graf

Currently we have this stupid role of disallowing:

if (r)

     break;

This has been discussed to death several times, in several different paces, and with no clear resolution or consensus, so I'm going to make an executive decision:

The coding style stays as-is. Braces are required. Please ensure that all patches follow the coding style. There may be exceptions, but there should be a *good* reason for deviation.

Quoted 5 lines

If there are real problems or ambiguities in the coding style then I am willing to consider fixing it. This particular change meets neither criteria.

By picking a single coding style we've pretty much guaranteed that most people will disagree with some of it. IMO consistency is more important.

Could we please convert all the code base to the new style then? For exactly the consistency reason.

Alex