X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=CODING_STYLE;h=dcbce28a27cd2a94c2b6133e89dfd0698da080b5;hb=6eebf958abf3f3f701116d4524ef88bb9fd6e341;hp=92036f34bc71737ad01af0a2a94a2f691066403e;hpb=77ac48626362abf47a9a6f915fdeea732391f2ba;p=qemu.git

diff --git a/CODING_STYLE b/CODING_STYLE
index 92036f34b..dcbce28a2 100644
--- a/CODING_STYLE
+++ b/CODING_STYLE
@@ -1,6 +1,9 @@
-Qemu Coding Style
+QEMU Coding Style
 =================
 
+Please use the script checkpatch.pl in the scripts directory to check
+patches before submitting.
+
 1. Whitespace
 
 Of course, the most important aspect in any coding style is whitespace.
@@ -41,14 +44,12 @@ Rationale:
 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
+type names are in CamelCase; harder to type but standing out.  Enum type
+names and function type names should also be in CamelCase.  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.
-
 When wrapping standard library functions, use the prefix qemu_ to alert
 readers that they are seeing a wrapped version; otherwise avoid this prefix.
 
@@ -68,6 +69,10 @@ keyword.  Example:
         printf("a was something else entirely.\n");
     }
 
+Note that 'else if' is considered a single statement; otherwise a long if/
+else if/else if/.../else sequence would need an indent for every else
+statement.
+
 An exception is the opening brace for a function; for reasons of tradition
 and clarity it comes on a line by itself: