X-Git-Url: https://git.proxmox.com/?a=blobdiff_plain;f=CODING_STYLE;h=dcbce28a27cd2a94c2b6133e89dfd0698da080b5;hb=8d07d6c46597a885eb38d99cc6fff399ce69cd21;hp=2c8268ddc20435bdbca7e218b74f3e5fafbae1b0;hpb=b907b69dd75415bc28349d1dd1e9a598ddace463;p=qemu.git diff --git a/CODING_STYLE b/CODING_STYLE index 2c8268ddc..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,7 +44,8 @@ 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. @@ -65,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: