--- qemu/CODING_STYLE 2018/04/24 17:21:30 1.1.1.1 +++ qemu/CODING_STYLE 2018/04/24 19:18:03 1.1.1.4 @@ -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. @@ -46,8 +49,8 @@ names are lower_case_with_underscores_en 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 @@ -65,6 +68,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: