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

[Jiri Pirko <jiri@resnulli.us>]

Thu, Oct 12, 2023 at 05:43:15PM CEST, kuba@kernel.org 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@kernel.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
>+------
>+
>+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.

"should never be used" perhaps?


>+
> 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
> ~~~~~~~~
> 
>-- 
>2.41.0
>