docs: netlink: clean up after deprecating version
authorJakub Kicinski <kuba@kernel.org>
Mon, 16 Oct 2023 21:45:40 +0000 (14:45 -0700)
committerJakub Kicinski <kuba@kernel.org>
Wed, 18 Oct 2023 00:59:51 +0000 (17:59 -0700)
Jiri moved version to legacy specs in commit 0f07415ebb78 ("netlink:
specs: don't allow version to be specified for genetlink").
Update the documentation.

Reviewed-by: Jiri Pirko <jiri@nvidia.com>
Link: https://lore.kernel.org/r/20231016214540.1822392-1-kuba@kernel.org
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Documentation/userspace-api/netlink/genetlink-legacy.rst
Documentation/userspace-api/netlink/specs.rst

index 40b82ad5d54a5a545d54078c89f4e8bc61a65d1d..0b3febd57ff5235890064d13273291f761a0de12 100644 (file)
@@ -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
 --------------------
 
index cc4e2430997ef8c461c434b3564c7768b5cb6dba..40dd7442d2c3c21077f281f1dc88c12263a92b83 100644 (file)
@@ -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
 ~~~~~~~~