[Enable Designware XGMAC VLAN Stripping Feature 1/2] dt-bindings: net: snps,dwmac: Add description for rx-vlan-offload

[Joe Perches]

On Fri, 2023-07-21 at 18:55 -0700, Jakub Kicinski wrote:
> On Fri, 21 Jul 2023 18:21:32 +0200 Krzysztof Kozlowski wrote:
> > > $ ./scripts/get_maintainer.pl  --scm  -f drivers/net/ethernet/stmicro/stmmac/dwxgmac2_core.c  
> > 
> > That's not how you run it. get_maintainers.pl should be run on patches
> > or on all files, not just some selection.
> 
> Adding Joe for visibility (I proposed to print a warning when people 
> do this and IIRC he wasn't on board).

What's the issue here?  Other than _how_ the script was used,
I don't see an actual problem with the script itself.

https://lore.kernel.org/lkml/20230721062617.9810-1-boon.khai.ng@intel.com/

As far as I can tell, the patch series address list was identical
for the 0/2, 1/2, and 2/2 submissions:

--------------------------------

0/2:

   From: Boon at ecsmtp.png.intel.com, Khai at ecsmtp.png.intel.com, "Ng <boon.khai.ng"@intel.com
   To: Giuseppe Cavallaro <peppe.cavallaro at st.com>,
   	Alexandre Torgue <alexandre.torgue at foss.st.com>,
   	Jose Abreu <joabreu at synopsys.com>,
   	"David S . Miller" <davem at davemloft.net>,
   	Eric Dumazet <edumazet at google.com>,
   	Jakub Kicinski <kuba at kernel.org>, Paolo Abeni <pabeni at redhat.com>,
   	Maxime Coquelin <mcoquelin.stm32 at gmail.com>,
   	netdev at vger.kernel.org, linux-stm32 at st-md-mailman.stormreply.com,
   	linux-arm-kernel at lists.infradead.org,
   	linux-kernel at vger.kernel.org
   Cc: Boon Khai Ng <boon.khai.ng at intel.com>,
   	Shevchenko Andriy <andriy.shevchenko at intel.com>,
   	Mun Yew Tham <mun.yew.tham at intel.com>,
   	Leong Ching Swee <leong.ching.swee at intel.com>,
   	G Thomas Rohan <rohan.g.thomas at intel.com>,
   	Shevchenko Andriy <andriy.shevchenko at linux.intel.com>
   Subject: [Enable Designware XGMAC VLAN Stripping Feature 0/2]
   
1/2:

   From: Boon at ecsmtp.png.intel.com, Khai at ecsmtp.png.intel.com, "Ng <boon.khai.ng"@intel.com
   To: Giuseppe Cavallaro <peppe.cavallaro at st.com>,
   	Alexandre Torgue <alexandre.torgue at foss.st.com>,
   	Jose Abreu <joabreu at synopsys.com>,
   	"David S . Miller" <davem at davemloft.net>,
   	Eric Dumazet <edumazet at google.com>,
   	Jakub Kicinski <kuba at kernel.org>, Paolo Abeni <pabeni at redhat.com>,
   	Maxime Coquelin <mcoquelin.stm32 at gmail.com>,
   	netdev at vger.kernel.org, linux-stm32 at st-md-mailman.stormreply.com,
   	linux-arm-kernel at lists.infradead.org,
   	linux-kernel at vger.kernel.org
   Cc: Boon Khai Ng <boon.khai.ng at intel.com>,
   	Shevchenko Andriy <andriy.shevchenko at intel.com>,
   	Mun Yew Tham <mun.yew.tham at intel.com>,
   	Leong Ching Swee <leong.ching.swee at intel.com>,
   	G Thomas Rohan <rohan.g.thomas at intel.com>,
   	Shevchenko Andriy <andriy.shevchenko at linux.intel.com>
   Subject: [Enable Designware XGMAC VLAN Stripping Feature 1/2] dt-bindings: net: snps,dwmac: Add description for rx-vlan-offload
   
2/2:

   From: Boon at ecsmtp.png.intel.com, Khai at ecsmtp.png.intel.com, "Ng <boon.khai.ng"@intel.com
   To: Giuseppe Cavallaro <peppe.cavallaro at st.com>,
   	Alexandre Torgue <alexandre.torgue at foss.st.com>,
   	Jose Abreu <joabreu at synopsys.com>,
   	"David S . Miller" <davem at davemloft.net>,
   	Eric Dumazet <edumazet at google.com>,
   	Jakub Kicinski <kuba at kernel.org>, Paolo Abeni <pabeni at redhat.com>,
   	Maxime Coquelin <mcoquelin.stm32 at gmail.com>,
   	netdev at vger.kernel.org, linux-stm32 at st-md-mailman.stormreply.com,
   	linux-arm-kernel at lists.infradead.org,
   	linux-kernel at vger.kernel.org
   Cc: Boon Khai Ng <boon.khai.ng at intel.com>,
   	Shevchenko Andriy <andriy.shevchenko at intel.com>,
   	Mun Yew Tham <mun.yew.tham at intel.com>,
   	Leong Ching Swee <leong.ching.swee at intel.com>,
   	G Thomas Rohan <rohan.g.thomas at intel.com>,
   	Shevchenko Andriy <andriy.shevchenko at linux.intel.com>
   Subject: [Enable Designware XGMAC VLAN Stripping Feature 2/2] net: stmmac: dwxgmac2: Add support for HW-accelerated VLAN Stripping
   
--------------------------------

vger has a limit on the number of recipients for a single email
so patch series that cc all possible recipients can be bounced
and not forwarded by vger.

So I think when submitting a patch series, it's necessary to send
just the cover letter to all mailing lists for all files/paths
modified by any file in the patch series and specific patches
are sent to maintainers, reviewers and the specific mailing lists
modified by the specific patch.

I use the scripts below to send patch series where a patch series
are the only files in individual directories.

(Well I used to use, I'm not actively reading or creating kernel patches right now)

$ cat ~/bin/to.sh
#!/bin/bash

opts="--nogit --nogit-fallback --norolestats --pattern-depth=1"

if [[ $(basename $1) =~ ^0000- ]] ; then
    ./scripts/get_maintainer.pl --nom $opts  $(dirname $1)/*
else
    maint=$(./scripts/get_maintainer.pl --nol $opts $1)
    if [ "$maint" == "" ] ; then
	echo "linux-kernel at vger.kernel.org"
    else
	echo "$maint"
    fi
fi


$ cat ~/bin/cc.sh
#!/bin/bash

opts="--nogit --nogit-fallback --norolestats"
maint_file=$(mktemp -t XXXXXXXX.cc)

if [[ $(basename $1) =~ ^0000- ]] ; then
    ./scripts/get_maintainer.pl $opts $(dirname $1)/* |  \
	~/bin/remove_undesirable_emails.sh > $maint_file
    count=$(wc -c $maint_file | cut -f1 -d" ")
    if [[ $count -lt 512 ]] ; then
	cat $maint_file
    else
	./scripts/get_maintainer.pl -nom -nor $opts $(dirname $1)/* | \
	    ~/bin/remove_undesirable_emails.sh
    fi
else
    ./scripts/get_maintainer.pl $opts $1 | \
	~/bin/remove_undesirable_emails.sh > $maint_file
    count=$(wc -l $maint_file | cut -f1 -d" ")
    if [[ $count -gt 0 ]] ; then
	cat $maint_file
    else
	./scripts/get_maintainer.pl --git --git-fallback --norolestats $1 | \
	    ~/bin/remove_undesirable_emails.sh
    fi
fi
rm -f $maint_file


$ cat ~/bin/remove_undesirable_emails.sh
grep -vPi "(?:\bIngo\s+Molnar\b)"

$

(nb: Ingo asked not to receive any emails from me)

And these scripts are used with git send-email with a .gitconfig block

[sendemail]
	chainreplyto = false
	thread = false
	suppresscc = self
	cccmd = ~/bin/cc.sh
	tocmd = ~/bin/to.sh

These scripts would have added 2 mailing lists to patch 0/n:

devicetree at vger.kernel.org (open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS)
linux-renesas-soc at vger.kernel.org (open list:ARM/RISC-V/RENESAS ARCHITECTURE)

and it would also have had a different recipient list for 1/2 as well

$ ./scripts/get_maintainer.pl -f Documentation/devicetree/bindings/net/snps,dwmac.yaml
"David S. Miller" <davem at davemloft.net> (maintainer:NETWORKING DRIVERS)
Eric Dumazet <edumazet at google.com> (maintainer:NETWORKING DRIVERS)
Jakub Kicinski <kuba at kernel.org> (maintainer:NETWORKING DRIVERS)
Paolo Abeni <pabeni at redhat.com> (maintainer:NETWORKING DRIVERS)
Rob Herring <robh+dt at kernel.org> (maintainer:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS)
Krzysztof Kozlowski <krzysztof.kozlowski+dt at linaro.org> (maintainer:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS)
Conor Dooley <conor+dt at kernel.org> (maintainer:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS)
Richard Cochran <richardcochran at gmail.com> (maintainer:PTP HARDWARE CLOCK SUPPORT)
Geert Uytterhoeven <geert+renesas at glider.be> (supporter:ARM/RISC-V/RENESAS ARCHITECTURE)
Magnus Damm <magnus.damm at gmail.com> (supporter:ARM/RISC-V/RENESAS ARCHITECTURE)
Alexandre Torgue <alexandre.torgue at foss.st.com> (in file)
Giuseppe Cavallaro <peppe.cavallaro at st.com> (in file)
Jose Abreu <joabreu at synopsys.com> (in file)
netdev at vger.kernel.org (open list:NETWORKING DRIVERS)
devicetree at vger.kernel.org (open list:OPEN FIRMWARE AND FLATTENED DEVICE TREE BINDINGS)
linux-kernel at vger.kernel.org (open list)
linux-renesas-soc at vger.kernel.org (open list:ARM/RISC-V/RENESAS ARCHITECTURE)