checkpatch: prefer static const declarations
[linux-2.6-microblaze.git] / scripts / checkpatch.pl
index fab38b4..4018bf8 100755 (executable)
@@ -853,6 +853,13 @@ our $declaration_macros = qr{(?x:
        (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
 )};
 
+our %allow_repeated_words = (
+       add => '',
+       added => '',
+       bad => '',
+       be => '',
+);
+
 sub deparenthesize {
        my ($string) = @_;
        return "" if (!defined($string));
@@ -3049,20 +3056,38 @@ sub process {
                }
 
 # check for repeated words separated by a single space
-               if ($rawline =~ /^\+/ || $in_commit_log) {
+# avoid false positive from list command eg, '-rw-r--r-- 1 root root'
+               if (($rawline =~ /^\+/ || $in_commit_log) &&
+                   $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) {
+                       pos($rawline) = 1 if (!$in_commit_log);
                        while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
 
                                my $first = $1;
                                my $second = $2;
-
+                               my $start_pos = $-[1];
+                               my $end_pos = $+[2];
                                if ($first =~ /(?:struct|union|enum)/) {
                                        pos($rawline) += length($first) + length($second) + 1;
                                        next;
                                }
 
-                               next if ($first ne $second);
+                               next if (lc($first) ne lc($second));
                                next if ($first eq 'long');
 
+                               # check for character before and after the word matches
+                               my $start_char = '';
+                               my $end_char = '';
+                               $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1));
+                               $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline));
+
+                               next if ($start_char =~ /^\S$/);
+                               next if (index(" \t.,;?!", $end_char) == -1);
+
+                                # avoid repeating hex occurrences like 'ff ff fe 09 ...'
+                                if ($first =~ /\b[0-9a-f]{2,}\b/i) {
+                                        next if (!exists($allow_repeated_words{lc($first)}));
+                                }
+
                                if (WARN("REPEATED_WORD",
                                         "Possible repeated word: '$first'\n" . $herecurr) &&
                                    $fix) {
@@ -4207,6 +4232,18 @@ sub process {
                        }
                }
 
+# check for const static or static <non ptr type> const declarations
+# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const'
+               if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ ||
+                   $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) {
+                       if (WARN("STATIC_CONST",
+                                "Move const after static - use 'static const $1'\n" . $herecurr) &&
+                           $fix) {
+                               $fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/;
+                               $fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/;
+                       }
+               }
+
 # check for non-global char *foo[] = {"bar", ...} declarations.
                if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
                        WARN("STATIC_CONST_CHAR_ARRAY",
@@ -5295,6 +5332,8 @@ sub process {
 #CamelCase
                        if ($var !~ /^$Constant$/ &&
                            $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
+#Ignore some autogenerated defines and enum values
+                           $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ &&
 #Ignore Page<foo> variants
                            $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
 #Ignore SI style variants like nS, mV and dB