[PATCH net 03/10] netlink: specs: ethtool: replace underscores with dashes in names

[PATCH net 03/10] netlink: specs: ethtool: replace underscores with dashes in names

[Jakub Kicinski]

We're trying to add a strict regexp for the name format in the spec.
Underscores will not be allowed, dashes should be used instead.
This makes no difference to C (codegen replaces special chars in names)
but gives more uniform naming in Python.

Fixes: 13e59344fb9d ("net: ethtool: add support for symmetric-xor RSS hash")
Fixes: 46fb3ba95b93 ("ethtool: Add an interface for flashing transceiver modules' firmware")
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
---
CC: andrew@lunn.ch
CC: donald.hunter@gmail.com
CC: shuah@kernel.org
CC: kory.maincent@bootlin.com
CC: sdf@fomichev.me
CC: gal@nvidia.com
CC: noren@nvidia.com
CC: ahmed.zaki@intel.com
CC: wojciech.drewek@intel.com
CC: petrm@nvidia.com
CC: danieller@nvidia.com
CC: linux-kselftest@vger.kernel.org
---
 Documentation/netlink/specs/ethtool.yaml                 | 6 +++---
 tools/testing/selftests/drivers/net/hw/rss_input_xfrm.py | 2 +-
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/netlink/specs/ethtool.yaml b/Documentation/netlink/specs/ethtool.yaml
index 72a076b0e1b5..348c6ad548f5 100644
--- a/Documentation/netlink/specs/ethtool.yaml
+++ b/Documentation/netlink/specs/ethtool.yaml
@@ -48,7 +48,7 @@ c-version-name: ethtool-genl-version
         name: started
         doc: The firmware flashing process has started.
       -
-        name: in_progress
+        name: in-progress
         doc: The firmware flashing process is in progress.
       -
         name: completed
@@ -1422,7 +1422,7 @@ c-version-name: ethtool-genl-version
         name: hkey
         type: binary
       -
-        name: input_xfrm
+        name: input-xfrm
         type: u32
       -
         name: start-context
@@ -2238,7 +2238,7 @@ c-version-name: ethtool-genl-version
             - hfunc
             - indir
             - hkey
-            - input_xfrm
+            - input-xfrm
       dump:
         request:
           attributes:
diff --git a/tools/testing/selftests/drivers/net/hw/rss_input_xfrm.py b/tools/testing/selftests/drivers/net/hw/rss_input_xfrm.py
index f439c434ba36..648ff50bc1c3 100755
--- a/tools/testing/selftests/drivers/net/hw/rss_input_xfrm.py
+++ b/tools/testing/selftests/drivers/net/hw/rss_input_xfrm.py
@@ -38,7 +38,7 @@ from lib.py import rand_port
         raise KsftSkipEx("socket.SO_INCOMING_CPU was added in Python 3.11")
 
     input_xfrm = cfg.ethnl.rss_get(
-        {'header': {'dev-name': cfg.ifname}}).get('input_xfrm')
+        {'header': {'dev-name': cfg.ifname}}).get('input-xfrm')
 
     # Check for symmetric xor/or-xor
     if not input_xfrm or (input_xfrm != 1 and input_xfrm != 2):
-- 
2.49.0

Re: [PATCH net 03/10] netlink: specs: ethtool: replace underscores with dashes in names

[Kory Maincent]

Le Tue, 24 Jun 2025 14:09:55 -0700,
Jakub Kicinski <kuba@kernel.org> a écrit :

> We're trying to add a strict regexp for the name format in the spec.
> Underscores will not be allowed, dashes should be used instead.
> This makes no difference to C (codegen replaces special chars in names)
> but gives more uniform naming in Python.
 
Reviewed-by: Kory Maincent <kory.maincent@bootlin.com>

Thank you!

> Fixes: 13e59344fb9d ("net: ethtool: add support for symmetric-xor RSS hash")
> Fixes: 46fb3ba95b93 ("ethtool: Add an interface for flashing transceiver
> modules' firmware") 

Why do you use fixes tag? You are not fixing something broken but standardizing
the python naming.

Regards,
-- 
Köry Maincent, Bootlin
Embedded Linux and kernel engineering
https://bootlin.com

Re: [PATCH net 03/10] netlink: specs: ethtool: replace underscores with dashes in names

[Jakub Kicinski]

On Wed, 25 Jun 2025 01:07:15 +0200 Kory Maincent wrote:
> > Fixes: 13e59344fb9d ("net: ethtool: add support for symmetric-xor RSS hash")
> > Fixes: 46fb3ba95b93 ("ethtool: Add an interface for flashing transceiver
> > modules' firmware")   
> 
> Why do you use fixes tag? You are not fixing something broken but standardizing
> the python naming.

To direct them within stable releases. I think it's worth pushing
this change into 6.12 LTS in case someone packages YNL out of there.
One could argue this is a breaking change for Python users.

Re: [PATCH net 03/10] netlink: specs: ethtool: replace underscores with dashes in names

[Donald Hunter]

Jakub Kicinski <kuba@kernel.org> writes:

> We're trying to add a strict regexp for the name format in the spec.
> Underscores will not be allowed, dashes should be used instead.
> This makes no difference to C (codegen replaces special chars in names)
> but gives more uniform naming in Python.
>
> Fixes: 13e59344fb9d ("net: ethtool: add support for symmetric-xor RSS hash")
> Fixes: 46fb3ba95b93 ("ethtool: Add an interface for flashing transceiver modules' firmware")
> Signed-off-by: Jakub Kicinski <kuba@kernel.org>

Reviewed-by: Donald Hunter <donald.hunter@gmail.com>