linux-kernel - Re: [PATCH v3] checkpatch: add DT compatible string documentation checks

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:	Fri, 06 Dec 2013 08:48:30 -0800
From:	Joe Perches <joe@...ches.com>
To:	Andy Whitcroft <apw@...onical.com>
Cc:	Rob Herring <robherring2@...il.com>,
	Andrew Morton <akpm@...ux-foundation.org>,
	linux-kernel@...r.kernel.org, devicetree@...r.kernel.org,
	Rob Herring <rob.herring@...xeda.com>,
	Grant Likely <grant.likely@...aro.org>
Subject: Re: [PATCH v3] checkpatch: add DT compatible string documentation
 checks

On Fri, 2013-12-06 at 09:56 +0000, Andy Whitcroft wrote:
> On Wed, Dec 04, 2013 at 08:12:43AM -0800, Joe Perches wrote:
> > On Wed, 2013-12-04 at 10:03 -0600, Rob Herring wrote:
> > > From: Rob Herring <rob.herring@...xeda.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.
[]
> > > +# check for DT compatible documentation
> > > +		if ($realfile =~ /\.dts/ && $rawline =~ /^\+\s*compatible\s*=/) {
> > > +			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_STRING",
> > > +					     "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
> > > +				}
> > > +
> > > +				my $vendor = $compat;
> > > +				my $vendor_path = $dt_path . "vendor-prefixes.txt";
> > > +				$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);
> > > +				}
> > > +			}
> > > +		}
> 
> So this only works if you are in the top of the tree at the time when
> you run it (unless I've missed something).  So it might be appropraite
> to suppress this when the vendor-prefixes.txt file is not found.

I suppose it's useful to use the $root variable
on the file open too.

	my $vendor_path = $root . '/' . $dt_path . "vendor-prefixes.txt";


--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/