lkml.org 
[lkml]   [2013]   [Dec]   [4]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH v2] checkpatch: add DT compatible string documentation checks
From
Date
On Tue, 2013-12-03 at 22:17 -0600, Rob Herring wrote:
> From: Rob Herring <rob.herring@calxeda.com>
>
> 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 <rob.herring@calxeda.com>
> Cc: Grant Likely <grant.likely@linaro.org>
> Cc: Andy Whitcroft <apw@canonical.com>
> Cc: Joe Perches <joe@perches.com>
> ---
> v2:
> - Add vendor string checking against vendor-prefixes.txt
> - Add '_', '.' and '+' as valid compatible string characters
> - Use 'grep -E' instead of egrep

Some more trivial notes:

> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
[]
> @@ -2034,6 +2034,29 @@ sub process {
> "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
> }
>
> +# check for DT compatible documentation
> + if ($realfile =~ /\.dts/ && $rawline =~ /\+\s*compatible\s*=/) {

this should probably be $rawline =~ /^\+\s*compatible...

> + my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
> +
> + foreach my $compat (@compats) {
> + my $compat2 = $compat;
> + my $dt_path = "Documentation/devicetree/bindings/";
> + $compat2 =~ s/\,[a-z]*\-/\,<\.\*>\-/;
> + `grep -Erq "$compat|$compat2" $dt_path`;
> + if ( $? >> 8 ) {
> + WARN("UNDOCUMENTED_DT_BINDING",
> + "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
> + }
> + my $vendor = $compat;
> + $vendor =~ s/^([a-zA-Z0-9]+)\,.*/$1/;
> + `grep -Eq "$vendor" "${dt_path}vendor-prefixes.txt"`;

It maybe simpler to read as:

my $vendor_path = $dt_path . "vendor-prefixes.txt";
`grep -Eq $vendor $vendor_path`;

> + if ( $? >> 8 ) {
> + WARN("UNDOCUMENTED_DT_VENDOR",
> + "DT compatible string vendor \"$vendor\" appears un-documented -- check ${dt_path}vendor-prefixes.txt\n" . $herecurr);

"DT compatible string vendor \"$vendor\" appears un-documented -- check $vendor_path\n" . $herecurr)

Also I suggest using the same message type
instead of 2 distinct ones.

Maybe "UNDOCUMENTED_DT_STRING"



\
 
 \ /
  Last update: 2013-12-04 07:41    [W:0.072 / U:0.080 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site