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

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <1385484225.20100.58.camel@joe-AO722>
Date:	Tue, 26 Nov 2013 08:43:45 -0800
From:	Joe Perches <joe@...ches.com>
To:	Rob Herring <robherring2@...il.com>
Cc:	linux-kernel@...r.kernel.org, devicetree@...r.kernel.org,
	Rob Herring <rob.herring@...xeda.com>,
	Grant Likely <grant.likely@...aro.org>,
	Andy Whitcroft <apw@...onical.com>
Subject: Re: [PATCH] checkpatch: add DT compatible string documentation check

On Tue, 2013-11-26 at 10:01 -0600, Rob Herring wrote:
> From: Rob Herring <rob.herring@...xeda.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)$/);
>  



--
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/