[PATCH] get_maintainer: add email addresses from dts files

[PATCH] get_maintainer: add email addresses from dts files

[Krzysztof Kozlowski]

The DTS/DTSI files represent hardware description for Linux kernel,
which is necessary to properly recognize and configure hardware by
Linux.  DTS is usually created by people having the actual hardware and
having interest in keeping it in good shape.  Such people can provide
review (they might have board schematics) and testing.  Unfortunately
they mostly do not appear in MAINTAINERS file.  Adding per-DTS entries
to MAINTAINERS would quickly make it bloated (hundreds of new per-DTS
entries).

On the other hand there is no point in CC-ing every Copyright email
appearing in files, because it might be outdated.  Add new in-file
pattern for storing maintainers dedicated to specific boards:

  Maintainer: John Smith <email>

Suggested-by: Joe Perches <joe@perches.com>
Suggested-by: Shawn Guo <shawnguo@kernel.org>
Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

---

This is rework of earlier approach:
Link: https://lore.kernel.org/r/20210809080204.8381-1-shawnguo@kernel.org
---
 scripts/get_maintainer.pl | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/scripts/get_maintainer.pl b/scripts/get_maintainer.pl
index ab123b498fd9..f02a2a80c3bc 100755
--- a/scripts/get_maintainer.pl
+++ b/scripts/get_maintainer.pl
@@ -445,6 +445,17 @@ sub maintainers_in_file {
 	my @poss_addr = $text =~ m$[A-Za-zÀ-ÿ\"\' \,\.\+-]*\s*[\,]*\s*[\(\<\{]{0,1}[A-Za-z0-9_\.\+-]+\@[A-Za-z0-9\.-]+\.[A-Za-z0-9]+[\)\>\}]{0,1}$g;
 	push(@file_emails, clean_file_emails(@poss_addr));
     }
+
+    # Match "Maintainer: email" entries only in DTS sources
+    if (-f $file && ($email_file_emails || $file =~ /\.dtsi?$/)) {
+	open(my $f, '<', $file)
+	    or die "$P: Can't open $file: $!\n";
+	my $text = do { local($/) ; <$f> };
+	close($f);
+
+	my @poss_addr = $text =~ m$Maintainer: [A-Za-zÀ-ÿ\"\' \,\.\+-]*\s*[\,]*\s*[\(\<\{]{0,1}[A-Za-z0-9_\.\+-]+\@[A-Za-z0-9\.-]+\.[A-Za-z0-9]+[\)\>\}]{0,1}$g;
+	push(@file_emails, clean_file_emails(@poss_addr));
+    }
 }
 
 #
-- 
2.34.1

Re: [PATCH] get_maintainer: add email addresses from dts files

[Krzysztof Kozlowski]

On 11/02/2023 13:14, Krzysztof Kozlowski wrote:
> The DTS/DTSI files represent hardware description for Linux kernel,
> which is necessary to properly recognize and configure hardware by
> Linux.  DTS is usually created by people having the actual hardware and
> having interest in keeping it in good shape.  Such people can provide
> review (they might have board schematics) and testing.  Unfortunately
> they mostly do not appear in MAINTAINERS file.  Adding per-DTS entries
> to MAINTAINERS would quickly make it bloated (hundreds of new per-DTS
> entries).
> 
> On the other hand there is no point in CC-ing every Copyright email
> appearing in files, because it might be outdated.  Add new in-file
> pattern for storing maintainers dedicated to specific boards:
> 
>   Maintainer: John Smith <email>
> 
> Suggested-by: Joe Perches <joe@perches.com>
> Suggested-by: Shawn Guo <shawnguo@kernel.org>
> Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>

This is obviously not a valid tag anymore... I'll sent a v2 tomorrow.

Best regards,
Krzysztof

Re: [PATCH] get_maintainer: add email addresses from dts files

[Joe Perches]

On Sat, 2023-02-11 at 13:14 +0100, Krzysztof Kozlowski wrote:
> The DTS/DTSI files represent hardware description for Linux kernel,
> which is necessary to properly recognize and configure hardware by
> Linux.  DTS is usually created by people having the actual hardware and
> having interest in keeping it in good shape.  Such people can provide
> review (they might have board schematics) and testing.  Unfortunately
> they mostly do not appear in MAINTAINERS file.  Adding per-DTS entries
> to MAINTAINERS would quickly make it bloated (hundreds of new per-DTS
> entries).
> 
> On the other hand there is no point in CC-ing every Copyright email
> appearing in files, because it might be outdated.  Add new in-file
> pattern for storing maintainers dedicated to specific boards:
> 
>   Maintainer: John Smith <email>
> 
> Suggested-by: Joe Perches <joe@perches.com>
> Suggested-by: Shawn Guo <shawnguo@kernel.org>
> Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
> 
> ---
> 
> This is rework of earlier approach:
> Link: https://lore.kernel.org/r/20210809080204.8381-1-shawnguo@kernel.org

Why the rework?  I think the older one is much simpler.

I believe I forwarded the older one to Andrew Morton awhile back.
I'll check to see what happened to it.


> ---
>  scripts/get_maintainer.pl | 11 +++++++++++
>  1 file changed, 11 insertions(+)
> 
> diff --git a/scripts/get_maintainer.pl b/scripts/get_maintainer.pl
> index ab123b498fd9..f02a2a80c3bc 100755
> --- a/scripts/get_maintainer.pl
> +++ b/scripts/get_maintainer.pl
> @@ -445,6 +445,17 @@ sub maintainers_in_file {
>  	my @poss_addr = $text =~ m$[A-Za-zÀ-ÿ\"\' \,\.\+-]*\s*[\,]*\s*[\(\<\{]{0,1}[A-Za-z0-9_\.\+-]+\@[A-Za-z0-9\.-]+\.[A-Za-z0-9]+[\)\>\}]{0,1}$g;
>  	push(@file_emails, clean_file_emails(@poss_addr));
>      }
> +
> +    # Match "Maintainer: email" entries only in DTS sources
> +    if (-f $file && ($email_file_emails || $file =~ /\.dtsi?$/)) {
> +	open(my $f, '<', $file)
> +	    or die "$P: Can't open $file: $!\n";
> +	my $text = do { local($/) ; <$f> };
> +	close($f);
> +
> +	my @poss_addr = $text =~ m$Maintainer: [A-Za-zÀ-ÿ\"\' \,\.\+-]*\s*[\,]*\s*[\(\<\{]{0,1}[A-Za-z0-9_\.\+-]+\@[A-Za-z0-9\.-]+\.[A-Za-z0-9]+[\)\>\}]{0,1}$g;
> +	push(@file_emails, clean_file_emails(@poss_addr));
> +    }
>  }
>  
>  #

Re: [PATCH] get_maintainer: add email addresses from dts files

[Krzysztof Kozlowski]

On 11/02/2023 17:27, Joe Perches wrote:
> On Sat, 2023-02-11 at 13:14 +0100, Krzysztof Kozlowski wrote:
>> The DTS/DTSI files represent hardware description for Linux kernel,
>> which is necessary to properly recognize and configure hardware by
>> Linux.  DTS is usually created by people having the actual hardware and
>> having interest in keeping it in good shape.  Such people can provide
>> review (they might have board schematics) and testing.  Unfortunately
>> they mostly do not appear in MAINTAINERS file.  Adding per-DTS entries
>> to MAINTAINERS would quickly make it bloated (hundreds of new per-DTS
>> entries).
>>
>> On the other hand there is no point in CC-ing every Copyright email
>> appearing in files, because it might be outdated.  Add new in-file
>> pattern for storing maintainers dedicated to specific boards:
>>
>>   Maintainer: John Smith <email>
>>
>> Suggested-by: Joe Perches <joe@perches.com>
>> Suggested-by: Shawn Guo <shawnguo@kernel.org>
>> Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>
>> Signed-off-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
>>
>> ---
>>
>> This is rework of earlier approach:
>> Link: https://lore.kernel.org/r/20210809080204.8381-1-shawnguo@kernel.org
> 
> Why the rework?  I think the older one is much simpler.
> 
> I believe I forwarded the older one to Andrew Morton awhile back.
> I'll check to see what happened to it.

It was never merged, thus I assumed some changes are needed, e.g. to
ignore emails in copyrights.

Best regards,
Krzysztof

Re: [PATCH] get_maintainer: add email addresses from dts files

[Joe Perches]

On Sun, 2023-02-12 at 16:51 +0100, Krzysztof Kozlowski wrote:
> On 11/02/2023 17:27, Joe Perches wrote:
> > On Sat, 2023-02-11 at 13:14 +0100, Krzysztof Kozlowski wrote:
> > > The DTS/DTSI files represent hardware description for Linux kernel,
> > > which is necessary to properly recognize and configure hardware by
> > > Linux.  DTS is usually created by people having the actual hardware and
> > > having interest in keeping it in good shape.  Such people can provide
> > > review (they might have board schematics) and testing.  Unfortunately
> > > they mostly do not appear in MAINTAINERS file.  Adding per-DTS entries
> > > to MAINTAINERS would quickly make it bloated (hundreds of new per-DTS
> > > entries).
> > > 
> > > On the other hand there is no point in CC-ing every Copyright email
> > > appearing in files, because it might be outdated.

That's what .mailmap is for.

> > > Add new in-file
> > > pattern for storing maintainers dedicated to specific boards:

I think adding Maintainer: who <who@foo.tld>

to each dts and dtsi file would be a lot of unnecessary changes
$ git ls-files | grep -P '\.dtsi?$' | wc -l
4673

> > > This is rework of earlier approach:
> > > Link: https://lore.kernel.org/r/20210809080204.8381-1-shawnguo@kernel.org
> > 
> > Why the rework?  I think the older one is much simpler.
> > 
> > I believe I forwarded the older one to Andrew Morton awhile back.
> > I'll check to see what happened to it.
> 
> It was never merged, thus I assumed some changes are needed, e.g. to
> ignore emails in copyrights.

I think the old one is fine.

[PATCH] get_maintainer: add email addresses from dts files

[Shawn Guo]

MAINTAINER file will get bloated quickly if individual section entry
is created for each .dts/.dtsi file.  Add the email address from dts
files to get_maintainer output for saving unnecessary patching on
MAINTAINER file.

Suggested-by: Joe Perches <joe@perches.com>
Signed-off-by: Shawn Guo <shawnguo@kernel.org>
---
 scripts/get_maintainer.pl | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/scripts/get_maintainer.pl b/scripts/get_maintainer.pl
index 484d2fbf5921..b8e104028359 100755
--- a/scripts/get_maintainer.pl
+++ b/scripts/get_maintainer.pl
@@ -436,7 +436,7 @@ sub maintainers_in_file {
 
     return if ($file =~ m@\bMAINTAINERS$@);
 
-    if (-f $file && ($email_file_emails || $file =~ /\.yaml$/)) {
+    if (-f $file && ($email_file_emails || $file =~ /\.(?:yaml|dtsi?)$/)) {
 	open(my $f, '<', $file)
 	    or die "$P: Can't open $file: $!\n";
 	my $text = do { local($/) ; <$f> };
-- 
2.17.1

Re: [PATCH] get_maintainer: add email addresses from dts files

[Krzysztof Kozlowski]

On Sun, 30 Aug 2020 at 14:31, Shawn Guo <shawnguo@kernel.org> wrote:
>
> MAINTAINER file will get bloated quickly if individual section entry
> is created for each .dts/.dtsi file.  Add the email address from dts
> files to get_maintainer output for saving unnecessary patching on
> MAINTAINER file.
>
> Suggested-by: Joe Perches <joe@perches.com>
> Signed-off-by: Shawn Guo <shawnguo@kernel.org>
> ---
>  scripts/get_maintainer.pl | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>

I thought this was applied... but seems not, so my previous email
could be ignored.

I like this approach because contact details for specific boards are
useful. So +1 from me:
Reviewed-by: Krzysztof Kozlowski <krzk@kernel.org>

Best regards,
Krzysztof