netdev - Re: [PATCH net-next v2 01/13] netlink: specs: rename rtnetlink specs in accordance with family name

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: <495e43ef-ae20-4dda-97c0-cb8ebe97394b@redhat.com>
Date: Thu, 10 Apr 2025 10:52:22 +0200
From: Paolo Abeni <pabeni@...hat.com>
To: Jakub Kicinski <kuba@...nel.org>
Cc: netdev@...r.kernel.org, edumazet@...gle.com, andrew+netdev@...n.ch,
 horms@...nel.org, donald.hunter@...il.com, jacob.e.keller@...el.com,
 yuyanghuang@...gle.com, sdf@...ichev.me, gnault@...hat.com,
 nicolas.dichtel@...nd.com, petrm@...dia.com,
 "David S. Miller" <davem@...emloft.net>
Subject: Re: [PATCH net-next v2 01/13] netlink: specs: rename rtnetlink specs
 in accordance with family name

On 4/10/25 3:46 AM, Jakub Kicinski wrote:
> The rtnetlink family names are set to rt-$name within the YAML
> but the files are called rt_$name. C codegen assumes that the
> generated file name will match the family. The use of dashes
> is in line with our general expectation that name properties
> in the spec use dashes not underscores (even tho, as Donald
> points out most genl families use underscores in the name).
> 
> We have 3 un-ideal options to choose from:
> 
>  - accept the slight inconsistency with old families using _, or
>  - accept the slight annoyance with all languages having to do s/-/_/
>    when looking up family ID, or
>  - accept the inconsistency with all name properties in new YAML spec
>    being separated with - and just the family name always using _.
> 
> Pick option 1 and rename the rtnl spec files.
> 
> Reviewed-by: Jacob Keller <jacob.e.keller@...el.com>
> Reviewed-by: Donald Hunter <donald.hunter@...il.com>
> Signed-off-by: Jakub Kicinski <kuba@...nel.org>
> ---
> v2: extend commit msg
> ---
>  Documentation/netlink/specs/{rt_addr.yaml => rt-addr.yaml}   | 0
>  Documentation/netlink/specs/{rt_link.yaml => rt-link.yaml}   | 0
>  Documentation/netlink/specs/{rt_neigh.yaml => rt-neigh.yaml} | 0
>  Documentation/netlink/specs/{rt_route.yaml => rt-route.yaml} | 0
>  Documentation/netlink/specs/{rt_rule.yaml => rt-rule.yaml}   | 0
>  Documentation/userspace-api/netlink/netlink-raw.rst          | 2 +-
>  tools/testing/selftests/net/lib/py/ynl.py                    | 4 ++--
>  7 files changed, 3 insertions(+), 3 deletions(-)
>  rename Documentation/netlink/specs/{rt_addr.yaml => rt-addr.yaml} (100%)
>  rename Documentation/netlink/specs/{rt_link.yaml => rt-link.yaml} (100%)

My understanding is that this rename triggers rebuild of the related
doc, which in turns leads to quite a large number of htmldoc warning,
but it's really unharmful/pre-existing issue.

/P