netdev - Re: [PATCH net-next] docs: netlink: clean up after deprecating version

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]

Date: Thu, 12 Oct 2023 08:51:33 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Jakub Kicinski <kuba@...nel.org>, davem@...emloft.net
Cc: netdev@...r.kernel.org, edumazet@...gle.com, pabeni@...hat.com,
 jiri@...nulli.us, linux-doc@...r.kernel.org
Subject: Re: [PATCH net-next] docs: netlink: clean up after deprecating
 version

Hi,

On 10/12/23 08:43, Jakub Kicinski wrote:
> Jiri moved version to legacy specs in commit 0f07415ebb78 ("netlink:
> specs: don't allow version to be specified for genetlink").
> Update the documentation.
> 
> Signed-off-by: Jakub Kicinski <kuba@...nel.org>
> ---
>  .../userspace-api/netlink/genetlink-legacy.rst     | 14 ++++++++++++++
>  Documentation/userspace-api/netlink/specs.rst      |  5 -----
>  2 files changed, 14 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/userspace-api/netlink/genetlink-legacy.rst b/Documentation/userspace-api/netlink/genetlink-legacy.rst
> index 40b82ad5d54a..11710086aba0 100644
> --- a/Documentation/userspace-api/netlink/genetlink-legacy.rst
> +++ b/Documentation/userspace-api/netlink/genetlink-legacy.rst
> @@ -11,6 +11,20 @@ the ``genetlink-legacy`` protocol level.
>  Specification
>  =============
>  
> +Gobals

Globals
?

> +------
> +
> +Attributes listed directly at the root level of the spec file.
> +
> +version
> +~~~~~~~
> +
> +Generic Netlink family version, default is 1.
> +
> +``version`` has historically been used to introduce family changes
> +which may break backwards compatibility. Since breaking changes
> +are generally not allowed ``version`` is very rarely used.

I would s/are/is/. To me "breaking changes" is singular, not plural.

> +
>  Attribute type nests
>  --------------------
>  
> diff --git a/Documentation/userspace-api/netlink/specs.rst b/Documentation/userspace-api/netlink/specs.rst
> index cc4e2430997e..40dd7442d2c3 100644
> --- a/Documentation/userspace-api/netlink/specs.rst
> +++ b/Documentation/userspace-api/netlink/specs.rst
> @@ -86,11 +86,6 @@ name
>  Name of the family. Name identifies the family in a unique way, since
>  the Family IDs are allocated dynamically.
>  
> -version
> -~~~~~~~
> -
> -Generic Netlink family version, default is 1.
> -
>  protocol
>  ~~~~~~~~
>  

-- 
~Randy