Subject: + checkpatch-add-dt-compatible-string-documentation-checks.patch added to -mm tree To: robh@xxxxxxxxxx,apw@xxxxxxxxxxxxx,grant.likely@xxxxxxxxxx,joe@xxxxxxxxxxx From: akpm@xxxxxxxxxxxxxxxxxxxx Date: Fri, 10 Jan 2014 15:05:49 -0800 The patch titled Subject: checkpatch: add DT compatible string documentation checks has been added to the -mm tree. Its filename is checkpatch-add-dt-compatible-string-documentation-checks.patch This patch should soon appear at http://ozlabs.org/~akpm/mmots/broken-out/checkpatch-add-dt-compatible-string-documentation-checks.patch and later at http://ozlabs.org/~akpm/mmotm/broken-out/checkpatch-add-dt-compatible-string-documentation-checks.patch Before you just go and hit "reply", please: a) Consider who else should be cc'ed b) Prefer to cc a suitable mailing list as well c) Ideally: find the original patch on the mailing list and do a reply-to-all to that, adding suitable additional cc's *** Remember to use Documentation/SubmitChecklist when testing your code *** The -mm tree is included into linux-next and is updated there every 3-4 working days ------------------------------------------------------ From: Rob Herring <robh@xxxxxxxxxx> Subject: 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. Vendor prefixes are also checked for existing in vendor-prefixes.txt These should be temporary checks until we have more sophisticated binding schema checking. Signed-off-by: Rob Herring <robh@xxxxxxxxxx> Signed-off-by: Joe Perches <joe@xxxxxxxxxxx> Cc: Grant Likely <grant.likely@xxxxxxxxxx> Cc: Andy Whitcroft <apw@xxxxxxxxxxxxx> Signed-off-by: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx> --- scripts/checkpatch.pl | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff -puN scripts/checkpatch.pl~checkpatch-add-dt-compatible-string-documentation-checks scripts/checkpatch.pl --- a/scripts/checkpatch.pl~checkpatch-add-dt-compatible-string-documentation-checks +++ a/scripts/checkpatch.pl @@ -2040,6 +2040,33 @@ sub process { "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); } +# check for DT compatible documentation + if (defined $root && $realfile =~ /\.dts/ && + $rawline =~ /^\+\s*compatible\s*=/) { + my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; + + foreach my $compat (@compats) { + my $compat2 = $compat; + my $dt_path = $root . "/Documentation/devicetree/bindings/"; + $compat2 =~ s/\,[a-z]*\-/\,<\.\*>\-/; + `grep -Erq "$compat|$compat2" $dt_path`; + if ( $? >> 8 ) { + WARN("UNDOCUMENTED_DT_STRING", + "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); + } + + my $vendor = $compat; + my $vendor_path = $dt_path . "vendor-prefixes.txt"; + next if (! -f $vendor_path); + $vendor =~ s/^([a-zA-Z0-9]+)\,.*/$1/; + `grep -Eq "$vendor" $vendor_path`; + if ( $? >> 8 ) { + WARN("UNDOCUMENTED_DT_STRING", + "DT compatible string vendor \"$vendor\" appears un-documented -- check $vendor_path\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)$/); _ Patches currently in -mm which might be from robh@xxxxxxxxxx are checkpatch-add-dt-compatible-string-documentation-checks.patch -- To unsubscribe from this list: send the line "unsubscribe mm-commits" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html