diff options
author | Antony Pavlov <antonynpavlov@gmail.com> | 2015-04-22 23:39:18 +0300 |
---|---|---|
committer | Sascha Hauer <s.hauer@pengutronix.de> | 2015-04-28 10:33:17 +0200 |
commit | 9496896fbf07da4a8f3597c9b293b0bc0c32c5a9 (patch) | |
tree | 4f312fc15bba005c516e56978d940139b9ecd1ca /scripts/checkpatch.pl | |
parent | 36c8344e0d31b32a10d415a26942054f29a6007c (diff) | |
download | barebox-9496896fbf07da4a8f3597c9b293b0bc0c32c5a9.tar.gz barebox-9496896fbf07da4a8f3597c9b293b0bc0c32c5a9.tar.xz |
checkpatch: add DT compatible string documentation checks
This adds a simple check that any compatible strings in DeviceTree dts
files are present in Documentation/devicetree/bindings and
in dts/Bindings/.
Vendor prefixes are also checked for existing in vendor-prefixes.txt.
This code is based on linux v4.0-rc6 checkpatch.pl dt-checking code by
Rob Herring & Florian Vaussard:
Rob Herring (2):
checkpatch: add DT compatible string documentation checks
checkpatch: fix wildcard DT compatible string checking
Florian Vaussard (3):
checkpatch: fix spurious vendor compatible warnings
checkpatch: check compatible strings in .c and .h too
checkpatch: improve the compatible vendor match
Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com>
Cc: Rob Herring <robh@kernel.org>
Cc: Florian Vaussard <florian.vaussard@epfl.ch>
Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
Diffstat (limited to 'scripts/checkpatch.pl')
-rwxr-xr-x | scripts/checkpatch.pl | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl index a40d32cba7..8d96434650 100755 --- a/scripts/checkpatch.pl +++ b/scripts/checkpatch.pl @@ -1466,6 +1466,41 @@ sub process { #print "is_end<$is_end> length<$length>\n"; } +# check for DT compatible documentation + if (defined $root && + (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || + ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { + + my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; + + # linux device tree files + my $dt_path = $root . "/dts/Bindings/"; + my $vp_file = $dt_path . "vendor-prefixes.txt"; + + # barebox-specific bindings + $dt_path = $dt_path . " " . $root . "/Documentation/devicetree/bindings/"; + + foreach my $compat (@compats) { + my $compat2 = $compat; + $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; + my $compat3 = $compat; + $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; + `grep -Erq "$compat|$compat2|$compat3" $dt_path`; + if ( $? >> 8 ) { + WARN( + "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); + } + + next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; + my $vendor = $1; + `grep -Eq "^$vendor\\b" $vp_file`; + if ( $? >> 8 ) { + WARN( + "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); + } + } + } + # check we are in a valid source file if not then ignore this hunk next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); |