X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=CODING_STYLE;h=dcbce28a27cd2a94c2b6133e89dfd0698da080b5;hb=6eebf958abf3f3f701116d4524ef88bb9fd6e341;hp=08af61ad1f80f5a98492ba9e19b25f5056a8ad48;hpb=99a0949b720a0936da2052cb9a46db04ffc6db29;p=qemu.git

diff --git a/CODING_STYLE b/CODING_STYLE
index 08af61ad1..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.
@@ -40,10 +43,15 @@ 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 names are a_lower_case_beginning_with_an a or an.
-Do not use _t suffix if you are including any headers.
+Variables are lower_case_with_underscores; easy to type and read.  Structured
+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.
+
+When wrapping standard library functions, use the prefix qemu_ to alert
+readers that they are seeing a wrapped version; otherwise avoid this prefix.
 
 4. Block structure
 
@@ -61,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: