Commit 8fbe3d1f authored by Paolo Bonzini's avatar Paolo Bonzini
Browse files

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: default avatarCornelia Huck <cornelia.huck@de.ibm.com>
Reviewed-by: default avatarThomas Huth <thuth@redhat.com>
Signed-off-by: default avatarPaolo Bonzini <pbonzini@redhat.com>
parent 93eb8e31

CODING_STYLE

+7 −1
Original line number Diff line number Diff line
@@ -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

scripts/checkpatch.pl

+6 −2
Original line number Diff line number Diff line
@@ -1336,13 +1336,17 @@ 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)

		{

			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

		if ($rawline =~ /^.*\".*\s\\n/) {