Messages in this thread | | | Subject | Re: [PATCH] checkpatch: add DT compatible string documentation check | From | Joe Perches <> | Date | Tue, 26 Nov 2013 08:43:45 -0800 |
| |
On Tue, 2013-11-26 at 10:01 -0600, Rob Herring wrote: > From: Rob Herring <rob.herring@calxeda.com>
Hi Rob.
> This adds a simple check that any compatible strings in DeviceTree dts > files are present in Documentation/devicetree/bindings. This should be a > temporary check until we have more sophisticated binding schema checking. [] > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl [] > @@ -2034,6 +2034,21 @@ sub process { > "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); > } > > +# check for compatible documentation > + if ($realfile =~ /\.dts/ && $rawline =~ /\+\s*compatible\s*=/) { > + my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,]+)\"/g;
I believe there needs to be a \+\. in the brackets for lines like:
arch/c6x/boot/dts/tms320c6678.dtsi: compatible = "ti,c64x+timer64"; and arch/powerpc/boot/dts/mpc8313erdb.dts: compatible = "fsl,sec2.2", "fsl,sec2.1",
> + > + foreach my $compat (@compats) { > + my $compat2 = $compat; > + $compat2 =~ s/\,[a-z]*\-/\,<\.\*>\-/; > + `egrep -rq "$compat|$compat2" "Documentation/devicetree/bindings/"`;
Perhaps the egrep should be grep -E
> + if ( $? >> 8 ) { > + WARN("UNDOCUMENTED_DT_BINDING", > + "DT compatible string \"$compat\" appears un-documented -- check Documentation/devicetree/bindings/\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)$/); >
| |