[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 12/14] CODING_STYLE, checkpatch: update line length r
From: |
Paolo Bonzini |
Subject: |
[Qemu-devel] [PULL 12/14] CODING_STYLE, checkpatch: update line length rules |
Date: |
Wed, 10 Aug 2016 15:57:15 +0200 |
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 <address@hidden>
Reviewed-by: Thomas Huth <address@hidden>
Signed-off-by: Paolo Bonzini <address@hidden>
---
CODING_STYLE | 8 +++++++-
scripts/checkpatch.pl | 8 ++++++--
2 files changed, 13 insertions(+), 3 deletions(-)
diff --git a/CODING_STYLE b/CODING_STYLE
index 3c6978f..e7fde15 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
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index fea576d..ba6760d 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -1336,12 +1336,16 @@ sub process {
# check we are in a valid source file if not then ignore this hunk
next if ($realfile !~ /\.(h|c|cpp|s|S|pl|py|sh)$/);
-#80 column limit
+#90 column limit
if ($line =~ /^\+/ &&
!($line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
$length > 80)
{
- WARN("line over 80 characters\n" . $herecurr);
+ if ($length > 90) {
+ ERROR("line over 90 characters\n" . $herecurr);
+ } else {
+ WARN("line over 80 characters\n" . $herecurr);
+ }
}
# check for spaces before a quoted newline
--
1.8.3.1
- [Qemu-devel] [PULL 04/14] optionrom: fix compilation with mingw docker target, (continued)
- [Qemu-devel] [PULL 04/14] optionrom: fix compilation with mingw docker target, Paolo Bonzini, 2016/08/10
- [Qemu-devel] [PULL 02/14] build-sys: fix building with make CFLAGS=.. argument, Paolo Bonzini, 2016/08/10
- [Qemu-devel] [PULL 01/14] linuxboot_dma: avoid guest ABI breakage on gcc vs. clang compilation, Paolo Bonzini, 2016/08/10
- [Qemu-devel] [PULL 05/14] atomic: strip "const" from variables declared with typeof, Paolo Bonzini, 2016/08/10
- [Qemu-devel] [PULL 06/14] Disable warn about left shifts of negative values, Paolo Bonzini, 2016/08/10
- [Qemu-devel] [PULL 07/14] clang: Fix warning reg. expansion to 'defined', Paolo Bonzini, 2016/08/10
- [Qemu-devel] [PULL 08/14] checkpatch: ignore automatically imported Linux headers, Paolo Bonzini, 2016/08/10
- [Qemu-devel] [PULL 11/14] checkpatch: check for CVS keywords on all sources, Paolo Bonzini, 2016/08/10
- [Qemu-devel] [PULL 10/14] checkpatch: tweak the files in which TABs are checked, Paolo Bonzini, 2016/08/10
- [Qemu-devel] [PULL 09/14] timer: set vm_clock disabled default, Paolo Bonzini, 2016/08/10
- [Qemu-devel] [PULL 12/14] CODING_STYLE, checkpatch: update line length rules,
Paolo Bonzini <=
- [Qemu-devel] [PULL 13/14] checkpatch: bump most warnings to errors, Paolo Bonzini, 2016/08/10
- [Qemu-devel] [PULL 14/14] checkpatch: default to success if only warnings, Paolo Bonzini, 2016/08/10
- Re: [Qemu-devel] [PULL 00/14] checkpatch, warnings and other fixes, Peter Maydell, 2016/08/10