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

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

[Jakub Kicinski]

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>
---
v2:
 - s/Gobals/Globals/
 - breaking changes are -> compatibility breaking changes are
   I think it's plural but the omission of "compatibility" made it confusing
 - not changing the wording to "should never be used", I prefer existing
v1: https://lore.kernel.org/all/20231012154315.587383-1-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..0b3febd57ff5 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
 =============
 
+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 compatibility breaking changes
+are generally not allowed ``version`` is very rarely used.
+
 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

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

[Jiri Pirko]

Mon, Oct 16, 2023 at 11:45:40PM 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>
>---
>v2:
> - s/Gobals/Globals/
> - breaking changes are -> compatibility breaking changes are
>   I think it's plural but the omission of "compatibility" made it confusing
> - not changing the wording to "should never be used", I prefer existing
>v1: https://lore.kernel.org/all/20231012154315.587383-1-kuba@kernel.org/
>---
> .../userspace-api/netlink/genetlink-legacy.rst     | 14 ++++++++++++++
> Documentation/userspace-api/netlink/specs.rst      |  5 -----
> 2 files changed, 14 insertions(+), 5 deletions(-)

Reviewed-by: Jiri Pirko <jiri@nvidia.com>

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

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Mon, 16 Oct 2023 14:45:40 -0700 you 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>
> ---
> v2:
>  - s/Gobals/Globals/
>  - breaking changes are -> compatibility breaking changes are
>    I think it's plural but the omission of "compatibility" made it confusing
>  - not changing the wording to "should never be used", I prefer existing
> v1: https://lore.kernel.org/all/20231012154315.587383-1-kuba@kernel.org/
> 
> [...]

Here is the summary with links:
  - [net-next,v2] docs: netlink: clean up after deprecating version
    https://git.kernel.org/netdev/net-next/c/5294df643ba6

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html