* [PATCH v2] checkpatch: DT bindings should be a separate patch
@ 2018-08-10 17:05 Rob Herring
2018-08-10 18:14 ` Joe Perches
0 siblings, 1 reply; 2+ messages in thread
From: Rob Herring @ 2018-08-10 17:05 UTC (permalink / raw)
To: Joe Perches; +Cc: linux-kernel, Andrew Morton, Andy Whitcroft
Devicetree bindings should be their own patch as documented in
Documentation/devicetree/bindings/submitting-patches.txt section I.1.
This is because bindings are logically independent from a driver
implementation, they have a different maintainer (even though they often
are applied via the same tree), and it makes for a cleaner history in
the DT only tree created with git-filter-branch.
Cc: Andy Whitcroft <apw@canonical.com>
Cc: Joe Perches <joe@perches.com>
Signed-off-by: Rob Herring <robh@kernel.org>
---
v2:
- Add doc pointer to warning
- Simplify logic
Joe, this makes $is_binding_patch an empty value when the regex doesn't
match rather than 0 which would be more logical IMO. It seems to work
fine, but I'm not sure if there's a better way to do it.
scripts/checkpatch.pl | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index a9c05506e325..f9aba4bc41ce 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2236,6 +2236,7 @@ sub process {
our $clean = 1;
my $signoff = 0;
my $is_patch = 0;
+ my $is_binding_patch = -1;
my $in_header_lines = $file ? 0 : 1;
my $in_commit_log = 0; #Scanning lines before patch
my $has_commit_log = 0; #Encountered lines before patch
@@ -2485,6 +2486,19 @@ sub process {
$check = $check_orig;
}
$checklicenseline = 1;
+
+ if ($realfile !~ /^MAINTAINERS/) {
+ my $last_binding_patch = $is_binding_patch;
+
+ $is_binding_patch = ($realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@);
+
+ if (($last_binding_patch != -1) &&
+ ($last_binding_patch ^ $is_binding_patch)) {
+ WARN("DT_SPLIT_BINDING_PATCH",
+ "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt");
+ }
+ }
+
next;
}
--
2.17.1
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH v2] checkpatch: DT bindings should be a separate patch
2018-08-10 17:05 [PATCH v2] checkpatch: DT bindings should be a separate patch Rob Herring
@ 2018-08-10 18:14 ` Joe Perches
0 siblings, 0 replies; 2+ messages in thread
From: Joe Perches @ 2018-08-10 18:14 UTC (permalink / raw)
To: Rob Herring; +Cc: linux-kernel, Andrew Morton, Andy Whitcroft
On Fri, 2018-08-10 at 11:05 -0600, Rob Herring wrote:
> Devicetree bindings should be their own patch as documented in
> Documentation/devicetree/bindings/submitting-patches.txt section I.1.
> This is because bindings are logically independent from a driver
> implementation, they have a different maintainer (even though they often
> are applied via the same tree), and it makes for a cleaner history in
> the DT only tree created with git-filter-branch.
>
> Cc: Andy Whitcroft <apw@canonical.com>
> Cc: Joe Perches <joe@perches.com>
> Signed-off-by: Rob Herring <robh@kernel.org>
> ---
> v2:
> - Add doc pointer to warning
> - Simplify logic
>
> Joe, this makes $is_binding_patch an empty value when the regex doesn't
> match rather than 0 which would be more logical IMO. It seems to work
> fine, but I'm not sure if there's a better way to do it.
Hi Rob. This looks fine with a couple nits.
> scripts/checkpatch.pl | 14 ++++++++++++++
> 1 file changed, 14 insertions(+)
>
> diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> index a9c05506e325..f9aba4bc41ce 100755
> --- a/scripts/checkpatch.pl
> +++ b/scripts/checkpatch.pl
> @@ -2236,6 +2236,7 @@ sub process {
> our $clean = 1;
> my $signoff = 0;
> my $is_patch = 0;
> + my $is_binding_patch = -1;
> my $in_header_lines = $file ? 0 : 1;
> my $in_commit_log = 0; #Scanning lines before patch
> my $has_commit_log = 0; #Encountered lines before patch
> @@ -2485,6 +2486,19 @@ sub process {
> $check = $check_orig;
> }
> $checklicenseline = 1;
> +
> + if ($realfile !~ /^MAINTAINERS/) {
> + my $last_binding_patch = $is_binding_patch;
> +
> + $is_binding_patch = ($realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@);
If you want 0/1 you could use:
$is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
(perl syntax is a constant joy)
> +
> + if (($last_binding_patch != -1) &&
> + ($last_binding_patch ^ $is_binding_patch)) {
> + WARN("DT_SPLIT_BINDING_PATCH",
> + "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt");
This is missing a '\n' newline at the end of the message.
> + }
> + }
> +
> next;
> }
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-08-10 18:15 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-08-10 17:05 [PATCH v2] checkpatch: DT bindings should be a separate patch Rob Herring
2018-08-10 18:14 ` Joe Perches
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).