aboutsummaryrefslogtreecommitdiff
path: root/CODING_STYLE
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2015-06-19 09:28:13 +0200
committerPaolo Bonzini <pbonzini@redhat.com>2015-09-09 15:34:54 +0200
commit690a35e1f2acf4ccd0501b18228bc6fba8f9c768 (patch)
treef3e5ec37fcfeae961e9e2c97d3f29615b1f183aa /CODING_STYLE
parentd4ba8cb0a17e7de54753ff1bdeee4428118bb9ab (diff)
downloadqemu-690a35e1f2acf4ccd0501b18228bc6fba8f9c768.zip
qemu-690a35e1f2acf4ccd0501b18228bc6fba8f9c768.tar.gz
qemu-690a35e1f2acf4ccd0501b18228bc6fba8f9c768.tar.bz2
CODING_STYLE: update mixed declaration rules
Mixed declarations do come in handy at the top of #ifdef blocks. Reluctantly allow this particular usage and suggest an alternative. Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'CODING_STYLE')
-rw-r--r--CODING_STYLE13
1 files changed, 9 insertions, 4 deletions
diff --git a/CODING_STYLE b/CODING_STYLE
index d46cfa5..3c6978f 100644
--- a/CODING_STYLE
+++ b/CODING_STYLE
@@ -87,10 +87,15 @@ Furthermore, it is the QEMU coding style.
5. Declarations
-Mixed declarations (interleaving statements and declarations within blocks)
-are not allowed; declarations should be at the beginning of blocks. In other
-words, the code should not generate warnings if using GCC's
--Wdeclaration-after-statement option.
+Mixed declarations (interleaving statements and declarations within
+blocks) are generally not allowed; declarations should be at the beginning
+of blocks.
+
+Every now and then, an exception is made for declarations inside a
+#ifdef or #ifndef block: if the code looks nicer, such declarations can
+be placed at the top of the block even if there are statements above.
+On the other hand, however, it's often best to move that #ifdef/#ifndef
+block to a separate function altogether.
6. Conditional statements