]> git.proxmox.com Git - qemu.git/blobdiff - CODING_STYLE
net: Dump client type 'info network'
[qemu.git] / CODING_STYLE
index 1ab13b6861250e3fc812d678039ae99ca6b1845e..5ecfa2216109963cb646b5fcf00a10c85d3d0655 100644 (file)
@@ -1,6 +1,9 @@
 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.
@@ -10,7 +13,7 @@ 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.
+where they have been irreversibly coded into the syntax.
 Spaces of course are superior to tabs because:
 
  - You have just one way to specify whitespace, not two.  Ambiguity breeds
@@ -46,8 +49,8 @@ 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.
 
 4. Block structure