Skip to contentSkip to conversation

Document QEMU coding style (v2)

PATCH Applied Avi Kivity 6 participants 7 messages Mar 31, 2009 – Apr 5, 2009

lore
Share & tools
lore

Avi Kivity

author
#0 lore raw

PATCH 1/1 Document QEMU coding style (v2)

With the help of some Limoncino I noted several aspects of the QEMU coding style, particularly where it differs from the Linux coding style as many contributors work on both projects.

Changes from v1:
- s/Qemu/QEMU/
- s/Posix/POSIX/
- note that the _t suffix is not POSIX compliant, and will be changed
- discourage eol whitespace
- be strict about the 80 char line width

---
 CODING_STYLE |   78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 78 insertions(+), 0 deletions(-)
 create mode 100644 CODING_STYLE
CODING_STYLE new file +78 -0
new file mode 100644
index 0000000..1ab13b6
@@ -0,0 +1,78 @@
+Qemu Coding Style
+=================
+
+1. Whitespace
+
+Of course, the most important aspect in any coding style is whitespace.
+Crusty old coders who have trouble spotting the glasses on their noses
+can tell the difference between a tab and eight spaces from a distance
+of approximately fifteen parsecs.  Many a flamewar have been fought and
+lost on this issue.
+
+QEMU indents are four spaces.  Tabs are never used, except in Makefiles
+where they have been irreversibly coded into the syntax by some moron.
+Spaces of course are superior to tabs because:
+
+ - You have just one way to specify whitespace, not two.  Ambiguity breeds
+   mistakes.
+ - The confusion surrounding 'use tabs to indent, spaces to justify' is gone.
+ - Tab indents push your code to the right, making your screen seriously
+   unbalanced.
+ - Tabs will be rendered incorrectly on editors who are misconfigured not
+   to use tab stops of eight positions.
+ - Tabs are rendered badly in patches, causing off-by-one errors in almost
+   every line.
+ - It is the QEMU coding style.
+
+Do not leave whitespace dangling off the ends of lines.
+
+2. Line width
+
+Lines are 80 characters; not longer.
+
+Rationale:
+ - Some people like to tile their 24" screens with a 6x4 matrix of 80x24
+   xterms and use vi in all of them.  The best way to punish them is to
+   let them keep doing it.
+ - Code and especially patches is much more readable if limited to a sane
+   line length.  Eighty is traditional.
+ - It is the QEMU coding style.
+
+3. Naming
+
+Variables are lower_case_with_underscores; easy to type and read.  Structured
+type names are in CamelCase; harder to type but standing out.  Scalar type
+names are lower_case_with_underscores_ending_with_a_t, like the POSIX
+uint64_t and family.  Note that this last convention contradicts POSIX
+and is therefore likely to be changed.
+
+Typedefs are used to eliminate the redundant 'struct' keyword.  It is the
+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:
+
+    if (a == 5) {
+        printf("a was 5.\n");
+    } else if (a == 6) {
+        printf("a was 6.\n");
+    } else {
+        printf("a was something else entirely.\n");
+    }
+
+An exception is the opening brace for a function; for reasons of tradition
+and clarity it comes on a line by itself:
+
+    void a_function(void)
+    {
+        do_something();
+    }
+
+Rationale: a consistent (except for functions...) bracing style reduces
+ambiguity and avoids needless churn when lines are added or removed.
+Furthermore, it is the QEMU coding style.
Signature · 1 line
1.6.1.1
#1 lore raw
Quoted 27 lines · Avi Kivity

With the help of some Limoncino I noted several aspects of the QEMU coding style, particularly where it differs from the Linux coding style as many contributors work on both projects.

Changes from v1:
- s/Qemu/QEMU/
- s/Posix/POSIX/
- note that the _t suffix is not POSIX compliant, and will be changed
- discourage eol whitespace
- be strict about the 80 char line width

---
 CODING_STYLE |   78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 78 insertions(+), 0 deletions(-)
 create mode 100644 CODING_STYLE
CODING_STYLE new file +4 -0
new file mode 100644
index 0000000..1ab13b6
@@ -0,0 +1,78 @@
+Qemu Coding Style
+=================
+
+1. Whitespace

CODING_STYLE line 14

Quoted 10 lines
CODING_STYLE new file +10 -0
+
+Of course, the most important aspect in any coding style is whitespace.
+Crusty old coders who have trouble spotting the glasses on their noses
+can tell the difference between a tab and eight spaces from a distance
+of approximately fifteen parsecs.  Many a flamewar have been fought and
+lost on this issue.
+
+QEMU indents are four spaces.  Tabs are never used, except in Makefiles
+where they have been irreversibly coded into the syntax by some moron.
+Spaces of course are superior to tabs because:

Hi I'd appreciate it if we removed the insults and the arrogance, i.e skip the "moron" and the of courses. Other than that most of this stuff looks acceptable to me, although I don't necessarily agree with all of it :)

Thanks

Quoted 68 lines
CODING_STYLE new file +64 -0
+
+ - You have just one way to specify whitespace, not two.  Ambiguity breeds
+   mistakes.
+ - The confusion surrounding 'use tabs to indent, spaces to justify' is gone.
+ - Tab indents push your code to the right, making your screen seriously
+   unbalanced.
+ - Tabs will be rendered incorrectly on editors who are misconfigured not
+   to use tab stops of eight positions.
+ - Tabs are rendered badly in patches, causing off-by-one errors in almost
+   every line.
+ - It is the QEMU coding style.
+
+Do not leave whitespace dangling off the ends of lines.
+
+2. Line width
+
+Lines are 80 characters; not longer.
+
+Rationale:
+ - Some people like to tile their 24" screens with a 6x4 matrix of 80x24
+   xterms and use vi in all of them.  The best way to punish them is to
+   let them keep doing it.
+ - Code and especially patches is much more readable if limited to a sane
+   line length.  Eighty is traditional.
+ - It is the QEMU coding style.
+
+3. Naming
+
+Variables are lower_case_with_underscores; easy to type and read.  Structured
+type names are in CamelCase; harder to type but standing out.  Scalar type
+names are lower_case_with_underscores_ending_with_a_t, like the POSIX
+uint64_t and family.  Note that this last convention contradicts POSIX
+and is therefore likely to be changed.
+
+Typedefs are used to eliminate the redundant 'struct' keyword.  It is the
+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:
+
+    if (a == 5) {
+        printf("a was 5.\n");
+    } else if (a == 6) {
+        printf("a was 6.\n");
+    } else {
+        printf("a was something else entirely.\n");
+    }
+
+An exception is the opening brace for a function; for reasons of tradition
+and clarity it comes on a line by itself:
+
+    void a_function(void)
+    {
+        do_something();
+    }
+
+Rationale: a consistent (except for functions...) bracing style reduces
+ambiguity and avoids needless churn when lines are added or removed.
+Furthermore, it is the QEMU coding style.
Signature · 1 line
1.6.1.1
#2 lore raw
Quoted 33 lines · Edgar E. Iglesias
Quoted 32 lines · Avi Kivity

With the help of some Limoncino I noted several aspects of the QEMU coding style, particularly where it differs from the Linux coding style as many contributors work on both projects.

Changes from v1:
- s/Qemu/QEMU/
- s/Posix/POSIX/
- note that the _t suffix is not POSIX compliant, and will be changed
- discourage eol whitespace
- be strict about the 80 char line width

---
 CODING_STYLE |   78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 78 insertions(+), 0 deletions(-)
 create mode 100644 CODING_STYLE
CODING_STYLE new file +9 -0
new file mode 100644
index 0000000..1ab13b6
@@ -0,0 +1,78 @@
+Qemu Coding Style
+=================
+
+1. Whitespace
+
+Of course, the most important aspect in any coding style is whitespace.
+Crusty old coders who have trouble spotting the glasses on their noses
+can tell the difference between a tab and eight spaces from a distance
+of approximately fifteen parsecs.  Many a flamewar have been fought and
Quoted 8 lines

CODING_STYLE line 14

Quoted 5 lines
CODING_STYLE new file +5 -0
+lost on this issue.
+
+QEMU indents are four spaces.  Tabs are never used, except in Makefiles
+where they have been irreversibly coded into the syntax by some moron.
+Spaces of course are superior to tabs because:

Hi

Hi,

Quoted 1 line

I'd appreciate it if we removed the insults and the arrogance, i.e

[...]

Perhaps it is humor ?

(Limoncino doesn't help...)

Regards,
Laurent

Signature · 3 lines
------------------ [email protected]  ------------------
"Tout ce qui est impossible reste à accomplir"    Jules Verne
"Things are only impossible until they're not" Jean-Luc Picard
#3 lore raw
Quoted 12 lines · Laurent Vivier
Quoted 9 lines · Edgar E. Iglesias

CODING_STYLE line 14

Quoted 5 lines · Avi Kivity
CODING_STYLE new file +4 -0
+
+QEMU indents are four spaces.  Tabs are never used, except in Makefiles
+where they have been irreversibly coded into the syntax by some moron.
+Spaces of course are superior to tabs because:

Hi

Quoted 10 lines

Hi,

Quoted 2 lines

I'd appreciate it if we removed the insults and the arrogance, i.e

[...]

Perhaps it is humor ?

I don't think so. Stuart Feldman won an ACM award for Make: http://www.acm.org/announcements/softwaresystemaward.3-24-04.html. Merely disliking something does not make its author a moron.

jch

author
#4 lore raw
Quoted 3 lines · John Haxby
Quoted 2 lines

Perhaps it is humor ?

I don't think so. Stuart Feldman won an ACM award for Make: http://www.acm.org/announcements/softwaresystemaward.3-24-04.html. Merely disliking something does not make its author a moron.

I didn't think would be it needed to be said, but of course the intent was humorous.

If people find it offensive I can remove it though.

Signature · 2 lines
I have a truly marvellous patch that fixes the bug which this
signature is too narrow to contain.
#5 lore raw
In reply to Edgar E. Iglesias
Quoted 34 lines · Edgar E. Iglesias
Quoted 33 lines · Avi Kivity

With the help of some Limoncino I noted several aspects of the QEMU coding style, particularly where it differs from the Linux coding style as many contributors work on both projects.

Changes from v1:
- s/Qemu/QEMU/
- s/Posix/POSIX/
- note that the _t suffix is not POSIX compliant, and will be changed
- discourage eol whitespace
- be strict about the 80 char line width

---
 CODING_STYLE |   78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 78 insertions(+), 0 deletions(-)
 create mode 100644 CODING_STYLE
CODING_STYLE new file +10 -0
new file mode 100644
index 0000000..1ab13b6
@@ -0,0 +1,78 @@
+Qemu Coding Style
+=================
+
+1. Whitespace
+
+Of course, the most important aspect in any coding style is whitespace.
+Crusty old coders who have trouble spotting the glasses on their noses
+can tell the difference between a tab and eight spaces from a distance
+of approximately fifteen parsecs.  Many a flamewar have been fought and
+lost on this issue.
Quoted 8 lines

CODING_STYLE line 14

Quoted 4 lines
CODING_STYLE new file +4 -0
+
+QEMU indents are four spaces.  Tabs are never used, except in Makefiles
+where they have been irreversibly coded into the syntax by some moron.
+Spaces of course are superior to tabs because:

Hi I'd appreciate it if we removed the insults and the arrogance, i.e skip the "moron" and the of courses. Other than that most of this stuff

Seconded.

Quoted 2 lines

looks acceptable to me, although I don't necessarily agree with all of it :)

[..snip..]

Signature · 1 line
mailto:[email protected]