aboutsummaryrefslogtreecommitdiff
path: root/CODING_STYLE
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2015-09-07 11:53:02 +0200
committerPaolo Bonzini <pbonzini@redhat.com>2016-08-10 12:22:33 +0200
commit8fbe3d1fcfa16c543f49f24e7cdfbf0024459341 (patch)
tree73348f3bfa71549a15327f38cf591e35e3f37956 /CODING_STYLE
parent93eb8e31f38b3eb612e522c62e8932d7fd576ff9 (diff)
CODING_STYLE, checkpatch: update line length rules
Line lengths above 80 characters do exist. They are rare, but they happen from time to time. An ignored rule is worse than an exception to the rule, so do the latter. Some on the list expressed their preference for a soft limit that is slightly lower than 80 characters, to account for extra characters in unified diffs (including three-way diffs) and for email quoting. However, there was no consensus on this so keep the 80-character soft limit and add a hard limit at 90. Acked-by: Cornelia Huck <cornelia.huck@de.ibm.com> Reviewed-by: Thomas Huth <thuth@redhat.com> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'CODING_STYLE')
-rw-r--r--CODING_STYLE8
1 files changed, 7 insertions, 1 deletions
diff --git a/CODING_STYLE b/CODING_STYLE
index 3c6978f836..e7fde15003 100644
--- a/CODING_STYLE
+++ b/CODING_STYLE
@@ -31,7 +31,11 @@ Do not leave whitespace dangling off the ends of lines.
2. Line width
-Lines are 80 characters; not longer.
+Lines should be 80 characters; try not to make them longer.
+
+Sometimes it is hard to do, especially when dealing with QEMU subsystems
+that use long function or symbol names. Even in that case, do not make
+lines much longer than 80 characters.
Rationale:
- Some people like to tile their 24" screens with a 6x4 matrix of 80x24
@@ -39,6 +43,8 @@ Rationale:
let them keep doing it.
- Code and especially patches is much more readable if limited to a sane
line length. Eighty is traditional.
+ - The four-space indentation makes the most common excuse ("But look
+ at all that white space on the left!") moot.
- It is the QEMU coding style.
3. Naming